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": "abc123",
      "id": "abc123",
      "title": "abc123",
      "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

Example

Query
query additionalRegistrationFields {
  additionalRegistrationFields {
    description
    name
    required
    type
    value
  }
}
Response
{
  "data": {
    "additionalRegistrationFields": [
      {
        "description": "abc123",
        "name": "abc123",
        "required": "xyz789",
        "type": "abc123",
        "value": "abc123"
      }
    ]
  }
}

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
    rate {
      ...RateDescriptionForChargingProcessFragment
    }
    tagId
    type
  }
}
Variables
{"connectorId": "xyz789"}
Response
{
  "data": {
    "availableCardsForChargingProcess": [
      {
        "expiryDate": "2007-12-03T10:15:30Z",
        "id": "xyz789",
        "label": "abc123",
        "number": "xyz789",
        "rate": RateDescriptionForChargingProcess,
        "tagId": "abc123",
        "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": "xyz789"
    }
  }
}

card

Description

Get a card by tag id or uuid.

Response

Returns a Card

Arguments
Name Description
id - String!

Example

Query
query card($id: String!) {
  card(id: $id) {
    deactivationReason
    expiryDate
    id
    label
    number
    rate {
      ...RateOptionFragment
    }
    status
    tagId
    type
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "card": {
      "deactivationReason": "abc123",
      "expiryDate": "2007-12-03T10:15:30Z",
      "id": "abc123",
      "label": "abc123",
      "number": "xyz789",
      "rate": RateOption,
      "status": "active",
      "tagId": "xyz789",
      "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.

Response

Returns a Chargelog

Arguments
Name Description
id - 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": "xyz789",
      "authType": "xyz789",
      "calibrationDetails": "xyz789",
      "co2Saving": 123.45,
      "connector": Connector,
      "cost": Cost,
      "dateEnd": "2007-12-03T10:15:30Z",
      "dateStart": "2007-12-03T10:15:30Z",
      "energyConsumption": 123.45,
      "id": "4",
      "meterEnd": 987,
      "meterStart": 987,
      "rateName": "xyz789",
      "sessionId": "abc123",
      "status": "xyz789"
    }
  }
}

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": "abc123"}
Response
{
  "data": {
    "chargelogMeterValuesSummary": {
      "currentPower": 123,
      "currentPowerLastChanged": "abc123",
      "currentStateOfCharge": 123,
      "energyFirstValue": 123.45,
      "energyFirstValueTime": "abc123",
      "energyLastValue": 987.65,
      "energyLastValueTime": "xyz789",
      "energyUpdatedAt": "abc123",
      "initialStateOfCharge": 987,
      "stateOfChargeLastChanged": "xyz789",
      "sumEnergy": 987.65,
      "updatedAt": "abc123"
    }
  }
}

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": 987.65,
      "energyConsumption": 123.45,
      "number": 123
    }
  }
}

connector

Description

Load a single connector

Response

Returns a Connector

Arguments
Name Description
id - ID!
ignoreMarketingConfiguration - Boolean

Example

Query
query connector(
  $id: ID!,
  $ignoreMarketingConfiguration: Boolean
) {
  connector(
    id: $id,
    ignoreMarketingConfiguration: $ignoreMarketingConfiguration
  ) {
    connectorType {
      ...ConnectorTypeFragment
    }
    cp {
      ...CpFragment
    }
    evseId
    freeOfCharge
    id
    label
    sortOrder
    status {
      ...ConnectorStatusFragment
    }
  }
}
Variables
{
  "id": "4",
  "ignoreMarketingConfiguration": false
}
Response
{
  "data": {
    "connector": {
      "connectorType": ConnectorType,
      "cp": Cp,
      "evseId": "xyz789",
      "freeOfCharge": true,
      "id": "4",
      "label": "xyz789",
      "sortOrder": "xyz789",
      "status": ConnectorStatus
    }
  }
}

connectorByEvseId

Description

Load a single connector by its EVSEID.

Response

Returns a Connector

Arguments
Name Description
evseId - String!
ignoreMarketingConfiguration - Boolean

Example

