Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Charges

Retrieve a list of charges

Required scope: charge-transactions:read </br>Organization authorization: supported</br></br>Pagination Limit: A maximum of 20,000 charges can be retrieved. To retrieve more data, use more specific filters, like date range filters such as fromDate, toDate, fromUpdatedDate, fromCompletedDate, or toCompletedDate.

get/api/v1/charges

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

number of items per page (between 1 and 100, default 10)

teamIdinteger nullable

Filter to retrieve charges with specified teamId</br>Note: Depending on the operatorRole the teamId will filter differently:</br>operatorRole = owner: will filter charges from charge points that are owned by the team</br>operatorRole = payer: will filter charges paid by team

Example:13
operatorIdinteger nullable

Filter to retrieve charges with specified operatorId</br>*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.</br>Note: When not provided and operatorRole = payer the default operator will be used for the given consumer, if the default operator cannot be assigned the request will be rejected

Example:96
chargePointIdinteger nullable

Filter to retrieve charges with specified chargePointId

Example:10
siteIdinteger nullable

Filter to retrieve charges with specified siteId

Example:5
state'reserved' | 'starting' | 'charging' | 'stopping' | 'paused' | 'suspended_ev' | 'suspended_evse' | 'scheduled' | 'stopped' | 'completed' nullable

Filter to retrieve charges by state

Example:charging
fromDatestring date-time nullable

Filter to retrieve charges where createdAt >= fromDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example:2022-05-22T09:30:03Z
toDatestring date-time nullable

Filter to retrieve charges where createdAt <= toDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example:2022-05-22T09:30:03Z
fromUpdatedDatestring date-time nullable

Filter to retrieve charges where updatedAt >= fromUpdatedDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example:2025-05-01T09:30:03Z
fromCompletedDatestring date-time nullable

Filter to retrieve charges where completedAt >= fromCompletedDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example:2025-05-19T09:30:03Z
toCompletedDatestring date-time nullable

Filter to retrieve charges where completedAt <= toCompletedDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example:2025-05-19T09:30:03Z
chargeAuthType'rfid' | 'vehicleId'
chargeAuthIdstring nullable

Filter to retrieve charges by the charge authentication id, must be combined with chargeAuthType</br>Note: for type vehicleId chargeAuthId must not include the VID: prefix

Example:38C58DB85XXX
partnerExternalIdstring nullable

Filter charges by partnerExternalId, to filter only resources without partnerExternalId use partnerExternalId=""

Example:10001
operatorRole'owner' | 'payer'

Enumerate the possible filters for operator role

Response

