Skip to main content

Get Charge Detail Records​

x-ms-visibility: "important"

Retrieves all Charge Detail Records (CDRs).

Query Parameters
    page int32

    Page to be fetched. Default: 1

    limit int32

    Limit (No. of records per page). Max value: 100. Default: 100.

    from date-time

    Start timestamp for the period to be fetched. Default: 7 days ago.

    to date-time

    End timestamp for the period to be fetched. Default: Now.

    sessionIds string[]

    Filter by specific session IDs. Comma-separated list of session IDs.

    integrationIds string[]

    Filter by specific integration IDs. Comma-separated list of integration IDs.

    chargerIds string[]

    Filter by specific charger IDs. Comma-separated list of charger IDs.

    socketIds int64[]

    Filter by specific socket IDs. Comma-separated list of socket IDs.

    statuses string[]

    Filter by specific statuses. Comma-separated list of statuses.

    search string

    Free text filter for integration name and other details.

    sortKey string

    Field to be used for sorting. Default: integrationName

    sortDescending boolean

    Set to 'true' to sort descending based on sort key. Default: 'false'

Responses

Charge Detail Records successfully retrieved.

Schema
    page int32
    limit int32
    totalRecords int32
    hasNextPage boolean
    hasPreviousPage boolean
    items object[]
  • Array [
    • sessionId string
    transactionId string
    status string
    integrationId string
    startDateTime date-time
    endDateTime date-time
    lastUpdated date-time
    consumptionKWH double
    chargerId string
    chargerName string
    evseUid string
    evseId string
    socketId int32 nullable
    socketName string
    address string
    city string
    country string
    postalCode string
    cdrTokenUid string
    cdrTokenType string nullable

    Possible values: [AD_HOC_USER, APP_USER, OTHER, RFID]

    Default value: AD_HOC_USER

    contractId string
    authorizationReference string
    totalCostInclVat double nullable
    totalCostExclVat double nullable
    totalFixedCostInclVat double nullable
    totalFixedCostExclVat double nullable
    totalEnergyCostInclVat double nullable
    totalEnergyCostExclVat double nullable
    totalTimeCostInclVat double nullable
    totalTimeCostExclVat double nullable
    totalParkingTimeCostInclVat double nullable
    totalParkingTimeCostExclVat double nullable
    totalTime string
    serviceProviderId string
    infraProviderId string
    tariffs object[]
  • Array [
    • externalId string
    type string nullable

    Possible values: [AD_HOC_PAYMENT, PROFILE_CHEAP, PROFILE_FAST, PROFILE_GREEN, REGULAR]

    Default value: AD_HOC_PAYMENT

    currency string
  • ]
  • ]
Loading...