Query
query connectorByEvseId(
  $evseId: String!,
  $ignoreMarketingConfiguration: Boolean
) {
  connectorByEvseId(
    evseId: $evseId,
    ignoreMarketingConfiguration: $ignoreMarketingConfiguration
  ) {
    connectorType {
      ...ConnectorTypeFragment
    }
    cp {
      ...CpFragment
    }
    evseId
    freeOfCharge
    id
    label
    sortOrder
    status {
      ...ConnectorStatusFragment
    }
  }
}
Variables
{
  "evseId": "abc123",
  "ignoreMarketingConfiguration": false
}
Response
{
  "data": {
    "connectorByEvseId": {
      "connectorType": ConnectorType,
      "cp": Cp,
      "evseId": "abc123",
      "freeOfCharge": true,
      "id": 4,
      "label": "abc123",
      "sortOrder": "xyz789",
      "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
    language
    mobile
    name
    phone
    termsAndConditionsAccepted
    updatedAt
    vat
  }
}
Response
{
  "data": {
    "contact": {
      "address": Address,
      "birthday": "2007-12-03T10:15:30Z",
      "companyId": 123,
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": Currency,
      "displayName": "xyz789",
      "email": "xyz789",
      "firstName": "xyz789",
      "gender": "company",
      "id": "xyz789",
      "isCompany": true,
      "language": "cs_CZ",
      "mobile": "xyz789",
      "name": "xyz789",
      "phone": "abc123",
      "termsAndConditionsAccepted": false,
      "updatedAt": "2007-12-03T10:15:30Z",
      "vat": "abc123"
    }
  }
}

contractPaymentMethods

Response

Returns [ContractPaymentMethod]

Example

Query
query contractPaymentMethods {
  contractPaymentMethods {
    applicationId
    cardCreateMode
    createdAt
    directPaymentMethod
    emp
    paymentName
    paymentType
    termsOfServiceUrl
    termsOfUseUrl
    updatedAt
    uuid
  }
}
Response
{
  "data": {
    "contractPaymentMethods": [
      {
        "applicationId": "abc123",
        "cardCreateMode": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "directPaymentMethod": "abc123",
        "emp": "xyz789",
        "paymentName": "abc123",
        "paymentType": "abc123",
        "termsOfServiceUrl": "xyz789",
        "termsOfUseUrl": "xyz789",
        "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
    shortDescription
    uuid
  }
}
Response
{
  "data": {
    "contractRateOptions": [
      {
        "description": "abc123",
        "id": "xyz789",
        "name": "abc123",
        "shortDescription": "abc123",
        "uuid": "xyz789"
      }
    ]
  }
}

cp

Description

Load a single cp

Response

Returns a Cp

Arguments
Name Description
id - ID!
ignoreMarketingConfiguration - Boolean

Example

Query
query cp(
  $id: ID!,
  $ignoreMarketingConfiguration: Boolean
) {
  cp(
    id: $id,
    ignoreMarketingConfiguration: $ignoreMarketingConfiguration
  ) {
    accessType
    additionalFields {
      ...AdditionalCpFieldFragment
    }
    address
    city
    connectors {
      ...ConnectorFragment
    }
    contact {
      ...ContactInformationFragment
    }
    country
    id
    images {
      ...CpImageFragment
    }
    information {
      ...CpInfoFragment
    }
    isFavoured
    label
    latitude
    longitude
    operator {
      ...CpOperatorFragment
    }
    publicName
    site {
      ...SiteFragment
    }
    siteId
    status {
      ...CpStatusFragment
    }
    zip
  }
}
Variables
{
  "id": "4",
  "ignoreMarketingConfiguration": false
}
Response
{
  "data": {
    "cp": {
      "accessType": "INTERNAL",
      "additionalFields": [AdditionalCpField],
      "address": "abc123",
      "city": "xyz789",
      "connectors": [Connector],
      "contact": ContactInformation,
      "country": "abc123",
      "id": 4,
      "images": [CpImage],
      "information": CpInfo,
      "isFavoured": true,
      "label": "abc123",
      "latitude": 123.45,
      "longitude": 987.65,
      "operator": CpOperator,
      "publicName": "abc123",
      "site": Site,
      "siteId": "abc123",
      "status": CpStatus,
      "zip": "abc123"
    }
  }
}

cpCapabilities

Description

Get the capabilities of an given charging station.

Response

Returns a CpCapabilities!

Arguments
Name Description
id - String! The uuid of the charging station.

Example

Query
query cpCapabilities($id: String!) {
  cpCapabilities(id: $id) {
    hasRemoteCommands
  }
}
Variables
{"id": "abc123"}
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": "xyz789", "day": "ALL"}
Response
{
  "data": {
    "cpOccupancyRate": [
      {
        "day": "xyz789",
        "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
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

Example

Query
query cpsPaged(
  $filter: [ConnectorFilter],
  $freeOfCharge: Boolean,
  $ignoreMarketingConfiguration: Boolean,
  $pagination: PaginationFilter
) {
  cpsPaged(
    filter: $filter,
    freeOfCharge: $freeOfCharge,
    ignoreMarketingConfiguration: $ignoreMarketingConfiguration,
    pagination: $pagination
  ) {
    data {
      ...CpFragment
    }
    pagination {
      ...PaginationFragment
    }
  }
}
Variables
{
  "filter": [ConnectorFilter],
  "freeOfCharge": false,
  "ignoreMarketingConfiguration": true,
  "pagination": PaginationFilter
}
Response
{
  "data": {
    "cpsPaged": {
      "data": [Cp],
      "pagination": Pagination
    }
  }
}

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:

  • by default, when orderedByDistance is not specified
  • when orderedByDistance is "1" The backend will not order by distance only when:
  • when orderedByDistance is "0"
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 {
      ...PaginationFragment
    }
  }
}
Variables
{
  "filter": [ConnectorFilter],
  "freeOfCharge": false,
  "ignoreMarketingConfiguration": true,
  "location": LocationFilter,
  "orderedByDistance": "xyz789",
  "pagination": PaginationFilter
}
Response
{
  "data": {
    "cpsPagedLocationBased": {
      "data": [Cp],
      "pagination": Pagination
    }
  }
}

directPaymentChargingStatus

Response

Returns a DirectPaymentChargingStatus

Arguments
Name Description
evseId - String!
transactionId - String!

Example

Query
query directPaymentChargingStatus(
  $evseId: String!,
  $transactionId: String!
) {
  directPaymentChargingStatus(
    evseId: $evseId,
    transactionId: $transactionId
  ) {
    chargeLogId
    message
    status
  }
}
Variables
{
  "evseId": "abc123",
  "transactionId": "xyz789"
}
Response
{
  "data": {
    "directPaymentChargingStatus": {
      "chargeLogId": "abc123",
      "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
    city
    connectors {
      ...ConnectorFragment
    }
    contact {
      ...ContactInformationFragment
    }
    country
    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",
        "city": "xyz789",
        "connectors": [Connector],
        "contact": ContactInformation,
        "country": "abc123",
        "id": 4,
        "images": [CpImage],
        "information": CpInfo,
        "isFavoured": false,
        "label": "abc123",
        "latitude": 123.45,
        "longitude": 123.45,
        "operator": CpOperator,
        "publicName": "xyz789",
        "site": Site,
        "siteId": "xyz789",
        "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": true}}

occupancyRate

No longer supported
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": ["xyz789"], "day": "ALL"}
Response
{
  "data": {
    "occupancyRate": [
      {
        "day": "xyz789",
        "hour": 987,
        "occupancyRate": 123.45
      }
    ]
  }
}

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": 987,
        "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!
        The id which you will get back after triggering a remoteStartAttempt
                                                  
                                          

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": "xyz789",
      "id": 4,
      "isFailure": true,
      "lastSentAt": "abc123",
      "status": "xyz789"
    }
  }
}

settings

Response

Returns [Setting!]!

Arguments
Name Description
key - String

Example

Query
query settings($key: String) {
  settings(key: $key) {
    key
    value
  }
}
Variables
{"key": "xyz789"}
Response
{
  "data": {
    "settings": [
      {
        "key": "xyz789",
        "value": "abc123"
      }
    ]
  }
}

site

Description

Load a site by id

Response

Returns a Site

Arguments
Name Description
id - String
ignoreMarketingConfiguration - Boolean

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": "abc123",
      "label": "xyz789",
      "latitude": 123.45,
      "longitude": 987.65,
      "scope": "abc123"
    }
  }
}

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": true,
  "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": "abc123",
      "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": "xyz789"
    }
  }
}

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": false,
      "lastSentAt": "abc123",
      "status": "abc123"
    }
  }
}

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": "xyz789",
      "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": "xyz789",
      "status": "xyz789"
    }
  }
}

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": "xyz789",
      "sessionToken": "abc123"
    }
  }
}