List of charges that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "user": {
        "id": 10,
        "displayName": "John Doe"
      },
      "teamMember": {
        "id": 1,
        "teamId": 42,
        "displayName": "Casper Rasmussen",
        "partnerExternalId": "ACME-12345",
        "userId": 1
      },
      "chargePointId": 21,
      "publicChargePoint": {
        "id": 1,
        "evseId": "DK*MON*E2",
        "name": "Monta CPH HQ",
        "chargePointOperatorId": 10200,
        "chargePointOperatorName": "Monta",
        "location": {
          "coordinates": {
            "latitude": 55.6760968,
            "longitude": 12.5683371
          },
          "addressLabel": "Strandboulevarden 122, 5. sal, 2100 København, Denmark",
          "address": {
            "address1": "Strandboulevarden 122",
            "address2": "København",
            "address3": "5. sal",
            "zip": "2100",
            "city": "Copenhagen",
            "province": "Lombardy",
            "country": "Denmark",
            "countryAreaId": 1
          }
        },
        "maxKw": 150,
        "chargePointModelId": 42,
        "brandName": "Easee",
        "modelName": "Easee - Home",
        "deletedAt": "2022-05-12T16:56:45.99Z"
      },
      "sponsoredChargePointId": 29,
      "priceGroupId": 21,
      "costPriceGroupId": 21,
      "memberCostPriceGroupId": 21,
      "siteId": 21,
      "promotionCodeId": 21,
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z",
      "cablePluggedInAt": "2022-05-12T15:56:45.99Z",
      "startedAt": "2022-05-12T15:56:45.99Z",
      "stoppedAt": "2022-05-12T15:56:45.99Z",
      "fullyChargedAt": "2022-05-12T15:56:45.99Z",
      "releasedAt": "2022-05-12T15:56:45.99Z",
      "failedAt": "2022-05-12T15:56:45.91Z",
      "timeoutAt": "2022-05-12T15:56:45.91Z",
      "completedAt": "2022-05-12T16:56:45.99Z",
      "state": "charging",
      "rawState": "charging",
      "startSource": "app-ios",
      "consumedKwh": 20.4,
      "kwhLimit": 21,
      "kwhPerHour": [
        {
          "time": "2022-05-12T15:00:00Z",
          "value": 15.8
        }
      ],
      "kwhPerMaxResolution": [
        {
          "time": "2022-05-12T15:00:00Z",
          "value": 15.8
        }
      ],
      "costBreakdown": [
        {
          "time": "2022-05-12T15:00:00Z",
          "value": 15.8
        }
      ],
      "priceBreakdown": [
        {
          "time": "2022-05-12T15:00:00Z",
          "value": 15.8
        }
      ],
      "startMeterKwh": 123.45,
      "endMeterKwh": 163.85,
      "price": 122.4,
      "priceLimit": 212,
      "cost": 120,
      "averagePricePerKwh": 6,
      "averageCo2PerKwh": 100,
      "averageRenewablePerKwh": 72.5,
      "failureReason": "Some reason why we couldn't charge.",
      "stopReason": "Some reason why the charge stopped.",
      "paymentMethod": "free",
      "note": "Lorem Ipsum",
      "currency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "payingTeam": {
        "id": 14,
        "publicName": "Monta HQ",
        "operatorId": 42
      },
      "sponsorTeam": {
        "id": 14,
        "publicName": "Monta HQ"
      },
      "operator": {
        "id": 14,
        "name": "Monta",
        "identifier": "monta",
        "partnerId": 1,
        "vatNumber": "FOO-123-ABC"
      },
      "chargeAuth": {
        "type": "vehicleId",
        "id": "2C:54:91:88:C9:E3",
        "partnerExternalId": "ACME-12345"
      },
      "soc": {
        "percentage": 42.2,
        "source": "vehicle"
      },
      "socStart": 22.5,
      "socLimit": 80,
      "genericPaymentSession": {
        "provider": "logos",
        "externalId": "76BB1FCF-946D-4040-A8F7-8FD6ECDEE5B1\n",
        "partnerExternalId": "ACME-12345",
        "cardBrand": "VISA",
        "cardLast4": "1234",
        "amount": 1234
      },
      "partnerExternalId": "ACME-12345",
      "smartChargeId": 1,
      "signedData": {
        "certificate": "3059301306072A8648CE3D020106082A8648CE3D030107034200043235EDF0992C1E5719CD4598A3DD77360C2B027BC397FE9D17BB55A35EF4320FA360EF23DCA7EA4D2EA33673F8EFA2E0455922CBFE8461E0BF78B628251DD229",
        "startMeter": "1b1b1b1b1101010176050100001e6200620072630101760107313233343536053135311d0b0901454d4800009192eb0101639d3f0076050000001f620062007263070177010b0901454d4800009192eb078180817103ff7262016507245dc37477078182815401ff01726203736567810b16530000530000010181040202080a30344532363039414543373138300177070100011100ff64000008726203736567810b17530000530000621e52ff56001ff1d6ba017707810060780001010101017262017262016507245d920177078180817101ff0101010165000015850183041fc5588bc9f8552eb954b8355b3146fa41b4ee668f3626121b5fcf16ba2bc0925b9a9b7171cdb0ed238cc359241ab264763f0163a37b00760500000020620062007263020171016391ha001b1b1b1b1a004783",
        "endMeter": "1b1b1b1b0101010176050100001e6200620072930101760107313233343536053135311d0b0901454d4800009192eb0101639d3f0076050000001f620062007263070177010b0901454d4800009192eb078180817103ff72620165072496a37477078182815401ff01726203736567810b16530000530000010181040202080a30344532363039414543373138300177070100011100ff64000008726203736567814402530000530000621e52ff56001ff698eb01770781006008000101010101726201726201650724967d0177078180817101ff01010101650000158601830439d712c6f5eccda6a98gd4fecf2a69eceb31d822472fad7e145f0f63fbde7349f49034a2cc817a664e05e3b41eff59fc763f016326bb08760500000020620062007263020171016391fa001b1b1b1b1a001757"
      },
      "protocolData": {
        "oicp": {
          "sessionId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "ocpi": {
          "cdrId": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    }
  ]
}