GraphQL API Reference
Welcome to the technical specification for the GraphQL API.
You will find here all available endpoints (queries and mutations) which can be used.
For all endpoints you will find an explanation about the purpose, types, and how they should be used.
Some of the endpoints are marked as deprecated. Please don't use them any more for new developments, because soon enough they will be removed. We will inform you about that beforehand.
If you face any problems, please do not hesitate to contact us via support-beenergised@chargepoint.com.
API Endpoints
https://<your-subdomain>.v2.api.htb.services/graphql/
Queries
accountDocument
Description
Get a document by it's ID.
Response
Returns an AccountDocument
Arguments
Name | Description |
---|---|
id - String
|
Example
Query
query accountDocument($id: String) {
accountDocument(id: $id) {
documentDate
downloadLink
id
title
type
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"accountDocument": {
"documentDate": "2007-12-03T10:15:30Z",
"downloadLink": "xyz789",
"id": "abc123",
"title": "xyz789",
"type": "creditnote"
}
}
}
accountDocumentsPaged
Description
Get the list of all documents of the authenticated user.
Response
Returns an AccountDocumentsPaged
Arguments
Name | Description |
---|---|
pagination - PaginationFilter
|
Example
Query
query accountDocumentsPaged($pagination: PaginationFilter) {
accountDocumentsPaged(pagination: $pagination) {
data {
...AccountDocumentFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{"pagination": PaginationFilter}
Response
{
"data": {
"accountDocumentsPaged": {
"data": [AccountDocument],
"pagination": Pagination
}
}
}
additionalRegistrationFields
Response
Returns [AdditionalRegistrationField]
Example
Query
query additionalRegistrationFields {
additionalRegistrationFields {
description
name
required
type
value
}
}
Response
{
"data": {
"additionalRegistrationFields": [
{
"description": "xyz789",
"name": "abc123",
"required": "abc123",
"type": "abc123",
"value": "xyz789"
}
]
}
}
availableCardsForChargingProcess
Description
Get a list of authentication media (cards) of the authorized user which can be used to start a charging process on a specific connector.
Response
Returns [CardForChargingProcess]
Arguments
Name | Description |
---|---|
connectorId - String!
|
Example
Query
query availableCardsForChargingProcess($connectorId: String!) {
availableCardsForChargingProcess(connectorId: $connectorId) {
expiryDate
id
label
number
preauthRequired
rate {
...RateDescriptionForChargingProcessFragment
}
tagId
type
}
}
Variables
{"connectorId": "xyz789"}
Response
{
"data": {
"availableCardsForChargingProcess": [
{
"expiryDate": "2007-12-03T10:15:30Z",
"id": "xyz789",
"label": "abc123",
"number": "xyz789",
"preauthRequired": false,
"rate": RateDescriptionForChargingProcess,
"tagId": "xyz789",
"type": "default"
}
]
}
}
availableCurrencies
Description
Get a list of available currencies of the authorized user.
Response
Returns an AvailableCurrencies
Arguments
Name | Description |
---|---|
pagination - PaginationFilter
|
Example
Query
query availableCurrencies($pagination: PaginationFilter) {
availableCurrencies(pagination: $pagination) {
data {
...AvailableCurrencyFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{"pagination": PaginationFilter}
Response
{
"data": {
"availableCurrencies": {
"data": [AvailableCurrency],
"pagination": Pagination
}
}
}
bankAccount
Response
Returns a BankAccountResponse
Example
Query
query bankAccount {
bankAccount {
accountHolder
bank
bic
iban
}
}
Response
{
"data": {
"bankAccount": {
"accountHolder": "abc123",
"bank": "abc123",
"bic": "xyz789",
"iban": "abc123"
}
}
}
card
Description
Get a card by tag id or uuid.
Example
Query
query card($id: String!) {
card(id: $id) {
deactivationReason
expiryDate
id
label
number
preauthRequired
rate {
...RateOptionFragment
}
status
tagId
type
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"card": {
"deactivationReason": "abc123",
"expiryDate": "2007-12-03T10:15:30Z",
"id": "abc123",
"label": "abc123",
"number": "abc123",
"preauthRequired": false,
"rate": RateOption,
"status": "active",
"tagId": "abc123",
"type": "default"
}
}
}
cardsPaged
Description
Get a list of authentication media (cards) of the authorized user.
Response
Returns a CardsPaged
Arguments
Name | Description |
---|---|
pagination - PaginationFilter
|
Example
Query
query cardsPaged($pagination: PaginationFilter) {
cardsPaged(pagination: $pagination) {
data {
...CardFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{"pagination": PaginationFilter}
Response
{
"data": {
"cardsPaged": {
"data": [Card],
"pagination": Pagination
}
}
}
chargelog
Description
Get a chargelog by id.
Example
Query
query chargelog($id: ID!) {
chargelog(id: $id) {
authId
authType
calibrationDetails
co2Saving
connector {
...ConnectorFragment
}
cost {
...CostFragment
}
dateEnd
dateStart
energyConsumption
id
meterEnd
meterStart
rateName
sessionId
status
}
}
Variables
{"id": "4"}
Response
{
"data": {
"chargelog": {
"authId": "abc123",
"authType": "xyz789",
"calibrationDetails": "abc123",
"co2Saving": 123.45,
"connector": Connector,
"cost": Cost,
"dateEnd": "2007-12-03T10:15:30Z",
"dateStart": "2007-12-03T10:15:30Z",
"energyConsumption": 987.65,
"id": "4",
"meterEnd": 987,
"meterStart": 987,
"rateName": "xyz789",
"sessionId": "xyz789",
"status": "abc123"
}
}
}
chargelogMeterValuesSummary
Description
Returns detailed information about the meter values of a charging session.
In some cases, we do not receive meter values during the charging session. In this case, only null values will be returned.
As parameter you will need the uuid of the charging station. This can be obtained by chargelogsPaged, among others.
Response
Returns a chargelogMeterValuesSummary
Arguments
Name | Description |
---|---|
uuid - String!
|
The uuid of the charging session |
Example
Query
query chargelogMeterValuesSummary($uuid: String!) {
chargelogMeterValuesSummary(uuid: $uuid) {
currentPower
currentPowerLastChanged
currentStateOfCharge
energyFirstValue
energyFirstValueTime
energyLastValue
energyLastValueTime
energyUpdatedAt
initialStateOfCharge
stateOfChargeLastChanged
sumEnergy
updatedAt
}
}
Variables
{"uuid": "xyz789"}
Response
{
"data": {
"chargelogMeterValuesSummary": {
"currentPower": 123,
"currentPowerLastChanged": "abc123",
"currentStateOfCharge": 987,
"energyFirstValue": 123.45,
"energyFirstValueTime": "xyz789",
"energyLastValue": 123.45,
"energyLastValueTime": "xyz789",
"energyUpdatedAt": "abc123",
"initialStateOfCharge": 123,
"stateOfChargeLastChanged": "xyz789",
"sumEnergy": 123.45,
"updatedAt": "xyz789"
}
}
}
chargelogsPaged
Description
Get a list of chargelogs of the authorized user, filterable with a ChargelogFilter object.
Response
Returns a ChargelogsPaged
Arguments
Name | Description |
---|---|
filters - ChargelogFilter
|
|
pagination - PaginationFilter
|
|
timeframe - TimeFrameFilter
|
|
type - ChargeLogType
|
Example
Query
query chargelogsPaged(
$filters: ChargelogFilter,
$pagination: PaginationFilter,
$timeframe: TimeFrameFilter,
$type: ChargeLogType
) {
chargelogsPaged(
filters: $filters,
pagination: $pagination,
timeframe: $timeframe,
type: $type
) {
data {
...ChargelogFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"filters": ChargelogFilter,
"pagination": PaginationFilter,
"timeframe": TimeFrameFilter,
"type": "contact"
}
Response
{
"data": {
"chargelogsPaged": {
"data": [Chargelog],
"pagination": Pagination
}
}
}
chargingStatistics
Description
Get statistics for chargelogs (optionally within a specific timerange)
Response
Returns a ChargingStatistics
Arguments
Name | Description |
---|---|
timeframe - TimeFrameFilter
|
Example
Query
query chargingStatistics($timeframe: TimeFrameFilter) {
chargingStatistics(timeframe: $timeframe) {
co2Saving
energyConsumption
number
}
}
Variables
{"timeframe": TimeFrameFilter}
Response
{
"data": {
"chargingStatistics": {
"co2Saving": 123.45,
"energyConsumption": 123.45,
"number": 987
}
}
}
connector
Description
Load a single connector
Response
Returns a Connector
Example
Query
query connector(
$id: ID!,
$ignoreMarketingConfiguration: Boolean
) {
connector(
id: $id,
ignoreMarketingConfiguration: $ignoreMarketingConfiguration
) {
connectorType {
...ConnectorTypeFragment
}
cp {
...CpFragment
}
evseId
freeOfCharge
id
label
maintenanceWindows {
...ConnectorMaintenanceWindowFragment
}
sortOrder
status {
...ConnectorStatusFragment
}
}
}
Variables
{
"id": "4",
"ignoreMarketingConfiguration": false
}
Response
{
"data": {
"connector": {
"connectorType": ConnectorType,
"cp": Cp,
"evseId": "xyz789",
"freeOfCharge": false,
"id": 4,
"label": "xyz789",
"maintenanceWindows": [ConnectorMaintenanceWindow],
"sortOrder": "xyz789",
"status": ConnectorStatus
}
}
}
connectorByEvseId
Description
Load a single connector by its EVSEID.
Response
Returns a Connector
Example
Query
query connectorByEvseId(
$evseId: String!,
$ignoreMarketingConfiguration: Boolean
) {
connectorByEvseId(
evseId: $evseId,
ignoreMarketingConfiguration: $ignoreMarketingConfiguration
) {
connectorType {
...ConnectorTypeFragment
}
cp {
...CpFragment
}
evseId
freeOfCharge
id
label
maintenanceWindows {
...ConnectorMaintenanceWindowFragment
}
sortOrder
status {
...ConnectorStatusFragment
}
}
}
Variables
{
"evseId": "abc123",
"ignoreMarketingConfiguration": false
}
Response
{
"data": {
"connectorByEvseId": {
"connectorType": ConnectorType,
"cp": Cp,
"evseId": "abc123",
"freeOfCharge": true,
"id": 4,
"label": "abc123",
"maintenanceWindows": [ConnectorMaintenanceWindow],
"sortOrder": "abc123",
"status": ConnectorStatus
}
}
}
contact
Response
Returns a Contact
Example
Query
query contact {
contact {
address {
...AddressFragment
}
birthday
companyId
createdAt
currency {
...CurrencyFragment
}
displayName
email
firstName
gender
id
isCompany
isDeactivated
language
mobile
name
phone
termsAndConditionsAccepted
updatedAt
vat
}
}
Response
{
"data": {
"contact": {
"address": Address,
"birthday": "2007-12-03T10:15:30Z",
"companyId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"currency": Currency,
"displayName": "xyz789",
"email": "xyz789",
"firstName": "xyz789",
"gender": "company",
"id": "xyz789",
"isCompany": true,
"isDeactivated": true,
"language": "cs_CZ",
"mobile": "abc123",
"name": "xyz789",
"phone": "abc123",
"termsAndConditionsAccepted": false,
"updatedAt": "2007-12-03T10:15:30Z",
"vat": "xyz789"
}
}
}
contractPaymentMethods
Response
Returns [ContractPaymentMethod]
Example
Query
query contractPaymentMethods {
contractPaymentMethods {
applicationId
cardCreateMode
createdAt
directPaymentMethod
emp
paymentName
paymentType
termsOfServiceUrl
termsOfUseUrl
updatedAt
uuid
}
}
Response
{
"data": {
"contractPaymentMethods": [
{
"applicationId": "xyz789",
"cardCreateMode": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"directPaymentMethod": "abc123",
"emp": "xyz789",
"paymentName": "xyz789",
"paymentType": "abc123",
"termsOfServiceUrl": "abc123",
"termsOfUseUrl": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "abc123"
}
]
}
}
contractRateOptions
Description
Get rate options applicable to contracts and available to clients.
Response
Returns [RateOption]
Example
Query
query contractRateOptions {
contractRateOptions {
description
id
name
preauthAmount
preauthCurrencyAmount {
...CurrencyAmountFragment
}
shortDescription
uuid
}
}
Response
{
"data": {
"contractRateOptions": [
{
"description": "abc123",
"id": "xyz789",
"name": "abc123",
"preauthAmount": 987.65,
"preauthCurrencyAmount": CurrencyAmount,
"shortDescription": "abc123",
"uuid": "abc123"
}
]
}
}
cp
Description
Load a single cp
Example
Query
query cp(
$id: ID!,
$ignoreMarketingConfiguration: Boolean
) {
cp(
id: $id,
ignoreMarketingConfiguration: $ignoreMarketingConfiguration
) {
accessType
additionalFields {
...AdditionalCpFieldFragment
}
address
capabilities {
...CpCapabilitiesFragment
}
city
connectors {
...ConnectorFragment
}
contact {
...ContactInformationFragment
}
country
directions
displayAttributes {
...DisplayAttributesFragment
}
id
images {
...CpImageFragment
}
information {
...CpInfoFragment
}
isFavoured
label
latitude
longitude
operator {
...CpOperatorFragment
}
publicName
site {
...SiteFragment
}
siteId
status {
...CpStatusFragment
}
zip
}
}
Variables
{
"id": "4",
"ignoreMarketingConfiguration": true
}
Response
{
"data": {
"cp": {
"accessType": "INTERNAL",
"additionalFields": [AdditionalCpField],
"address": "abc123",
"capabilities": CpCapabilities,
"city": "xyz789",
"connectors": [Connector],
"contact": ContactInformation,
"country": "xyz789",
"directions": "xyz789",
"displayAttributes": DisplayAttributes,
"id": 4,
"images": [CpImage],
"information": CpInfo,
"isFavoured": true,
"label": "xyz789",
"latitude": 987.65,
"longitude": 123.45,
"operator": CpOperator,
"publicName": "xyz789",
"site": Site,
"siteId": "abc123",
"status": CpStatus,
"zip": "xyz789"
}
}
}
cpCapabilities
Description
Get the capabilities of an given charging station.
Response
Returns a CpCapabilities!
Arguments
Name | Description |
---|---|
id - String!
|
Example
Query
query cpCapabilities($id: String!) {
cpCapabilities(id: $id) {
hasRemoteCommands
}
}
Variables
{"id": "xyz789"}
Response
{"data": {"cpCapabilities": {"hasRemoteCommands": true}}}
cpOccupancyRate
Response
Returns [OccupancyRate]
Arguments
Name | Description |
---|---|
cpId - String!
|
|
day - OccupancyDays!
|
Example
Query
query cpOccupancyRate(
$cpId: String!,
$day: OccupancyDays!
) {
cpOccupancyRate(
cpId: $cpId,
day: $day
) {
day
hour
occupancyRate
}
}
Variables
{"cpId": "abc123", "day": "ALL"}
Response
{
"data": {
"cpOccupancyRate": [
{
"day": "abc123",
"hour": 123,
"occupancyRate": 987.65
}
]
}
}
cpsPaged
Description
Load a list of stations with pagination based on filters (optional)
Response
Returns a CpsPaged
Arguments
Name | Description |
---|---|
cursorPagination - CursorFilter
|
Pagination by cursor. Only one pagination can be selected! |
filter - [ConnectorFilter]
|
Stations can be filtered on different properties of the Connector. Check out the type definition for more details. |
freeOfCharge - Boolean
|
|
ignoreMarketingConfiguration - Boolean
|
|
pagination - PaginationFilter
|
Pagination by limit and offset. Only one pagination can be selected! |
Example
Query
query cpsPaged(
$cursorPagination: CursorFilter,
$filter: [ConnectorFilter],
$freeOfCharge: Boolean,
$ignoreMarketingConfiguration: Boolean,
$pagination: PaginationFilter
) {
cpsPaged(
cursorPagination: $cursorPagination,
filter: $filter,
freeOfCharge: $freeOfCharge,
ignoreMarketingConfiguration: $ignoreMarketingConfiguration,
pagination: $pagination
) {
data {
...CpFragment
}
pagination {
...PaginationInterfaceFragment
}
}
}
Variables
{
"cursorPagination": CursorFilter,
"filter": [ConnectorFilter],
"freeOfCharge": false,
"ignoreMarketingConfiguration": true,
"pagination": PaginationFilter
}
Response
{
"data": {
"cpsPaged": {
"data": [Cp],
"pagination": PaginationInterface
}
}
}
cpsPagedLocationBased
Description
Load a list of stations with pagination based on location
Response
Returns a CpsPaged
Arguments
Name | Description |
---|---|
filter - [ConnectorFilter]
|
Stations can be filtered on different properties of the Connector. Check out the type definition for more details. |
freeOfCharge - Boolean
|
|
ignoreMarketingConfiguration - Boolean
|
|
location - LocationFilter
|
|
orderedByDistance - String
|
If the Cps should be returned ordered by the distance or not. The backend will order by distance when:
|
pagination - PaginationFilter
|
Example
Query
query cpsPagedLocationBased(
$filter: [ConnectorFilter],
$freeOfCharge: Boolean,
$ignoreMarketingConfiguration: Boolean,
$location: LocationFilter,
$orderedByDistance: String,
$pagination: PaginationFilter
) {
cpsPagedLocationBased(
filter: $filter,
freeOfCharge: $freeOfCharge,
ignoreMarketingConfiguration: $ignoreMarketingConfiguration,
location: $location,
orderedByDistance: $orderedByDistance,
pagination: $pagination
) {
data {
...CpFragment
}
pagination {
...PaginationInterfaceFragment
}
}
}
Variables
{
"filter": [ConnectorFilter],
"freeOfCharge": true,
"ignoreMarketingConfiguration": true,
"location": LocationFilter,
"orderedByDistance": "xyz789",
"pagination": PaginationFilter
}
Response
{
"data": {
"cpsPagedLocationBased": {
"data": [Cp],
"pagination": PaginationInterface
}
}
}
directPaymentChargingStatus
Response
Returns a DirectPaymentChargingStatus
Example
Query
query directPaymentChargingStatus(
$evseId: String!,
$transactionId: String!
) {
directPaymentChargingStatus(
evseId: $evseId,
transactionId: $transactionId
) {
chargeLogId
message
status
}
}
Variables
{
"evseId": "xyz789",
"transactionId": "abc123"
}
Response
{
"data": {
"directPaymentChargingStatus": {
"chargeLogId": "xyz789",
"message": "xyz789",
"status": "abc123"
}
}
}
filters
Description
Load a list of filters for the connector.
As the filter options can change over time, depending on the stations available in our system, the different options are not hardcoded.
Response
Returns [Filter]
Example
Query
query filters {
filters {
label
options {
...FilterOptionFragment
}
slug
type
}
}
Response
{
"data": {
"filters": [
{
"label": "Power Class",
"options": [FilterOption],
"slug": "POWER_CLASS",
"type": "multiselect"
}
]
}
}
getFavouriteCps
Response
Returns [Cp]
Example
Query
query getFavouriteCps {
getFavouriteCps {
accessType
additionalFields {
...AdditionalCpFieldFragment
}
address
capabilities {
...CpCapabilitiesFragment
}
city
connectors {
...ConnectorFragment
}
contact {
...ContactInformationFragment
}
country
directions
displayAttributes {
...DisplayAttributesFragment
}
id
images {
...CpImageFragment
}
information {
...CpInfoFragment
}
isFavoured
label
latitude
longitude
operator {
...CpOperatorFragment
}
publicName
site {
...SiteFragment
}
siteId
status {
...CpStatusFragment
}
zip
}
}
Response
{
"data": {
"getFavouriteCps": [
{
"accessType": "INTERNAL",
"additionalFields": [AdditionalCpField],
"address": "xyz789",
"capabilities": CpCapabilities,
"city": "abc123",
"connectors": [Connector],
"contact": ContactInformation,
"country": "abc123",
"directions": "abc123",
"displayAttributes": DisplayAttributes,
"id": "4",
"images": [CpImage],
"information": CpInfo,
"isFavoured": true,
"label": "abc123",
"latitude": 987.65,
"longitude": 123.45,
"operator": CpOperator,
"publicName": "xyz789",
"site": Site,
"siteId": "abc123",
"status": CpStatus,
"zip": "xyz789"
}
]
}
}
hasPaymentMedium
Description
Returns true if current user already has an active payment medium and false if not.
Response
Returns a Boolean
Example
Query
query hasPaymentMedium {
hasPaymentMedium
}
Response
{"data": {"hasPaymentMedium": false}}
occupancyRate
Description
A query to get all occupancy of a connector
Response
Returns [OccupancyRate]
Arguments
Name | Description |
---|---|
connectors - [String]!
|
|
day - OccupancyDays!
|
Example
Query
query occupancyRate(
$connectors: [String]!,
$day: OccupancyDays!
) {
occupancyRate(
connectors: $connectors,
day: $day
) {
day
hour
occupancyRate
}
}
Variables
{"connectors": ["abc123"], "day": "ALL"}
Response
{
"data": {
"occupancyRate": [
{
"day": "xyz789",
"hour": 123,
"occupancyRate": 987.65
}
]
}
}
paymentMethods
Description
Get all payment cards registered in PSPs for the session user.
Response
Returns a PaymentMethods
Example
Query
query paymentMethods {
paymentMethods {
hostedSession {
...HostedPaymentMethodGetSessionFragment
}
nativeSession {
...NativePaymentMethodGetSessionFragment
}
}
}
Response
{
"data": {
"paymentMethods": {
"hostedSession": HostedPaymentMethodGetSession,
"nativeSession": NativePaymentMethodGetSession
}
}
}
ratePackageByConnectorId
Description
Get all rate packages by a specific connector uuid.
Response
Returns [RatePackage]
Arguments
Name | Description |
---|---|
id - String
|
Example
Query
query ratePackageByConnectorId($id: String) {
ratePackageByConnectorId(id: $id) {
amount
automaticStop
id
rate {
...RateOptionFragment
}
visibleRuntime
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"ratePackageByConnectorId": [
{
"amount": 123.45,
"automaticStop": 123,
"id": "abc123",
"rate": RateOption,
"visibleRuntime": 987
}
]
}
}
remoteStartAttemptStatus
Description
Get the current status of the
[remoteStartAttempt](#mutation-attemptRemoteStart)
Response
Returns an AttemptRemoteStartResponse!
Arguments
Name | Description |
---|---|
id - String!
|
|
Example
Query
query remoteStartAttemptStatus($id: String!) {
remoteStartAttemptStatus(id: $id) {
chargeLogId
connectorId
failureReason
id
isFailure
lastSentAt
status
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"remoteStartAttemptStatus": {
"chargeLogId": "abc123",
"connectorId": "abc123",
"failureReason": "abc123",
"id": 4,
"isFailure": false,
"lastSentAt": "xyz789",
"status": "xyz789"
}
}
}
remoteStartWithPreauthStatus
Description
Get the current status of the remote start with preauth
Response
Returns a RemoteStartResponse
Arguments
Name | Description |
---|---|
remoteStartPreauthId - String!
|
Example
Query
query remoteStartWithPreauthStatus($remoteStartPreauthId: String!) {
remoteStartWithPreauthStatus(remoteStartPreauthId: $remoteStartPreauthId) {
code
id
message
session
status
transaction
}
}
Variables
{"remoteStartPreauthId": "abc123"}
Response
{
"data": {
"remoteStartWithPreauthStatus": {
"code": 987,
"id": "abc123",
"message": "xyz789",
"session": "abc123",
"status": "abc123",
"transaction": "xyz789"
}
}
}
settings
Response
Returns [Setting!]!
Arguments
Name | Description |
---|---|
key - String
|
Example
Query
query settings($key: String) {
settings(key: $key) {
key
value
}
}
Variables
{"key": "abc123"}
Response
{
"data": {
"settings": [
{
"key": "xyz789",
"value": "xyz789"
}
]
}
}
site
Description
Load a site by id
Response
Returns a Site
Example
Query
query site(
$id: String,
$ignoreMarketingConfiguration: Boolean
) {
site(
id: $id,
ignoreMarketingConfiguration: $ignoreMarketingConfiguration
) {
company
cps {
...CpFragment
}
id
label
latitude
longitude
scope
}
}
Variables
{
"id": "abc123",
"ignoreMarketingConfiguration": false
}
Response
{
"data": {
"site": {
"company": "xyz789",
"cps": [Cp],
"id": "xyz789",
"label": "xyz789",
"latitude": 987.65,
"longitude": 123.45,
"scope": "xyz789"
}
}
}
sitesPaged
Description
Load a list of sites
Response
Returns a SitesPaged
Arguments
Name | Description |
---|---|
filter - [ConnectorFilter]
|
|
ignoreMarketingConfiguration - Boolean
|
|
pagination - PaginationFilter
|
Example
Query
query sitesPaged(
$filter: [ConnectorFilter],
$ignoreMarketingConfiguration: Boolean,
$pagination: PaginationFilter
) {
sitesPaged(
filter: $filter,
ignoreMarketingConfiguration: $ignoreMarketingConfiguration,
pagination: $pagination
) {
data {
...SiteFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"filter": [ConnectorFilter],
"ignoreMarketingConfiguration": true,
"pagination": PaginationFilter
}
Response
{
"data": {
"sitesPaged": {
"data": [Site],
"pagination": Pagination
}
}
}
sitesPagedLocationBased
Description
Load a list of sites with pagination based on location
Response
Returns a SitesPaged
Arguments
Name | Description |
---|---|
filter - [ConnectorFilter]
|
|
ignoreMarketingConfiguration - Boolean
|
|
location - LocationFilter
|
|
pagination - PaginationFilter
|
Example
Query
query sitesPagedLocationBased(
$filter: [ConnectorFilter],
$ignoreMarketingConfiguration: Boolean,
$location: LocationFilter,
$pagination: PaginationFilter
) {
sitesPagedLocationBased(
filter: $filter,
ignoreMarketingConfiguration: $ignoreMarketingConfiguration,
location: $location,
pagination: $pagination
) {
data {
...SiteFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"filter": [ConnectorFilter],
"ignoreMarketingConfiguration": false,
"location": LocationFilter,
"pagination": PaginationFilter
}
Response
{
"data": {
"sitesPagedLocationBased": {
"data": [Site],
"pagination": Pagination
}
}
}
termsAndConditions
Description
The most recent terms and conditions in device language.
Response
Returns a LegalDocument
Example
Query
query termsAndConditions {
termsAndConditions {
id
url
version
}
}
Response
{
"data": {
"termsAndConditions": {
"id": "xyz789",
"url": "xyz789",
"version": "xyz789"
}
}
}
Mutations
acceptTermsAndConditions
Description
Accept the terms and conditions by uuid.
Response
Returns a TermsAndConditionsStatus!
Arguments
Name | Description |
---|---|
id - String!
|
Example
Query
mutation acceptTermsAndConditions($id: String!) {
acceptTermsAndConditions(id: $id) {
message
status
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"acceptTermsAndConditions": {
"message": "abc123",
"status": "abc123"
}
}
}
attemptRemoteStart
Description
Is similar to the remote start, but provides the customer
with more detailed information about the current status.
CANNOT be used for roaming stations.
To get the current status after the mutation you need this query:
[remoteStartAttemptStatus](#query-remoteStartAttemptStatus)
Response
Returns an AttemptRemoteStartResponse!
Arguments
Name | Description |
---|---|
input - AttemptRemoteStartInput!
|
Example
Query
mutation attemptRemoteStart($input: AttemptRemoteStartInput!) {
attemptRemoteStart(input: $input) {
chargeLogId
connectorId
failureReason
id
isFailure
lastSentAt
status
}
}
Variables
{"input": AttemptRemoteStartInput}
Response
{
"data": {
"attemptRemoteStart": {
"chargeLogId": "xyz789",
"connectorId": "xyz789",
"failureReason": "xyz789",
"id": "4",
"isFailure": true,
"lastSentAt": "xyz789",
"status": "xyz789"
}
}
}
createAuthenticationMedia
Description
Create an authentication media
Response
Returns an AuthenticationMediaResponse
Arguments
Name | Description |
---|---|
authenticationMedia - authenticationMediaContract!
|
Example
Query
mutation createAuthenticationMedia($authenticationMedia: authenticationMediaContract!) {
createAuthenticationMedia(authenticationMedia: $authenticationMedia) {
customerReference
id
rateId
}
}
Variables
{"authenticationMedia": authenticationMediaContract}
Response
{
"data": {
"createAuthenticationMedia": {
"customerReference": "abc123",
"id": "xyz789",
"rateId": "xyz789"
}
}
}
createPostpaidContract
Description
Create a postpaid contract
Response
Returns a ContractPostpaidResponse
Arguments
Name | Description |
---|---|
postpaidContract - creatingPostpaidContract
|
Example
Query
mutation createPostpaidContract($postpaidContract: creatingPostpaidContract) {
createPostpaidContract(postpaidContract: $postpaidContract) {
error {
...ContractErrorBodyFragment
}
message
status
}
}
Variables
{"postpaidContract": creatingPostpaidContract}
Response
{
"data": {
"createPostpaidContract": {
"error": ContractErrorBody,
"message": "abc123",
"status": "abc123"
}
}
}
createSepaContract
Description
Create a SEPA contract
Response
Returns a ContractSepaResponse
Arguments
Name | Description |
---|---|
sepaContract - creatingSepaContract
|
Example
Query
mutation createSepaContract($sepaContract: creatingSepaContract) {
createSepaContract(sepaContract: $sepaContract) {
error {
...ContractErrorBodyFragment
}
message
status
}
}
Variables
{"sepaContract": creatingSepaContract}
Response
{
"data": {
"createSepaContract": {
"error": ContractErrorBody,
"message": "xyz789",
"status": "abc123"
}
}
}
deleteContact
Description
Delete Contact: Deleting the current logged in user
Response
Returns a ContactDeleteResponse
Example
Query
mutation deleteContact {
deleteContact {
additionalFields {
...AdditionalRegistrationFieldFragment
}
error {
...ErrorBodyFragment
}
profile {
...ContactFragment
}
status
}
}
Response
{
"data": {
"deleteContact": {
"additionalFields": [AdditionalRegistrationField],
"error": ErrorBody,
"profile": Contact,
"status": "abc123"
}
}
}
initAnonymousSession
Response
Returns a SessionAuthenticationResponse!
Example
Query
mutation initAnonymousSession {
initAnonymousSession {
refreshToken
sessionToken
}
}
Response
{
"data": {
"initAnonymousSession": {
"refreshToken": "abc123",
"sessionToken": "abc123"
}
}
}
initDirectPaymentCharging
Response
Returns an OptileTransaction
Example
Query
mutation initDirectPaymentCharging(
$cardId: String,
$connectorId: String!,
$rateId: String!,
$ratePackageId: String
) {
initDirectPaymentCharging(
cardId: $cardId,
connectorId: $connectorId,
rateId: $rateId,
ratePackageId: $ratePackageId
) {
absoluteLink
id
link
}
}
Variables
{
"cardId": "xyz789",
"connectorId": "xyz789",
"rateId": "xyz789",
"ratePackageId": "abc123"
}
Response
{
"data": {
"initDirectPaymentCharging": {
"absoluteLink": "xyz789",
"id": "xyz789",
"link": "xyz789"
}
}
}
initSession
Response
Returns a SessionAuthenticationResponse!
Example
Query
mutation initSession(
$password: String!,
$username: String!
) {
initSession(
password: $password,
username: $username
) {
refreshToken
sessionToken
}
}
Variables
{
"password": "abc123",
"username": "xyz789"
}
Response
{
"data": {
"initSession": {
"refreshToken": "abc123",
"sessionToken": "xyz789"
}
}
}
registerContact
Description
Create user profile: Expecting a JSON containing the users information a new account is created in the mandant
Response
Returns a ContactResponse
Arguments
Name | Description |
---|---|
additionalFields - [AdditionalRegistrationFieldInput]
|
|
contactProfile - RegisteringContactProfile
|
Example
Query
mutation registerContact(
$additionalFields: [AdditionalRegistrationFieldInput],
$contactProfile: RegisteringContactProfile
) {
registerContact(
additionalFields: $additionalFields,
contactProfile: $contactProfile
) {
additionalFields {
...AdditionalRegistrationFieldFragment
}
error {
...ErrorBodyFragment
}
profile {
...ContactFragment
}
}
}
Variables
{
"additionalFields": [AdditionalRegistrationFieldInput],
"contactProfile": RegisteringContactProfile
}
Response
{
"data": {
"registerContact": {
"additionalFields": [AdditionalRegistrationField],
"error": ErrorBody,
"profile": Contact
}
}
}
registerContactAndLogin
Description
Create user profile: Expecting a JSON containing the users information a new account is created in the mandant
Response
Returns a ContactSession
Arguments
Name | Description |
---|---|
additionalFields - [AdditionalRegistrationFieldInput]
|
|
contactProfile - RegisteringContactProfile
|
Example
Query
mutation registerContactAndLogin(
$additionalFields: [AdditionalRegistrationFieldInput],
$contactProfile: RegisteringContactProfile
) {
registerContactAndLogin(
additionalFields: $additionalFields,
contactProfile: $contactProfile
) {
contact {
...ContactResponseFragment
}
session {
...UserLoginAuthenticationResponseFragment
}
}
}
Variables
{
"additionalFields": [AdditionalRegistrationFieldInput],
"contactProfile": RegisteringContactProfile
}
Response
{
"data": {
"registerContactAndLogin": {
"contact": ContactResponse,
"session": UserLoginAuthenticationResponse
}
}
}
registerPaymentMethod
Response
Returns an OptileTransaction
Example
Query
mutation registerPaymentMethod(
$customerReference: String,
$rateId: String!
) {
registerPaymentMethod(
customerReference: $customerReference,
rateId: $rateId
) {
absoluteLink
id
link
}
}
Variables
{
"customerReference": "xyz789",
"rateId": "abc123"
}
Response
{
"data": {
"registerPaymentMethod": {
"absoluteLink": "xyz789",
"id": "abc123",
"link": "xyz789"
}
}
}
remoteStart
Description
Start a remote charging process
Response
Returns a RemoteStartResponse
Arguments
Name | Description |
---|---|
authorization - Authorization
|
|
connector - String
|
Example
Query
mutation remoteStart(
$authorization: Authorization,
$connector: String
) {
remoteStart(
authorization: $authorization,
connector: $connector
) {
code
id
message
session
status
transaction
}
}
Variables
{
"authorization": Authorization,
"connector": "xyz789"
}
Response
{
"data": {
"remoteStart": {
"code": 987,
"id": "abc123",
"message": "xyz789",
"session": "xyz789",
"status": "abc123",
"transaction": "abc123"
}
}
}
remoteStartWithPreauth
Description
Start a remote charging process with preauth
Response
Returns a RemoteStartWithPreauthResponse
Arguments
Name | Description |
---|---|
authorization - Authorization
|
|
connector - String
|
Example
Query
mutation remoteStartWithPreauth(
$authorization: Authorization,
$connector: String
) {
remoteStartWithPreauth(
authorization: $authorization,
connector: $connector
) {
message
redirectUrl
remoteStartPreauthId
}
}
Variables
{
"authorization": Authorization,
"connector": "abc123"
}
Response
{
"data": {
"remoteStartWithPreauth": {
"message": "xyz789",
"redirectUrl": "abc123",
"remoteStartPreauthId": "xyz789"
}
}
}
remoteStartWithoutInvoicing
Description
Start a remote charging process without invoicing
Response
Returns a RemoteStartResponse
Arguments
Name | Description |
---|---|
authorization - Authorization
|
|
connector - String
|
Example
Query
mutation remoteStartWithoutInvoicing(
$authorization: Authorization,
$connector: String
) {
remoteStartWithoutInvoicing(
authorization: $authorization,
connector: $connector
) {
code
id
message
session
status
transaction
}
}
Variables
{
"authorization": Authorization,
"connector": "abc123"
}
Response
{
"data": {
"remoteStartWithoutInvoicing": {
"code": 123,
"id": "abc123",
"message": "xyz789",
"session": "abc123",
"status": "abc123",
"transaction": "xyz789"
}
}
}
remoteStop
Description
Stop a remote charging process
Response
Returns a RemoteStopResponse
Arguments
Name | Description |
---|---|
transaction - String
|
Example
Query
mutation remoteStop($transaction: String) {
remoteStop(transaction: $transaction) {
code
message
status
title
}
}
Variables
{"transaction": "xyz789"}
Response
{
"data": {
"remoteStop": {
"code": 987,
"message": "xyz789",
"status": "abc123",
"title": "abc123"
}
}
}
renewSession
Response
Returns a SessionAuthenticationResponse!
Example
Query
mutation renewSession {
renewSession {
refreshToken
sessionToken
}
}
Response
{
"data": {
"renewSession": {
"refreshToken": "xyz789",
"sessionToken": "xyz789"
}
}
}
setFavouriteCps
Description
Update the list of favourite Charge Points for the current user
Response
Returns [CpFavouredStatus]
Arguments
Name | Description |
---|---|
ids - [String]!
|
Example
Query
mutation setFavouriteCps($ids: [String]!) {
setFavouriteCps(ids: $ids) {
id
isFavoured
}
}
Variables
{"ids": ["xyz789"]}
Response
{
"data": {
"setFavouriteCps": [
{"id": "abc123", "isFavoured": true}
]
}
}
unsetFavouriteCps
Description
Removing the favourite Charge Points for the current user
Response
Returns [CpFavouredStatus]
Arguments
Name | Description |
---|---|
ids - [String]!
|
Example
Query
mutation unsetFavouriteCps($ids: [String]!) {
unsetFavouriteCps(ids: $ids) {
id
isFavoured
}
}
Variables
{"ids": ["abc123"]}
Response
{
"data": {
"unsetFavouriteCps": [
{"id": "abc123", "isFavoured": true}
]
}
}
updateCard
Response
Returns an UpdateCardResponse!
Arguments
Name | Description |
---|---|
input - UpdateCardInput!
|
Example
Query
mutation updateCard($input: UpdateCardInput!) {
updateCard(input: $input) {
expiryDate
id
label
message
number
status
tagId
type
}
}
Variables
{"input": UpdateCardInput}
Response
{
"data": {
"updateCard": {
"expiryDate": "abc123",
"id": "4",
"label": "xyz789",
"message": "abc123",
"number": "xyz789",
"status": "xyz789",
"tagId": "abc123",
"type": "abc123"
}
}
}
updateContact
Description
Update user profile: Providing a user ID and user JSON, all set fields with a non null value will be updated for user.
Response
Returns a ContactResponse
Arguments
Name | Description |
---|---|
contactProfile - ContactProfile!
|
Example
Query
mutation updateContact($contactProfile: ContactProfile!) {
updateContact(contactProfile: $contactProfile) {
additionalFields {
...AdditionalRegistrationFieldFragment
}
error {
...ErrorBodyFragment
}
profile {
...ContactFragment
}
}
}
Variables
{"contactProfile": ContactProfile}
Response
{
"data": {
"updateContact": {
"additionalFields": [AdditionalRegistrationField],
"error": ErrorBody,
"profile": Contact
}
}
}
updatePostpaidContract
Description
Update a postpaid contract
Response
Returns a ContractPostpaidResponse
Arguments
Name | Description |
---|---|
postpaidContract - updatePostpaidContract
|
Example
Query
mutation updatePostpaidContract($postpaidContract: updatePostpaidContract) {
updatePostpaidContract(postpaidContract: $postpaidContract) {
error {
...ContractErrorBodyFragment
}
message
status
}
}
Variables
{"postpaidContract": updatePostpaidContract}
Response
{
"data": {
"updatePostpaidContract": {
"error": ContractErrorBody,
"message": "xyz789",
"status": "abc123"
}
}
}
updateSepaContract
Description
Update a SEPA contract
Response
Returns a ContractSepaResponse
Arguments
Name | Description |
---|---|
updateSepaContract - updatingSepaContract
|
Example
Query
mutation updateSepaContract($updateSepaContract: updatingSepaContract) {
updateSepaContract(updateSepaContract: $updateSepaContract) {
error {
...ContractErrorBodyFragment
}
message
status
}
}
Variables
{"updateSepaContract": updatingSepaContract}
Response
{
"data": {
"updateSepaContract": {
"error": ContractErrorBody,
"message": "xyz789",
"status": "xyz789"
}
}
}
Types
AccessType
Description
AccessType defines the possible states of how the station can be accessed. Typically a station is either external (e.g. via Roaming) or is a internal station.
Values
Enum Value | Description |
---|---|
|
The station is accessible via the internal infrastructure |
|
The station is accessible via an external roaming interface |
Example
"INTERNAL"
AccountDocument
Description
Details about one document.
Fields
Field Name | Description |
---|---|
documentDate - DateTime
|
The date when the document was issued |
downloadLink - String
|
A Link to download the pdf |
id - String
|
Unique Identifier in form of Int |
title - String
|
The title of the document |
type - accountDocumentType
|
The type of the document |
Example
{
"documentDate": "2007-12-03T10:15:30Z",
"downloadLink": "abc123",
"id": "abc123",
"title": "xyz789",
"type": "creditnote"
}
AccountDocumentsPaged
Description
AccountDocuments filtered by page
Fields
Field Name | Description |
---|---|
data - [AccountDocument]
|
The paged set of documents of the authenticated user. |
pagination - Pagination
|
Pagination filter |
Example
{
"data": [AccountDocument],
"pagination": Pagination
}
AdditionalCpField
AdditionalRegistrationField
AdditionalRegistrationFieldInput
Address
Fields
Field Name | Description |
---|---|
city - String
|
|
country - CountryAlpha
|
|
state - String
|
|
street - String
|
|
zip - String
|
Example
{
"city": "abc123",
"country": "AC",
"state": "abc123",
"street": "abc123",
"zip": "abc123"
}
AddressInput
Fields
Input Field | Description |
---|---|
city - String
|
|
country - CountryAlpha
|
|
state - String
|
|
street - String
|
|
zip - String
|
Example
{
"city": "abc123",
"country": "AC",
"state": "xyz789",
"street": "xyz789",
"zip": "xyz789"
}
AttemptRemoteStartConfig
Description
Additional configuration options for the remote start attempt.
Fields
Input Field | Description |
---|---|
ratePackage - String
|
ID of a selected rate package. |
stopMinutes - Int
|
Number of minutes after which a remote stop is automatically triggered. |
validUntil - String
|
A start will be permitted until the specified date and time. If validUntil is not set, it is automatically set to now +10 minutes. Must be a valid ISO 8601 date string. |
Example
{
"ratePackage": "xyz789",
"stopMinutes": 987,
"validUntil": "xyz789"
}
AttemptRemoteStartInput
Fields
Input Field | Description |
---|---|
config - AttemptRemoteStartConfig
|
Optional configuration parameters. |
connectorId - String!
|
|
tagId - String!
|
Example
{
"config": AttemptRemoteStartConfig,
"connectorId": "abc123",
"tagId": "xyz789"
}
AttemptRemoteStartResponse
Fields
Field Name | Description |
---|---|
chargeLogId - String
|
The id of the chargelog related to this attempt. |
connectorId - String!
|
The connector this attempt was carried out on. |
failureReason - String
|
Message describing why this attempt did not succeed. |
id - ID!
|
|
isFailure - Boolean!
|
Indicates if this attempt was successful so far. |
lastSentAt - String
|
The last time a message was sent to the station for this attempt. |
status - String!
|
The current status of this attempt. |
Example
{
"chargeLogId": "xyz789",
"connectorId": "abc123",
"failureReason": "abc123",
"id": "4",
"isFailure": false,
"lastSentAt": "xyz789",
"status": "abc123"
}
AuthenticationMediaResponse
Authorization
Fields
Input Field | Description |
---|---|
identifier - String!
|
|
type - AuthorizationType!
|
Example
{"identifier": "xyz789", "type": "AUTO"}
AuthorizationType
Values
Enum Value | Description |
---|---|
|
|
|
Example
"AUTO"
AvailableCurrencies
Fields
Field Name | Description |
---|---|
data - [AvailableCurrency]
|
|
pagination - Pagination
|
Example
{
"data": [AvailableCurrency],
"pagination": Pagination
}
AvailableCurrency
Fields
Field Name | Description |
---|---|
currency - Currency
|
Unique identifier in form of an iso code. |
Example
{"currency": Currency}
BankAccountResponse
Example
{
"accountHolder": "abc123",
"bank": "xyz789",
"bic": "xyz789",
"iban": "abc123"
}
Boolean
Description
The Boolean
scalar type represents true
or false
.
Example
true
Card
Fields
Field Name | Description |
---|---|
deactivationReason - String!
|
Reason of deactivation |
expiryDate - DateTime
|
Expiry date of the authentication media (card). |
id - String!
|
Unique identifier in form of an uuid. |
label - String
|
Label of the authentication media (card). |
number - String!
|
Number of the authentication media (card). |
preauthRequired - Boolean!
|
Indicator whether a preauthentication is necessary on the corresponding payment medium. |
rate - RateOption
|
Rate options of card |
status - CardStatus
|
Indicator whether authentication media (card) is active/inactive. |
tagId - String!
|
Unique identifier in form of an tag id. |
type - CardType
|
Type of the authentication media (card). |
Example
{
"deactivationReason": "xyz789",
"expiryDate": "2007-12-03T10:15:30Z",
"id": "xyz789",
"label": "abc123",
"number": "xyz789",
"preauthRequired": true,
"rate": RateOption,
"status": "active",
"tagId": "abc123",
"type": "default"
}
CardForChargingProcess
Fields
Field Name | Description |
---|---|
expiryDate - DateTime
|
Expiry date of the authentication media (card). |
id - String!
|
Unique identifier in form of an uuid. |
label - String
|
Label of the authentication media (card). |
number - String!
|
Number of the authentication media (card). |
preauthRequired - Boolean!
|
Indicator whether a preauthentication is necessary on the corresponding payment medium. |
rate - RateDescriptionForChargingProcess
|
Information on rate which will be applied to the charging process. |
tagId - String!
|
Unique identifier in form of an tag id. |
type - CardType
|
Type of the authentication media (card). |
Example
{
"expiryDate": "2007-12-03T10:15:30Z",
"id": "abc123",
"label": "xyz789",
"number": "abc123",
"preauthRequired": false,
"rate": RateDescriptionForChargingProcess,
"tagId": "abc123",
"type": "default"
}
CardInterface
Fields
Field Name | Description |
---|---|
expiryDate - DateTime
|
Expiry date of the authentication media (card). |
id - String!
|
Unique identifier in form of an uuid. |
label - String
|
Label of the authentication media (card). |
number - String!
|
Number of the authentication media (card). |
preauthRequired - Boolean!
|
Indicator whether a preauthentication is necessary on the corresponding payment medium. |
tagId - String!
|
Unique identifier in form of an tag id. |
type - CardType
|
Type of the authentication media (card). |
Possible Types
CardInterface Types |
---|
Example
{
"expiryDate": "2007-12-03T10:15:30Z",
"id": "abc123",
"label": "abc123",
"number": "xyz789",
"preauthRequired": true,
"tagId": "abc123",
"type": "default"
}
CardStatus
Values
Enum Value | Description |
---|---|
|
|
|
Example
"active"
CardStatusActionEnum
Description
defined values for card status actions
Values
Enum Value | Description |
---|---|
|
Example
"DEACTIVATE"
CardType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
Example
"default"
CardsPaged
Fields
Field Name | Description |
---|---|
data - [Card]
|
|
pagination - Pagination
|
Example
{
"data": [Card],
"pagination": Pagination
}
CdrCostItem
Fields
Field Name | Description |
---|---|
description - String
|
Description of the item type |
grossAmount - Float
|
Gross amount |
grossAmountLocalCurrency - Float
|
Gross amount expressed in local currency |
netAmount - Float
|
Net amount |
netAmountLocalCurrency - Float
|
Net amount expressed in local currency |
taxAmount - Float
|
Tax amount |
taxAmountLocalCurrency - Float
|
Tax amount expressed in local currency |
taxRate - Float
|
Percentage of the tax |
Example
{
"description": "abc123",
"grossAmount": 987.65,
"grossAmountLocalCurrency": 123.45,
"netAmount": 987.65,
"netAmountLocalCurrency": 123.45,
"taxAmount": 987.65,
"taxAmountLocalCurrency": 123.45,
"taxRate": 987.65
}
ChargeLogFilterStatus
Values
Enum Value | Description |
---|---|
|
|
|
Example
"started"
ChargeLogType
Description
ToDo Add cp,card ....
Values
Enum Value | Description |
---|---|
|
Example
"contact"
Chargelog
Fields
Field Name | Description |
---|---|
authId - String!
|
The identifier with whom the charging process was authorized. |
authType - String
|
The type of autherntication media with whom the charging process was authiorized. |
calibrationDetails - String
|
The link to download calibration details. |
co2Saving - Float
|
The CO2 saving in kg CO2. |
connector - Connector!
|
The connector on which the charging process is/was running. |
cost - Cost
|
The costs of the charging process. |
dateEnd - DateTime
|
End date of the charging process. |
dateStart - DateTime
|
Start date of the charging process. |
energyConsumption - Float
|
The consumed energy in kWh. |
id - ID!
|
Unique identifier in form of an uuid. |
meterEnd - Int
|
End value of the meter. |
meterStart - Int
|
Starting value of the meter. |
rateName - String
|
Name of the used rate. |
sessionId - String
|
Id of the Session. Needed to stop the transaction |
status - String!
|
The current status of the charging process. |
Example
{
"authId": "abc123",
"authType": "xyz789",
"calibrationDetails": "xyz789",
"co2Saving": 987.65,
"connector": Connector,
"cost": Cost,
"dateEnd": "2007-12-03T10:15:30Z",
"dateStart": "2007-12-03T10:15:30Z",
"energyConsumption": 123.45,
"id": 4,
"meterEnd": 123,
"meterStart": 123,
"rateName": "xyz789",
"sessionId": "xyz789",
"status": "abc123"
}
ChargelogFilter
Description
Filter for chargelogs.
Fields
Input Field | Description |
---|---|
status - ChargeLogFilterStatus
|
The current status of the charging process. |
Example
{"status": "started"}
ChargelogsPaged
Fields
Field Name | Description |
---|---|
data - [Chargelog]
|
|
pagination - Pagination
|
Example
{
"data": [Chargelog],
"pagination": Pagination
}
ChargingStatistics
Connector
Description
Connector information
Fields
Field Name | Description |
---|---|
connectorType - ConnectorType
|
|
cp - Cp
|
|
evseId - String
|
|
freeOfCharge - Boolean
|
|
id - ID!
|
|
label - String
|
|
maintenanceWindows - [ConnectorMaintenanceWindow]!
|
|
sortOrder - String
|
|
status - ConnectorStatus
|
Example
{
"connectorType": ConnectorType,
"cp": Cp,
"evseId": "xyz789",
"freeOfCharge": true,
"id": 4,
"label": "abc123",
"maintenanceWindows": [ConnectorMaintenanceWindow],
"sortOrder": "abc123",
"status": ConnectorStatus
}
ConnectorFilter
Description
With this parameter, you can set different filter options for the connector.
As the filter options can change over time, depending on the stations available in our system, the different options are not hardcoded. They can be retrieved from the filters query.
Fields
Input Field | Description |
---|---|
options - [String]
|
Array of options for the type of filter. |
slug - FilterType
|
The type of the filter to apply |
Example
{"options": ["current_type_ac"], "slug": "POWER_CLASS"}
ConnectorMaintenanceWindow
Description
Connector maintenance window
Example
{
"comment": "xyz789",
"endDate": "2007-12-03T10:15:30Z",
"startDate": "2007-12-03T10:15:30Z"
}
ConnectorStatus
Fields
Field Name | Description |
---|---|
calculated - String
|
Calculated current cp connector status |
connectorId - ID!
|
The connector’s internal ID. |
ocpp - String
|
Latest/current ocpp connector status that was received from the connector |
simple - SimpleConnectorStatus
|
Calculated current cp connector status in simplified form |
Example
{
"calculated": "xyz789",
"connectorId": "4",
"ocpp": "abc123",
"simple": "Available"
}
ConnectorType
Description
Type of connector
Fields
Field Name | Description |
---|---|
chargePointType - String
|
Charge point type of the connector (AC or DC). |
chargingFacilityType - String
|
Charging facility type of the connector. |
chargingModeType - String
|
Charging mode type of the connector. |
id - ID!
|
Internal ID of the connector type. |
label - String
|
Label of the connector's type. |
maxPowerRating - Float
|
Maximum power rating of the connector, defined in kW. |
plugType - String
|
Plug type of the connector. |
standard - String
|
Standard of the connector's type. |
Example
{
"chargePointType": "abc123",
"chargingFacilityType": "abc123",
"chargingModeType": "xyz789",
"id": "4",
"label": "xyz789",
"maxPowerRating": 123.45,
"plugType": "xyz789",
"standard": "abc123"
}
Contact
Description
Contact data
Fields
Field Name | Description |
---|---|
address - Address
|
|
birthday - DateTime
|
|
companyId - Int
|
|
createdAt - DateTime
|
|
currency - Currency
|
|
displayName - String
|
|
email - String
|
|
firstName - String
|
|
gender - Gender
|
gender can be female, male, company or diverse |
id - String
|
|
isCompany - Boolean
|
isCompany is either true or false |
isDeactivated - Boolean
|
|
language - LanguageCode
|
|
mobile - String
|
|
name - String
|
|
phone - String
|
|
termsAndConditionsAccepted - Boolean
|
|
updatedAt - DateTime
|
|
vat - String
|
Example
{
"address": Address,
"birthday": "2007-12-03T10:15:30Z",
"companyId": 987,
"createdAt": "2007-12-03T10:15:30Z",
"currency": Currency,
"displayName": "xyz789",
"email": "xyz789",
"firstName": "abc123",
"gender": "company",
"id": "xyz789",
"isCompany": false,
"isDeactivated": true,
"language": "cs_CZ",
"mobile": "abc123",
"name": "abc123",
"phone": "abc123",
"termsAndConditionsAccepted": true,
"updatedAt": "2007-12-03T10:15:30Z",
"vat": "xyz789"
}
ContactDeleteResponse
Description
Delete response: Informs the client if the delete was performed.
Fields
Field Name | Description |
---|---|
additionalFields - [AdditionalRegistrationField]
|
|
error - ErrorBody
|
|
profile - Contact
|
|
status - String
|
Example
{
"additionalFields": [AdditionalRegistrationField],
"error": ErrorBody,
"profile": Contact,
"status": "abc123"
}
ContactInformation
ContactProfile
Description
User profile
Fields
Input Field | Description |
---|---|
address - AddressInput
|
|
birthday - DateTime
|
|
companyId - Int
|
|
currency - String
|
|
email - String
|
|
fax - String
|
|
firstName - String
|
|
gender - Gender
|
gender can be female, male, company or diverse |
id - String
|
|
isCompany - Boolean
|
isCompany is either true or false |
isDeactivated - Boolean
|
|
language - LanguageCode
|
|
mobile - String
|
|
name - String
|
|
phone - String
|
|
vat - String
|
Example
{
"address": AddressInput,
"birthday": "2007-12-03T10:15:30Z",
"companyId": 123,
"currency": "xyz789",
"email": "xyz789",
"fax": "abc123",
"firstName": "abc123",
"gender": "company",
"id": "xyz789",
"isCompany": false,
"isDeactivated": false,
"language": "cs_CZ",
"mobile": "xyz789",
"name": "abc123",
"phone": "xyz789",
"vat": "xyz789"
}
ContactResponse
Fields
Field Name | Description |
---|---|
additionalFields - [AdditionalRegistrationField]
|
|
error - ErrorBody
|
|
profile - Contact
|
Example
{
"additionalFields": [AdditionalRegistrationField],
"error": ErrorBody,
"profile": Contact
}
ContactSession
Fields
Field Name | Description |
---|---|
contact - ContactResponse
|
|
session - UserLoginAuthenticationResponse
|
Example
{
"contact": ContactResponse,
"session": UserLoginAuthenticationResponse
}
ContractData
ContractErrorBody
Fields
Field Name | Description |
---|---|
code - String
|
|
response - ContractErrorResponse
|
Example
{
"code": "abc123",
"response": ContractErrorResponse
}
ContractErrorResponse
Fields
Field Name | Description |
---|---|
body - ContractErrorResponseStatus
|
|
status - Int
|
|
statusText - String
|
Example
{
"body": ContractErrorResponseStatus,
"status": 987,
"statusText": "abc123"
}
ContractErrorResponseStatus
ContractPaymentMethod
Description
ContractPaymentMethods data
Example
{
"applicationId": "xyz789",
"cardCreateMode": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"directPaymentMethod": "abc123",
"emp": "abc123",
"paymentName": "xyz789",
"paymentType": "abc123",
"termsOfServiceUrl": "abc123",
"termsOfUseUrl": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"uuid": "xyz789"
}
ContractPostpaidResponse
Fields
Field Name | Description |
---|---|
error - ContractErrorBody
|
|
message - String
|
|
status - String
|
Example
{
"error": ContractErrorBody,
"message": "abc123",
"status": "abc123"
}
ContractSepaResponse
Fields
Field Name | Description |
---|---|
error - ContractErrorBody
|
|
message - String
|
|
status - String
|
Example
{
"error": ContractErrorBody,
"message": "abc123",
"status": "abc123"
}
Cost
Example
{
"costItems": [CdrCostItem],
"currency": "xyz789",
"grossAmount": 123.45,
"grossAmountLocalCurrency": 987.65,
"tax": 987.65,
"taxAmount": 123.45,
"total": 123.45
}
CountryAlpha
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AC"
Cp
Description
Representation of a charging station.
Fields
Field Name | Description |
---|---|
accessType - AccessType
|
Type of the access to a station which is either a internal or external connection. Depending on the access type the request is either handled only in our system or parts might be forwarded to other parties. |
additionalFields - [AdditionalCpField]
|
Additional cp fields (customisable info fields per mandant) |
address - String
|
Address (Streetname) |
capabilities - CpCapabilities
|
Capabilities of a charging station |
city - String
|
City |
connectors - [Connector]
|
List of connectors. |
contact - ContactInformation
|
Contact information |
country - String
|
Country (3 characters) |
directions - String
|
Additional direction information for the station. Mostly used for truck-specific charging stations. |
displayAttributes - DisplayAttributes
|
Specific attributes about how the station should be displayed. |
id - ID!
|
Unique Identifier in form of UUID4 |
images - [CpImage]
|
CP Images as array |
information - CpInfo
|
Information |
isFavoured - Boolean
|
Is CP marked as a favourite by user |
label - String
|
Human readable string representation. |
latitude - Float
|
Latitude of the position. |
longitude - Float
|
Longitude of the position. |
operator - CpOperator
|
the operator of the station |
publicName - String
|
Public display name |
site - Site
|
Site |
siteId - String
|
Site uuid of Cp |
status - CpStatus
|
Status information |
zip - String
|
Zip code |
Example
{
"accessType": "INTERNAL",
"additionalFields": [AdditionalCpField],
"address": "abc123",
"capabilities": CpCapabilities,
"city": "abc123",
"connectors": [Connector],
"contact": ContactInformation,
"country": "xyz789",
"directions": "xyz789",
"displayAttributes": DisplayAttributes,
"id": "4",
"images": [CpImage],
"information": CpInfo,
"isFavoured": true,
"label": "xyz789",
"latitude": 987.65,
"longitude": 987.65,
"operator": CpOperator,
"publicName": "abc123",
"site": Site,
"siteId": "abc123",
"status": CpStatus,
"zip": "abc123"
}
CpCapabilities
Description
Capabilities of a charging station
Fields
Field Name | Description |
---|---|
hasRemoteCommands - Boolean!
|
The capability of the station to work with remote commands |
Example
{"hasRemoteCommands": false}
CpFavouredStatus
CpImage
Fields
Field Name | Description |
---|---|
url - String
|
Url of a cp image |
Example
{"url": "abc123"}
CpInfo
Fields
Field Name | Description |
---|---|
additional - String
|
Additional information |
marketingDisplay - String
|
A display status, which can be configured within the backends marketing information section of a charging station |
openingTimes - OpeningTimes
|
Opening times |
operatingTimes - OperatingTimes
|
Operating times |
payment - String
|
Payment information |
Example
{
"additional": "xyz789",
"marketingDisplay": "xyz789",
"openingTimes": OpeningTimes,
"operatingTimes": OperatingTimes,
"payment": "abc123"
}
CpOperator
CpStatus
Description
CpStatus
Fields
Field Name | Description |
---|---|
calculated - String
|
Calculated current cp status |
ocpp - String
|
Latest/current ocpp status that was received from the station |
simple - SimpleCpStatus
|
Calculated current cp status in simplified form |
Example
{
"calculated": "abc123",
"ocpp": "abc123",
"simple": "Available"
}
CpsPaged
Description
CpsPaged contains information about the used pagination and paginated cps
Fields
Field Name | Description |
---|---|
data - [Cp]
|
|
pagination - PaginationInterface
|
Example
{
"data": [Cp],
"pagination": PaginationInterface
}
Currency
Fields
Field Name | Description |
---|---|
isoCode - String
|
Example
{"isoCode": "abc123"}
CurrencyAmount
CursorFilter
CursorPagination
Description
Pagination information with cursor.
Fields
Field Name | Description |
---|---|
cursor - String
|
The cursor with which the query can be continued. |
isLastPage - Boolean
|
Required for backward compatibility. Always null and will be removed in the future. Do not use, will be removed in the future. |
limit - Int
|
Maximum number of elements (limit) set for this pagination request |
offset - Int
|
Required for backward compatibility. Always null and will be removed in the future. Do not use, will be removed in the future. |
totalCount - Int
|
Required for backward compatibility. Always null and will be removed in the future. Do not use, will be removed in the future. |
Example
{
"cursor": "xyz789",
"isLastPage": true,
"limit": 123,
"offset": 123,
"totalCount": 987
}
DateTime
Example
"2007-12-03T10:15:30Z"
DirectPaymentChargingStatus
DisplayAttributes
Fields
Field Name | Description |
---|---|
mode - DisplayAttributesMode
|
The mode in which the station should be displayed, regular or highlighted. |
Example
{"mode": "DEFAULT"}
DisplayAttributesMode
Values
Enum Value | Description |
---|---|
|
|
|
Example
"DEFAULT"
ErrorBody
Fields
Field Name | Description |
---|---|
code - String
|
|
response - LoginErrorResponse
|
Example
{
"code": "xyz789",
"response": LoginErrorResponse
}
Filter
Description
This describes one possible property on which a connector can be filtered, as well as all possible options for this property. Can be used in conjunction with the ConnectorFilter input.
Fields
Field Name | Description |
---|---|
label - String
|
Description of the filter. This label can be displayed to the user. |
options - [FilterOption]
|
List of filter options for the type of filter. |
slug - FilterType
|
Unique identifier in form of a slug. The same enum is used in the filter input slug. |
type - String
|
Information on the filter type (eg. multiselect). |
Example
{
"label": "Power Class",
"options": [FilterOption],
"slug": "POWER_CLASS",
"type": "multiselect"
}
FilterOption
Description
One possible option for a specific type of filter.
Fields
Field Name | Description |
---|---|
default - Boolean
|
Default value of filter option. |
icon - String
|
Icon slug for filter option. Can be used to display a specific icon for the filter option. |
label - String
|
Detailed description of the filter option. This label can be displayed to the user. |
slug - String
|
Unique identifier in form of a slug. This slug is used in the filter input options array. |
Example
{
"default": true,
"icon": "connector-ccs",
"label": "CCS/Combo 2",
"slug": "connector_plug_type_connector-ccs"
}
FilterType
Description
The properties of the connector that can be filtered
Values
Enum Value | Description |
---|---|
|
the type of the connector (e.g. Type 2) |
|
the power class of the connector (e.g. < 50kW) |
|
the type of the current (AC or DC) |
Example
"FILTER_BY_CONNECTOR_TYPE"
Float
Description
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
Gender
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"company"
HostedPaymentMethodGetSession
ID
Description
The ID
scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4"
) or integer (such as 4
) input value will be accepted as an ID.
Example
"4"
Int
Description
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
LanguageCode
Description
All languages supported by the API
Values
Enum Value | Description |
---|---|
|
Czech |
|
Danish |
|
German |
|
Greek |
|
English |
|
Spanish |
|
Estonian |
|
Finnish |
|
French |
|
Croatian |
|
Hungarian |
|
Italian |
|
Japanese |
|
Lithuanian |
|
Latvian |
|
Dutch |
|
Norwegian |
|
Polish |
|
Romanian |
|
Russian |
|
Slovak |
|
Slovenian |
|
Swedish |
|
Ukrainian |
Example
"cs_CZ"
LegalDocument
LocationFilter
LoginErrorResponse
Fields
Field Name | Description |
---|---|
body - LoginErrorResponseStatus
|
|
status - Int
|
|
statusText - String
|
Example
{
"body": LoginErrorResponseStatus,
"status": 123,
"statusText": "xyz789"
}
LoginErrorResponseStatus
MaskedAccount
Description
detailed information about the payment method to display to the user
Example
{
"displayLabel": "xyz789",
"expiryMonth": 123,
"expiryYear": 123,
"holderName": "xyz789",
"number": "abc123"
}
NativePaymentMethodGetSession
Fields
Field Name | Description |
---|---|
applicablePaymentMethods - [PaymentMethod]
|
|
registeredPaymentsMethods - [PaymentMethod]
|
|
sessionId - String
|
Example
{
"applicablePaymentMethods": [PaymentMethod],
"registeredPaymentsMethods": [PaymentMethod],
"sessionId": "abc123"
}
OccupancyDays
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL"
OccupancyRate
OpeningTimes
Fields
Field Name | Description |
---|---|
description - String
|
Opening times in textual format |
exceptionalClosings - [OperatingTime]
|
Exceptional closing times |
exceptionalOpenings - [OperatingTime]
|
Exceptional opening times |
regularHours - [RegularHours]
|
Structured data of opening times |
Example
{
"description": "abc123",
"exceptionalClosings": [OperatingTime],
"exceptionalOpenings": [OperatingTime],
"regularHours": [RegularHours]
}
OperatingHours
Description
OperatingHours have the format 'hh/mm/ss'.
Defining the types as DateTime makes trouble because tests are failing. But in Sandbox DateTime is working.
Example
{
"begin": "xyz789",
"end": "xyz789"
}
OperatingTime
OperatingTimes
Fields
Field Name | Description |
---|---|
regularHours - [RegularHours]
|
Structured data of operating times |
Example
{"regularHours": [RegularHours]}
OperationType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHARGE"
OptileTransaction
Pagination
Description
Pagination information.
Additional information for pagination responses
Fields
Field Name | Description |
---|---|
isLastPage - Boolean
|
Is this page the last page of the pagination set |
limit - Int
|
Maximum number of elements (limit) set for this pagination request |
offset - Int
|
The current offset chosen for the pagination set |
totalCount - Int
|
Overall count of pagination result (total number of objects) |
Example
{"isLastPage": true, "limit": 987, "offset": 987, "totalCount": 987}
PaginationFilter
Description
Filter to do pagination requests
Example
{"limit": 123, "offset": 123}
PaginationInterface
Fields
Field Name | Description |
---|---|
isLastPage - Boolean
|
Is this page the last page of the pagination set Marked for deletion. Use inline fragments to stay compatible. |
limit - Int
|
Maximum number of elements (limit) set for this pagination request |
offset - Int
|
The current offset chosen for the pagination set Marked for deletion. Use inline fragments to stay compatible. |
totalCount - Int
|
Overall count of pagination result (total number of objects). Marked for deletion. Use inline fragments to stay compatible. |
Possible Types
PaginationInterface Types |
---|
Example
{"isLastPage": false, "limit": 987, "offset": 987, "totalCount": 987}
PaymentLink
Example
{
"form": "abc123",
"lang": "xyz789",
"localizedForm": "abc123",
"logo": "abc123",
"operation": "abc123",
"self": "abc123",
"validation": "xyz789"
}
PaymentMethod
Description
Represents a payment card that is either registered or available for registration for current session user.
Fields
Field Name | Description |
---|---|
button - String
|
|
code - String
|
|
contractData - ContractData
|
|
deferral - String
|
|
grouping - String
|
|
iFrameHeight - Int
|
|
label - String
|
|
links - PaymentLink
|
|
maskedAccount - MaskedAccount
|
detailed information about the payment method to display to the user |
method - String
|
|
operationType - OperationType
|
|
recurrence - String
|
|
redirect - Boolean
|
|
registration - String
|
|
selected - Boolean
|
Example
{
"button": "xyz789",
"code": "abc123",
"contractData": ContractData,
"deferral": "xyz789",
"grouping": "abc123",
"iFrameHeight": 123,
"label": "abc123",
"links": PaymentLink,
"maskedAccount": MaskedAccount,
"method": "abc123",
"operationType": "CHARGE",
"recurrence": "xyz789",
"redirect": true,
"registration": "xyz789",
"selected": true
}
PaymentMethods
Description
Response body for payment cards fetched from PSPs
Fields
Field Name | Description |
---|---|
hostedSession - HostedPaymentMethodGetSession
|
|
nativeSession - NativePaymentMethodGetSession
|
Example
{
"hostedSession": HostedPaymentMethodGetSession,
"nativeSession": NativePaymentMethodGetSession
}
RateDescriptionForChargingProcess
Fields
Field Name | Description |
---|---|
description - String
|
Description of the rate. |
preauthAmount - Float
|
How much money will be preauthorized on the payment medium when this rate is used. No longer supported |
preauthCurrencyAmount - CurrencyAmount
|
How much money will be preauthorized on the payment medium when this rate is used. |
shortDescription - String
|
Short description of the rate. |
Example
{
"description": "abc123",
"preauthAmount": 123.45,
"preauthCurrencyAmount": CurrencyAmount,
"shortDescription": "abc123"
}
RateOption
Fields
Field Name | Description |
---|---|
description - String
|
|
id - String!
|
|
name - String
|
|
preauthAmount - Float
|
How much money will be preauthorized on the payment medium when this rate is used. No longer supported |
preauthCurrencyAmount - CurrencyAmount
|
How much money will be preauthorized on the payment medium when this rate is used. |
shortDescription - String
|
|
uuid - String
|
No longer supported |
Example
{
"description": "xyz789",
"id": "abc123",
"name": "abc123",
"preauthAmount": 123.45,
"preauthCurrencyAmount": CurrencyAmount,
"shortDescription": "xyz789",
"uuid": "abc123"
}
RatePackage
Fields
Field Name | Description |
---|---|
amount - Float
|
|
automaticStop - Int
|
|
id - String
|
|
rate - RateOption
|
|
visibleRuntime - Int
|
Example
{
"amount": 987.65,
"automaticStop": 123,
"id": "xyz789",
"rate": RateOption,
"visibleRuntime": 123
}
RegisteringContactProfile
Fields
Input Field | Description |
---|---|
address - AddressInput
|
|
birthday - DateTime
|
|
companyId - Int
|
|
currency - String
|
|
email - String!
|
|
fax - String
|
|
firstName - String
|
|
gender - Gender
|
gender can be female, male, company or diverse |
isCompany - Boolean
|
isCompany is either true or false |
isDeactivated - Boolean
|
|
language - LanguageCode
|
|
mobile - String
|
|
name - String
|
|
password - String!
|
|
phone - String
|
|
title - String
|
|
vat - String
|
Example
{
"address": AddressInput,
"birthday": "2007-12-03T10:15:30Z",
"companyId": 987,
"currency": "abc123",
"email": "xyz789",
"fax": "abc123",
"firstName": "xyz789",
"gender": "company",
"isCompany": true,
"isDeactivated": false,
"language": "cs_CZ",
"mobile": "xyz789",
"name": "xyz789",
"password": "abc123",
"phone": "xyz789",
"title": "xyz789",
"vat": "xyz789"
}
RegularHours
Fields
Field Name | Description |
---|---|
operatingHours - OperatingHours
|
Structured data of operating hours |
weekday - Int
|
Weekday for regular hour definition (0 as Sunday and 6 as Saturday) |
Example
{"operatingHours": OperatingHours, "weekday": 123}
RemoteStartResponse
RemoteStartWithPreauthResponse
Description
Response of a remote start with preauth
Example
{
"message": "xyz789",
"redirectUrl": "abc123",
"remoteStartPreauthId": "xyz789"
}
RemoteStopResponse
SessionAuthenticationResponse
Setting
SimpleConnectorStatus
Description
Set of simple statuses which a charging connector can have
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"Available"
SimpleCpStatus
Description
Set of simple statuses which a charging station can have
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"Available"
Site
Example
{
"company": "abc123",
"cps": [Cp],
"id": "abc123",
"label": "abc123",
"latitude": 987.65,
"longitude": 123.45,
"scope": "xyz789"
}
SitesPaged
Fields
Field Name | Description |
---|---|
data - [Site]
|
|
pagination - Pagination
|
Example
{
"data": [Site],
"pagination": Pagination
}
String
Description
The String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
TermsAndConditionsStatus
TimeFrameFilter
UpdateCardInput
Fields
Input Field | Description |
---|---|
cardId - String!
|
|
label - String
|
|
status - CardStatusActionEnum
|
Example
{
"cardId": "xyz789",
"label": "xyz789",
"status": "DEACTIVATE"
}
UpdateCardResponse
Fields
Field Name | Description |
---|---|
expiryDate - String
|
The set expiry date of card |
id - ID
|
|
label - String
|
The label of the card |
message - String
|
Message from the response |
number - String
|
The card number |
status - String!
|
Returns a active | inactive status of the card |
tagId - String!
|
The card id |
type - String!
|
The variable card type as default | roaming | virtual | simple | emsp |
Example
{
"expiryDate": "xyz789",
"id": 4,
"label": "abc123",
"message": "xyz789",
"number": "abc123",
"status": "xyz789",
"tagId": "abc123",
"type": "abc123"
}
UserLoginAuthenticationResponse
accountDocumentType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"creditnote"
authenticationMediaContract
chargelogMeterValuesSummary
Description
Detailed information regarding meter values of a charging session.
Fields
Field Name | Description |
---|---|
currentPower - Int
|
current charging current |
currentPowerLastChanged - String
|
timestamp from the charging station of the latest charging current change |
currentStateOfCharge - Int
|
the current SoC of the car |
energyFirstValue - Float
|
the first energy value transmitted from the station |
energyFirstValueTime - String
|
timestamp from the charging station for the first energy value |
energyLastValue - Float
|
the latest energy value transmitted from the station |
energyLastValueTime - String
|
timestamp from the charging station for the latest energy value |
energyUpdatedAt - String
|
timestamp of the last energy update of the charging session record in our system |
initialStateOfCharge - Int
|
the initial SoC of the car |
stateOfChargeLastChanged - String
|
timestamp from the charging station of the latest SoC change |
sumEnergy - Float
|
total charged energy |
updatedAt - String
|
timestamp of the last update of the charging session record in our system |
Example
{
"currentPower": 987,
"currentPowerLastChanged": "abc123",
"currentStateOfCharge": 123,
"energyFirstValue": 123.45,
"energyFirstValueTime": "abc123",
"energyLastValue": 987.65,
"energyLastValueTime": "abc123",
"energyUpdatedAt": "abc123",
"initialStateOfCharge": 987,
"stateOfChargeLastChanged": "xyz789",
"sumEnergy": 987.65,
"updatedAt": "abc123"
}
creatingPostpaidContract
creatingSepaContract
Fields
Input Field | Description |
---|---|
accountHolder - String!
|
Name of the bank account owner |
bank - String!
|
Name of the bank institut. |
bic - String!
|
Business Identifier Code (SWIFT Code). |
customerReference - String
|
A text field for the customer to name his card individually. |
debitType - String!
|
Type of the debit card |
iban - String!
|
International Bank Account Number. |
id - String!
|
Id of a registered contract option. |
rateId - String!
|
RateId |
useParent - Boolean!
|
Use the parent account |
Example
{
"accountHolder": "abc123",
"bank": "abc123",
"bic": "xyz789",
"customerReference": "abc123",
"debitType": "xyz789",
"iban": "abc123",
"id": "abc123",
"rateId": "xyz789",
"useParent": false
}
updatePostpaidContract
updatingSepaContract
Fields
Input Field | Description |
---|---|
accountHolder - String
|
Name of the bank account owner |
bank - String
|
Name of the bank institut. |
bic - String
|
Business Identifier Code (SWIFT Code). |
customerReference - String
|
A text field for the customer to name his card individually. |
iban - String
|
International Bank Account Number. |
id - String!
|
Uuid of a registered contract option. |
Example
{
"accountHolder": "xyz789",
"bank": "xyz789",
"bic": "xyz789",
"customerReference": "xyz789",
"iban": "xyz789",
"id": "xyz789"
}