initDirectPaymentCharging

Response

Returns an OptileTransaction

Arguments
Name Description
cardId - String
connectorId - String!
rateId - String!
ratePackageId - String

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": "xyz789"
}
Response
{
  "data": {
    "initDirectPaymentCharging": {
      "absoluteLink": "xyz789",
      "id": "xyz789",
      "link": "abc123"
    }
  }
}

initSession

Response

Returns a SessionAuthenticationResponse!

Arguments
Name Description
password - String!
username - String!

Example

Query
mutation initSession(
  $password: String!,
  $username: String!
) {
  initSession(
    password: $password,
    username: $username
  ) {
    refreshToken
    sessionToken
  }
}
Variables
{
  "password": "xyz789",
  "username": "xyz789"
}
Response
{
  "data": {
    "initSession": {
      "refreshToken": "xyz789",
      "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

Arguments
Name Description
customerReference - String
rateId - String!

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": "xyz789",
      "link": "abc123"
    }
  }
}

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": "abc123"
}
Response
{
  "data": {
    "remoteStart": {
      "code": 123,
      "id": "xyz789",
      "message": "xyz789",
      "session": "abc123",
      "status": "xyz789",
      "transaction": "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": "xyz789"
}
Response
{
  "data": {
    "remoteStartWithoutInvoicing": {
      "code": 123,
      "id": "xyz789",
      "message": "xyz789",
      "session": "xyz789",
      "status": "xyz789",
      "transaction": "abc123"
    }
  }
}

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": "abc123",
      "status": "xyz789",
      "title": "abc123"
    }
  }
}

