Skip to main content
OCPI

Fetch CDRs from the CPO’s system.​

Fetch CDRs from the CPO’s system.

Query Parameters
    date_from date-time

    Only return objects that have last_updated after or equal to this Date/Time (inclusive).

    date_to date-time

    Only return objects that have last_updated up to this Date/Time, but not including (exclusive).

    offset string

    The offset of the first object returned. Default is 0 (the first object).

    limit string

    The maximum number of objects to GET.

Header Parameters
    Authorization string required

    Token Base64encodedtoken

    X-Request-ID string required

    Unique request ID

    X-Correlation-ID string required

    Unique correlation ID

Responses

The OK response

Response Headers
  • X-Limit any

    The maximum number of objects that the server can return.

  • X-Total-Count any

    The total number of objects available in the server system that match the given parameters.

  • Link any

    Link to the next page if exists.

Schema
    data object[]
  • Array [
    • partyId string
    countryCode string
    id string
    startDateTime date-time nullable
    endDateTime date-time nullable
    sessionId string
    cdrToken object
    uid string
    type int32

    Possible values: [0, 1, 2, 3]

    Default value: 0

    contractId string
    authMethod int32 nullable

    Possible values: [0, 1, 2]

    Default value: 0

    authorizationReference string
    cdrLocation object
    id string
    name string
    parkingType int32 nullable

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7]

    Default value: 0

    address string
    city string
    postalCode string
    country string
    coordinates object
    latitude string
    longitude string
    evseUid string
    evseId string
    connectorId string
    connectorStandard string
    connectorFormat int32 nullable

    Possible values: [0, 1]

    Default value: 0

    connectorPowerType int32 nullable

    Possible values: [0, 1, 2]

    Default value: 0

    locationLastUpdated date-time nullable
    chargerLastUpdated date-time nullable
    connectorLastUpdated date-time nullable
    meterId string
    currency string
    tariffs object[]
  • Array [
    • id string
    countryCode string
    partyId string
    currency string
    type int32 nullable

    Possible values: [0, 1, 2, 3, 4]

    Default value: 0

    tariffAltText object[]
  • Array [
    • language string
    text string
  • ]
    • tariffAltUrl uri
    minPrice object
    exclVat float
    inclVat float nullable
    maxPrice object
    exclVat float
    inclVat float nullable
    elements object[]
  • Array [
    • priceComponents object[]
  • Array [
    • type int32

    Possible values: [0, 1, 2, 3]

    Default value: 0

    price float
    vat float nullable
    stepSize int32
  • ]
    • restrictions object
    startTime string
    endTime string
    startDate string
    endDate string
    minKwh double nullable
    maxKwh double nullable
    minCurrent double nullable
    maxCurrent double nullable
    minPower double nullable
    maxPower double nullable
    minDuration int32 nullable
    maxDuration int32 nullable
    dayOfWeek int32[]

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    reservation int32 nullable

    Possible values: [0, 1]

    Default value: 0

  • ]
    • startDateTime date-time nullable
    endDateTime date-time nullable
    energyMix object
    isGreenEnergy boolean
    energySources object[]
  • Array [
    • source int32

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7]

    Default value: 0

    percentage float
  • ]
    • environImpact object[]
  • Array [
    • category int32

    Possible values: [0, 1]

    Default value: 0

    amount float
  • ]
    • supplierName string
    energyProductName string
    lastUpdated date-time nullable
  • ]
    • chargingPeriods object[]
  • Array [
    • startDateTime date-time
    dimensions object[]
  • Array [
    • type int32

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]

    Default value: 0

    volume float
  • ]
    • tariffId string
  • ]
    • signedData object
    encodingMethod string
    encodingMethodVersion int32 nullable
    publicKey string
    signedValues object[]
  • Array [
    • nature string
    plainData string
    signedData string
  • ]
    • url uri
    totalCost object
    exclVat float
    inclVat float nullable
    totalFixedCost object
    exclVat float
    inclVat float nullable
    totalEnergy double nullable
    totalEnergyCost object
    exclVat float
    inclVat float nullable
    totalTime double nullable
    totalTimeCost object
    exclVat float
    inclVat float nullable
    totalParkingTime double nullable
    totalParkingCost object
    exclVat float
    inclVat float nullable
    totalReservationCost object
    exclVat float
    inclVat float nullable
    remark string
    invoiceReferenceId string
    credit boolean nullable
    creditReferenceId string
    lastUpdated date-time
  • ]
    • statusCode int32
    statusMessage string
    timestamp date-time
Loading...