renewSession

Response

Returns a SessionAuthenticationResponse!

Example

Query
mutation renewSession {
  renewSession {
    refreshToken
    sessionToken
  }
}
Response
{
  "data": {
    "renewSession": {
      "refreshToken": "abc123",
      "sessionToken": "abc123"
    }
  }
}

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": "xyz789", "isFavoured": false}
    ]
  }
}

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": ["xyz789"]}
Response
{
  "data": {
    "unsetFavouriteCps": [
      {"id": "xyz789", "isFavoured": false}
    ]
  }
}

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": "xyz789",
      "number": "abc123",
      "status": "xyz789",
      "tagId": "xyz789",
      "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": "xyz789"
    }
  }
}

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

INTERNAL

The station is accessible via the internal infrastructure

ROAMING

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": "xyz789",
  "title": "abc123",
  "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

Fields
Field Name Description
name - String
value - String
Example
{
  "name": "xyz789",
  "value": "xyz789"
}

AdditionalRegistrationField

Description

AdditionalRegistrationField data

Fields
Field Name Description
description - String
name - String
required - String
type - String
value - String
Example
{
  "description": "xyz789",
  "name": "abc123",
  "required": "xyz789",
  "type": "xyz789",
  "value": "xyz789"
}

AdditionalRegistrationFieldInput

Fields
Input Field Description
description - String
name - String!
required - String!
type - String
value - String!
Example
{
  "description": "xyz789",
  "name": "xyz789",
  "required": "abc123",
  "type": "xyz789",
  "value": "abc123"
}

Address

Fields
Field Name Description
city - String
country - CountryAlpha
state - String
street - String
zip - String
Example
{
  "city": "xyz789",
  "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": "xyz789",
  "country": "AC",
  "state": "abc123",
  "street": "abc123",
  "zip": "xyz789"
}

AttemptRemoteStartConfig

Description

Additional configuration options for the remote start attempt.

Fields
Input Field Description
markedAsInvoiced - Boolean
ratePackage - String
stopMinutes - Int
validUntil - String validUntil must be a valid ISO 8601 date string
Example
{
  "markedAsInvoiced": true,
  "ratePackage": "xyz789",
  "stopMinutes": 123,
  "validUntil": "xyz789"
}

AttemptRemoteStartInput

Fields
Input Field Description
config - AttemptRemoteStartConfig Optional configuration parameters.
connectorId - String!
tagId - String!
Example
{
  "config": AttemptRemoteStartConfig,
  "connectorId": "abc123",
  "tagId": "abc123"
}

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": "abc123",
  "connectorId": "xyz789",
  "failureReason": "xyz789",
  "id": 4,
  "isFailure": true,
  "lastSentAt": "abc123",
  "status": "abc123"
}

AuthenticationMediaResponse

Fields
Field Name Description
customerReference - String
id - String
rateId - String
Example
{
  "customerReference": "abc123",
  "id": "abc123",
  "rateId": "xyz789"
}

Authorization

Fields
Input Field Description
identifier - String!
type - AuthorizationType!
Example
{"identifier": "abc123", "type": "AUTO"}

AuthorizationType

Values
Enum Value Description

AUTO

RFID

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

Fields
Field Name Description
accountHolder - String Name of the bank account owner
bank - String Name of the bank institut.
bic - String Business Identifier Code (SWIFT Code).
iban - String International Bank Account Number.
Example
{
  "accountHolder": "xyz789",
  "bank": "abc123",
  "bic": "xyz789",
  "iban": "abc123"
}

Boolean

Description

The Boolean scalar type represents true or false.

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).
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": "abc123",
  "expiryDate": "2007-12-03T10:15:30Z",
  "id": "xyz789",
  "label": "abc123",
  "number": "xyz789",
  "rate": RateOption,
  "status": "active",
  "tagId": "xyz789",
  "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).
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": "xyz789",
  "label": "xyz789",
  "number": "xyz789",
  "rate": RateDescriptionForChargingProcess,
  "tagId": "xyz789",
  "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).
tagId - String! Unique identifier in form of an tag id.
type - CardType Type of the authentication media (card).
Possible Types
CardInterface Types

Card

CardForChargingProcess

Example
{
  "expiryDate": "2007-12-03T10:15:30Z",
  "id": "xyz789",
  "label": "abc123",
  "number": "abc123",
  "tagId": "xyz789",
  "type": "default"
}

CardStatus

Values
Enum Value Description

active

inactive

Example
"active"

CardStatusActionEnum

Description

defined values for card status actions

Values
Enum Value Description

DEACTIVATE

Example
"DEACTIVATE"

CardType

Values
Enum Value Description

default

emsp

roaming

simple

virtual

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": "xyz789",
  "grossAmount": 987.65,
  "grossAmountLocalCurrency": 987.65,
  "netAmount": 987.65,
  "netAmountLocalCurrency": 123.45,
  "taxAmount": 123.45,
  "taxAmountLocalCurrency": 987.65,
  "taxRate": 987.65
}

ChargeLogFilterStatus

Values
Enum Value Description

started

stopped

Example
"started"

ChargeLogType

Description

ToDo Add cp,card ....

Values
Enum Value Description

contact

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": 987.65,
  "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

Fields
Field Name Description
co2Saving - Float The CO2 saving in kg CO2.
energyConsumption - Float The consumed energy in kWh.
number - Int
Example
{"co2Saving": 123.45, "energyConsumption": 987.65, "number": 123}

Connector

Description

Connector information

Fields
Field Name Description
connectorType - ConnectorType
cp - Cp
evseId - String
freeOfCharge - Boolean
id - ID!
label - String
sortOrder - String
status - ConnectorStatus
Example
{
  "connectorType": ConnectorType,
  "cp": Cp,
  "evseId": "xyz789",
  "freeOfCharge": true,
  "id": 4,
  "label": "abc123",
  "sortOrder": "xyz789",
  "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"}

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": "abc123",
  "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": "abc123",
  "maxPowerRating": 987.65,
  "plugType": "xyz789",
  "standard": "xyz789"
}

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
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": "xyz789",
  "gender": "company",
  "id": "abc123",
  "isCompany": true,
  "language": "cs_CZ",
  "mobile": "abc123",
  "name": "abc123",
  "phone": "xyz789",
  "termsAndConditionsAccepted": false,
  "updatedAt": "2007-12-03T10:15:30Z",
  "vat": "abc123"
}

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

Fields
Field Name Description
email - String Email adress
phone - String Phone number
Example
{
  "email": "xyz789",
  "phone": "abc123"
}

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
language - LanguageCode
mobile - String
name - String
phone - String
vat - String
Example
{
  "address": AddressInput,
  "birthday": "2007-12-03T10:15:30Z",
  "companyId": 987,
  "currency": "abc123",
  "email": "abc123",
  "fax": "xyz789",
  "firstName": "abc123",
  "gender": "company",
  "id": "abc123",
  "isCompany": false,
  "language": "cs_CZ",
  "mobile": "abc123",
  "name": "xyz789",
  "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

Fields
Field Name Description
JAVASCRIPT_INTEGRATION - String
PAGE_BUTTON_LOCALE - String
PAGE_ENVIRONMENT - String
Example
{
  "JAVASCRIPT_INTEGRATION": "xyz789",
  "PAGE_BUTTON_LOCALE": "abc123",
  "PAGE_ENVIRONMENT": "abc123"
}

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": "xyz789"
}

ContractErrorResponseStatus

Fields
Field Name Description
message - String
status - String
Example
{
  "message": "xyz789",
  "status": "abc123"
}

ContractPaymentMethod

Description

ContractPaymentMethods data

Fields
Field Name Description
applicationId - String
cardCreateMode - String
createdAt - DateTime
directPaymentMethod - String
emp - String
paymentName - String
paymentType - String
termsOfServiceUrl - String
termsOfUseUrl - String
updatedAt - DateTime
uuid - String!
Example
{
  "applicationId": "xyz789",
  "cardCreateMode": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "directPaymentMethod": "abc123",
  "emp": "abc123",
  "paymentName": "xyz789",
  "paymentType": "xyz789",
  "termsOfServiceUrl": "xyz789",
  "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": "xyz789",
  "status": "xyz789"
}

ContractSepaResponse

Fields
Field Name Description
error - ContractErrorBody
message - String
status - String
Example
{
  "error": ContractErrorBody,
  "message": "abc123",
  "status": "xyz789"
}

Cost

Fields
Field Name Description
costItems - [CdrCostItem]
currency - String
grossAmount - Float
grossAmountLocalCurrency - Float
tax - Float No longer supported
taxAmount - Float No longer supported
total - Float
Example
{
  "costItems": [CdrCostItem],
  "currency": "xyz789",
  "grossAmount": 123.45,
  "grossAmountLocalCurrency": 123.45,
  "tax": 987.65,
  "taxAmount": 987.65,
  "total": 987.65
}

CountryAlpha

Values
Enum Value Description

AC

AD

AE

AF

AG

AI

AL

AM

AN

AO

AQ

AR

AS

AT

AU

AW

AX

AZ

BA

BB

BD

BE

BF

BG

BH

BI

BJ

BM

BN

BO

BR

BS

BT

BV

BW

BY

BZ

CA

CC

CD

CF

CG

CH

CI

CK

CL

CM

CN

CO

CR

CS

CU

CV

CX

CY

CZ

DE

DG

DJ

DK

DM

DO

DZ

EC

EE

EG

EH

ER

ES

ET

EU

FI

FJ

FK

FM

FO

FR

GA

GB

GD

GE

GF

GG

GH

GI

GL

GM

GN

GP

GQ

GR

GS

GT

GU

GW

GY

HK

HM

HN

HR

HT

HU

IC

ID

IE

IL

IM

IN

IO

IQ

IR

IS

IT

JE

JM

JO

JP

KE

KG

KH

KI

KM

KN

KP

KR

KW

KY

KZ

LA

LB

LC

LI

LK

LR

LS

LT

LU

LV

LY

MA

MC

MD

ME

MG

MH

MK

ML

MM

MN

MO

MP

MQ

MR

MS

MT

MU

MV

MW

MX

MY

MZ

NA

NC

NE

NF

NG

NI

NL

NO

NP

NR

NT

NU

NZ

OM

PA

PE

PF

PG

PH

PK

PL

PM

PN

PR

PS

PT

PW

PY

QA

RE

RO

RU

RW

SA

SB

SC

SD

SE

SG

SH

SI

SJ

SK

SL

SM

SN

SO

SR

ST

SU

SV

SY

SZ

TA

TC

TD

TF

TG

TH

TJ

TK

TL

TM

TN

TO

TR

TT

TV

TW

TZ

UA

UG

US

UY

UZ

VA

VC

VE

VG

VI

VN

VU

WF

WS

YE

YT

ZA

ZM

ZW

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)
city - String City
connectors - [Connector] List of connectors.
contact - ContactInformation Contact information
country - String Country (3 characters)
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": "xyz789",
  "city": "abc123",
  "connectors": [Connector],
  "contact": ContactInformation,
  "country": "abc123",
  "id": "4",
  "images": [CpImage],
  "information": CpInfo,
  "isFavoured": true,
  "label": "abc123",
  "latitude": 987.65,
  "longitude": 987.65,
  "operator": CpOperator,
  "publicName": "xyz789",
  "site": Site,
  "siteId": "abc123",
  "status": CpStatus,
  "zip": "xyz789"
}

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": true}

CpFavouredStatus

Fields
Field Name Description
id - String
isFavoured - Boolean
Example
{"id": "xyz789", "isFavoured": true}

CpImage

Fields
Field Name Description
url - String Url of a cp image
Example
{"url": "xyz789"}

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
payment - String Payment information
Example
{
  "additional": "xyz789",
  "marketingDisplay": "xyz789",
  "openingTimes": OpeningTimes,
  "payment": "abc123"
}

CpOperator

Description

The operator ot the corresponding charging station.

Fields
Field Name Description
identifier - String! The identifier of the operator
name - String! The name of the operator
Example
{
  "identifier": "abc123",
  "name": "abc123"
}

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": "xyz789",
  "simple": "Available"
}

CpsPaged

Description

CpsPaged contains information about the used pagination and paginated cps

Fields
Field Name Description
data - [Cp]
pagination - Pagination
Example
{
  "data": [Cp],
  "pagination": Pagination
}

Currency

Fields
Field Name Description
isoCode - String
Example
{"isoCode": "abc123"}

DateTime

Example
"2007-12-03T10:15:30Z"

DirectPaymentChargingStatus

Fields
Field Name Description
chargeLogId - String
message - String
status - String
Example
{
  "chargeLogId": "abc123",
  "message": "abc123",
  "status": "abc123"
}

ErrorBody

Fields
Field Name Description
code - String
response - LoginErrorResponse
Example
{
  "code": "abc123",
  "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

FILTER_BY_CONNECTOR_TYPE

the type of the connector (e.g. Type 2)

POWER_CLASS

the power class of the connector (e.g. < 50kW)

TYPE_OF_CURRENT

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
987.65

Gender

Values
Enum Value Description

company

diverse

female

male

Example
"company"

HostedPaymentMethodGetSession

Fields
Field Name Description
link - String
sessionId - String
Example
{
  "link": "xyz789",
  "sessionId": "xyz789"
}

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
987

LanguageCode

Description

All languages supported by the API

Values
Enum Value Description

cs_CZ

Czech

da_DK

Danish

de_DE

German

el_GR

Greek

en_US

English

es_ES

Spanish

et_EE

Estonian

fi_FI

Finnish

fr_FR

French

hr_HR

Croatian

hu_HU

Hungarian

it_IT

Italian

ja_JP

Japanese

lt_LT

Lithuanian

lv_LV

Latvian

nl_NL

Dutch

no_NO

Norwegian

pl_PL

Polish

ro_RO

Romanian

ru_RU

Russian

sk_SK

Slovak

sl_SI

Slovenian

sv_SE

Swedish

uk_UA

Ukrainian
Example
"cs_CZ"

LegalDocument

Fields
Field Name Description
id - String! The id of the document in the form of an uuid.
url - String! URL to the terms and condition in PDF format.
version - String!
Example
{
  "id": "abc123",
  "url": "xyz789",
  "version": "xyz789"
}

LocationFilter

Description

Location information for pagination

Fields
Input Field Description
latitude - Float!
longitude - Float!
radius - Float!
Example
{"latitude": 123.45, "longitude": 123.45, "radius": 987.65}

LoginErrorResponse

Fields
Field Name Description
body - LoginErrorResponseStatus
status - Int
statusText - String
Example
{
  "body": LoginErrorResponseStatus,
  "status": 987,
  "statusText": "abc123"
}

LoginErrorResponseStatus

Fields
Field Name Description
message - String
status - String
Example
{
  "message": "abc123",
  "status": "abc123"
}

MaskedAccount

Description

detailed information about the payment method to display to the user

Fields
Field Name Description
displayLabel - String!
expiryMonth - Int!
expiryYear - Int!
holderName - String!
number - String!
Example
{
  "displayLabel": "xyz789",
  "expiryMonth": 987,
  "expiryYear": 987,
  "holderName": "xyz789",
  "number": "xyz789"
}

NativePaymentMethodGetSession

Fields
Field Name Description
applicablePaymentMethods - [PaymentMethod]
registeredPaymentsMethods - [PaymentMethod]
sessionId - String
Example
{
  "applicablePaymentMethods": [PaymentMethod],
  "registeredPaymentsMethods": [PaymentMethod],
  "sessionId": "xyz789"
}

OccupancyDays

Values
Enum Value Description

ALL

FRIDAY

MONDAY

SATURDAY

SUNDAY

THURSDAY

TUESDAY

WEDNESDAY

Example
"ALL"

OccupancyRate

Fields
Field Name Description
day - String!
hour - Int!
occupancyRate - Float!
Example
{
  "day": "abc123",
  "hour": 123,
  "occupancyRate": 987.65
}

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.

Fields
Field Name Description
begin - String Begin of the period
end - String End of the period
Example
{
  "begin": "xyz789",
  "end": "xyz789"
}

OperatingTime

Description

OperatingTimes have the format 'yyyy-mm-ddThh:mm:ss.sssZ' according to ISO-8601.

Fields
Field Name Description
begin - DateTime Begin of the period
end - DateTime End of the period
Example
{
  "begin": "2007-12-03T10:15:30Z",
  "end": "2007-12-03T10:15:30Z"
}

OperationType

Values
Enum Value Description

CHARGE

PAYOUT

PRESET

SAVE

TOKENIZE

UPDATE

Example
"CHARGE"

OptileTransaction

Fields
Field Name Description
absoluteLink - String!
id - String
link - String
Example
{
  "absoluteLink": "xyz789",
  "id": "abc123",
  "link": "abc123"
}

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": false, "limit": 987, "offset": 987, "totalCount": 987}

PaginationFilter

Description

Filter to do pagination requests

Fields
Input Field Description
limit - Int

Maximum number of elements (limit) set for this pagination request

Limit for one page. Will be overruled from the api if too high.

offset - Int Page offset of this pagination filter
Example
{"limit": 987, "offset": 123}

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": "abc123",
  "code": "abc123",
  "contractData": ContractData,
  "deferral": "abc123",
  "grouping": "xyz789",
  "iFrameHeight": 987,
  "label": "xyz789",
  "links": PaymentLink,
  "maskedAccount": MaskedAccount,
  "method": "xyz789",
  "operationType": "CHARGE",
  "recurrence": "abc123",
  "redirect": false,
  "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.
shortDescription - String Short description of the rate.
Example
{
  "description": "abc123",
  "shortDescription": "abc123"
}

RateOption

Fields
Field Name Description
description - String
id - String!
name - String
shortDescription - String
uuid - String No longer supported
Example
{
  "description": "xyz789",
  "id": "abc123",
  "name": "abc123",
  "shortDescription": "abc123",
  "uuid": "abc123"
}

RatePackage

Fields
Field Name Description
amount - Float
automaticStop - Int
id - String
rate - RateOption
visibleRuntime - Int
Example
{
  "amount": 123.45,
  "automaticStop": 123,
  "id": "abc123",
  "rate": RateOption,
  "visibleRuntime": 987
}

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
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": "abc123",
  "fax": "xyz789",
  "firstName": "abc123",
  "gender": "company",
  "isCompany": true,
  "language": "cs_CZ",
  "mobile": "abc123",
  "name": "abc123",
  "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 (1 as Monday and 7 as Sunday)
Example
{"operatingHours": OperatingHours, "weekday": 123}

RemoteStartResponse

Description

Response of a remote start

Fields
Field Name Description
code - Int
id - String
message - String
session - String
status - String
transaction - String
Example
{
  "code": 987,
  "id": "xyz789",
  "message": "abc123",
  "session": "xyz789",
  "status": "xyz789",
  "transaction": "xyz789"
}

RemoteStopResponse

Description

Response of a remote stop

Fields
Field Name Description
code - Int
message - String
status - String
title - String
Example
{
  "code": 987,
  "message": "abc123",
  "status": "xyz789",
  "title": "abc123"
}

SessionAuthenticationResponse

Fields
Field Name Description
refreshToken - String
sessionToken - String
Example
{
  "refreshToken": "xyz789",
  "sessionToken": "xyz789"
}

Setting

Fields
Field Name Description
key - String! Unique identifier in form of an tag id.
value - String! Number of the authentication media (card).
Example
{
  "key": "abc123",
  "value": "xyz789"
}

SimpleConnectorStatus

Description

Set of simple statuses which a charging connector can have

Values
Enum Value Description

Available

Faulted

Occupied

Unavailable

Example
"Available"

SimpleCpStatus

Description

Set of simple statuses which a charging station can have

Values
Enum Value Description

Available

Occupied

Unavailable

Example
"Available"

Site

Fields
Field Name Description
company - String
cps - [Cp]
id - String The id is the uuid of the site
label - String
latitude - Float
longitude - Float
scope - String
Example
{
  "company": "abc123",
  "cps": [Cp],
  "id": "abc123",
  "label": "abc123",
  "latitude": 123.45,
  "longitude": 987.65,
  "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
"xyz789"

TermsAndConditionsStatus

Fields
Field Name Description
message - String! A description of what happend.
status - String! The status if the acceptance was successful or not.
Example
{
  "message": "abc123",
  "status": "xyz789"
}

TimeFrameFilter

Fields
Input Field Description
end - DateTime
start - DateTime
Example
{
  "end": "2007-12-03T10:15:30Z",
  "start": "2007-12-03T10:15:30Z"
}

UpdateCardInput

Fields
Input Field Description
cardId - String!
label - String
status - CardStatusActionEnum
Example
{
  "cardId": "abc123",
  "label": "abc123",
  "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": "abc123",
  "id": "4",
  "label": "abc123",
  "message": "xyz789",
  "number": "abc123",
  "status": "abc123",
  "tagId": "abc123",
  "type": "abc123"
}

UserLoginAuthenticationResponse

Fields
Field Name Description
error - ErrorBody
refreshToken - String
sessionToken - String
Example
{
  "error": ErrorBody,
  "refreshToken": "abc123",
  "sessionToken": "xyz789"
}

accountDocumentType

Values
Enum Value Description

creditnote

delivery

invoice

offer

order

purchase

Example
"creditnote"

authenticationMediaContract

Fields
Input Field Description
customerReference - String! A text field for the user to name his authentication media individually.
rateId - String! The id of the rate which will be assigned to the authentication media.
Example
{
  "customerReference": "abc123",
  "rateId": "abc123"
}

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": 123,
  "currentPowerLastChanged": "abc123",
  "currentStateOfCharge": 987,
  "energyFirstValue": 123.45,
  "energyFirstValueTime": "abc123",
  "energyLastValue": 123.45,
  "energyLastValueTime": "xyz789",
  "energyUpdatedAt": "xyz789",
  "initialStateOfCharge": 123,
  "stateOfChargeLastChanged": "abc123",
  "sumEnergy": 123.45,
  "updatedAt": "xyz789"
}

creatingPostpaidContract

Fields
Input Field Description
customerReference - String A text field for the customer to name his card individually.
id - String! Id of a registered contract option.
rateId - String! RateId
Example
{
  "customerReference": "xyz789",
  "id": "abc123",
  "rateId": "xyz789"
}

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": "abc123",
  "iban": "xyz789",
  "id": "abc123",
  "rateId": "abc123",
  "useParent": false
}

updatePostpaidContract

Fields
Input Field Description
customerReference - String! Customer Reference also known as Description
id - String! Id of a registered contract option.
Example
{
  "customerReference": "xyz789",
  "id": "xyz789"
}

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": "abc123",
  "bank": "abc123",
  "bic": "xyz789",
  "customerReference": "xyz789",
  "iban": "xyz789",
  "id": "abc123"
}