OCPI 2.3.0 - CDRs Module - Sender Interface (2.3.0)

OCPI status code, 1000 for success.

An optional status message which may help when debugging.

The time this message was generated.

ISO-3166 alpha-2 country code of the MSP that 'owns' this Token.

ID of the eMSP that 'owns' this Token (following the ISO-15118 standard).

Unique ID by which this Token can be identified. This is the field used by the CPO's system (RFID reader on the Charge Point) to identify this token. Currently, in most cases: type=RFID, this is the RFID hidden ID as read by the RFID reader, but that is not a requirement. If this is a type=APP_USER Token, it will be a unique, by the eMSP, generated ID.

Type of the token

Latitude of the point in decimal degree. Example 50.770774. Decimal separator "." required.

Uniquely identifies the location within the CPO's platform (and suboperator platforms). This field can never be changed, modified or renamed.

Display name of the location.

Street/block name and house number if available.

City or town.

Postal code of the location, may only be omitted when the location has no postal code: in some countries charging locations at highways don't have postal codes.

State only to be used when relevant.

ISO 3166-1 alpha-3 code for the country of this location.

Coordinates of the location.

Uniquely identifies the EVSE within the CPO's platform (and suboperator platforms). For example a database unique ID or the actual EVSE ID. This field can never be changed, modified or renamed. This is the technical identification of the EVSE, not to be used as human readable identification, use the field: evse_id for that. Allowed to be set to: #NA when this CDR is created for a reservation that never resulted in a charging session.

Compliant with the following specification for EVSE ID: "E-mobility ID-codes: the purpose of IDs, ID usage and ID format" (https://evroaming.org/contract-evse-ids/). Allowed to be set to: #NA when this CDR is created for a reservation that never resulted in a charging session.

Identifier of the connector within the EVSE. Allowed to be set to: #NA when this CDR is created for a reservation that never resulted in a charging session.

The standard of the installed connector. When this CDR is created for a reservation that never resulted in a charging session, this field can be set to any value and should be ignored by the Receiver.

The format (socket/cable) of the installed connector. When this CDR is created for a reservation that never resulted in a charging session, this field can be set to any value and should be ignored by the Receiver.

Language Code ISO 639-1.

Maximum or minimum cost excluding taxes.

The dimension that is being priced.

Price per unit for this dimension. This is including or excluding taxes according to the tax_included field of the Tariff that this PriceComponent is contained in.

Applicable VAT percentage for this tariff dimension. If omitted, no VAT is applicable.

Start time of day in local time, the time zone is defined in the time_zone field of the Location, for example 13:30, valid from this time of the day. Must be in 24h format with leading zeros. Hour/Minute separator ":".

End time of day in local time, the time zone is defined in the time_zone field of the Location, for example 19:45, valid until this time of the day. Same syntax as start_time. If end_time < start_time then the period wraps around to the next day. To stop at end of the day use 00:00.

Start date in local time, the time zone is defined in the time_zone field of the Location, for example 2015-12-24, valid from this day (inclusive). Format YYYY-MM-DD.

End date in local time, the time zone is defined in the time_zone field of the Location, for example 2015-12-27, valid until this day (exclusive). Format YYYY-MM-DD.

Minimum consumed energy in kWh, for example 20, valid from this amount of energy (inclusive) being used.

Maximum consumed energy in kWh, for example 50, valid until this amount of energy (exclusive) being used.

Sum of the minimum current (in Amperes) over all phases, for example 5. When the EV is charging with more than, or equal to, the defined amount of current, this TariffElement is/becomes active. If the charging current is or becomes lower, this TariffElement is not or no longer valid and becomes inactive. This describes NOT the minimum current over the entire Charging Session. This restriction can make a TariffElement become active when the charging current is above the defined value, but the TariffElement MUST no longer be active when the charging current drops below the defined value.

Sum of the maximum current (in Amperes) over all phases, for example 20. When the EV is charging with less than the defined amount of current, this TariffElement becomes/is active. If the charging current is or becomes higher, this TariffElement is not or no longer valid and becomes inactive. This describes NOT the maximum current over the entire Charging Session. This restriction can make a TariffElement become active when the charging current is below this value, but the TariffElement MUST no longer be active when the charging current raises above the defined value.

Minimum power in kW, for example 5. When the EV is charging with more than, or equal to, the defined amount of power, this TariffElement is/becomes active. If the charging power is or becomes lower, this TariffElement is not or no longer valid and becomes inactive. This describes NOT the minimum power over the entire Charging Session. This restriction can make a TariffElement become active when the charging power is above this value, but the TariffElement MUST no longer be active when the charging power drops below the defined value.

Maximum power in kW, for example 20. When the EV is charging with less than the defined amount of power, this TariffElement becomes/is active. If the charging power is or becomes higher, this TariffElement is not or no longer valid and becomes inactive. This describes NOT the maximum power over the entire Charging Session. This restriction can make a TariffElement become active when the charging power is below this value, but the TariffElement MUST no longer be active when the charging power raises above the defined value.

Minimum duration in seconds the Charging Session MUST last (inclusive). When the duration of a Charging Session is longer than the defined value, this TariffElement is or becomes active. Before that moment, this TariffElement is not yet active.

Maximum duration in seconds the Charging Session MUST last (exclusive). When the duration of a Charging Session is shorter than the defined value, this TariffElement is or becomes active. After that moment, this TariffElement is no longer active.

Which day(s) of the week this TariffElement is active.

When this field is present, the TariffElement describes reservation costs. A reservation starts when the reservation is made, and ends when the driver starts charging on the reserved EVSE/Location, or when the reservation expires. A reservation can only have FLAT and TIME TariffDimensions, where TIME is for the duration of the reservation.

List of Price Components that each describe how a certain dimension is priced.

The type of energy source.

The environmental impact category of this value.

True if 100% from regenerative sources. (CO2 and nuclear waste is zero)

Key-value pairs (enum + percentage) of energy sources of this location's tariff.

Key-value pairs (enum + percentage) of nuclear waste and CO2 exhaust of this location's tariff.

Name of the energy supplier, delivering the energy for this location or tariff.

ISO-3166 alpha-2 country code of the CPO that 'owns' this Tariff.

ID of the CPO that 'owns' this Tariff (following the ISO-15118 standard).

Uniquely identifies the tariff within the CPO's platform (and suboperator platforms).

ISO-4217 code of the currency of this tariff.

Defines the type of the tariff. This allows for distinction in case of given Charging Preferences. When omitted, this tariff is valid for all sessions.

List of multi-language alternative tariff info texts.

URL to a web page that contains an explanation of the tariff information in human readable form.

When this field is set, a Charging Session with this tariff will at least cost this amount.

When this field is set, a Charging Session with this tariff will at most cost this amount.

The amount that a Payment Terminal Provider should preauthorize when handling card payment for a Session with this Tariff.

Whether taxes are included in the amounts in this Tariff.

List of Tariff Elements.

The time when this tariff becomes active, in UTC. time_zone field of the Location can be used to convert to local time. Typically used for a new tariff that is already given with the location, before it becomes active.

The time after which this tariff is no longer valid, in UTC. time_zone field of the Location can be used to convert to local time. Typically used when this tariff is going to be replaced with a different tariff in the near future.

Details on the energy supplied with this tariff.

Type of CDR dimension.

Start timestamp of the charging period. A period ends when the next period starts. The last period ends when the session ends.

List of relevant values for this charging period.

Nature of the value, in other words, the event this value belongs to. Possible values at moment of writing:

• Start (value at the start of the Session)
• End (signed value at the end of the Session)
• Intermediate (signed values take during the Session, after Start, before End) Others might be added later.

The un-encoded string of data. The format of the content depends on the EncodingMethod field.

The name of the encoding used in the SignedData field. This is the name given to the encoding by a company or group of companies. For the German Eichrecht, different solutions are used, all have (somewhat) different encodings like OCMF, Alfen Eichrecht, EDL40 E-Mobility Extension or EDL40 Mennekes .

Version of the EncodingMethod (when applicable).

Public key used to sign the data, base64 encoded.

One or more signed values.

A description of the tax. In countries where a tax name is required like Canada this can be something like "QST". In countries where this is not required, this can be something more generic like "VAT" or "General Sales Tax".

Tax Account Number of the business entity remitting these taxes. Optional as this is not required in all countries.

Tax percentage. Optional as this is not required in all countries.

Price/Cost excluding taxes.

ISO-3166 alpha-2 country code of the CPO that 'owns' this CDR.

ID of the CPO that 'owns' this CDR (following the ISO-15118 standard).

Uniquely identifies the CDR, the ID SHALL be unique per country_code/party_id combination. This field is longer than the usual 36 characters to allow for credit CDRs to have something appended to the original ID. Normal (non-credit) CDRs SHALL only have an ID with a maximum length of 36.

Start timestamp of the charging session, or in-case of a reservation (before the start of a session) the start of the reservation.

The timestamp when the session was completed/finished, charging might have finished before the session ends, for example: EV is full, but parking cost also has to be paid.

Unique ID of the Session for which this CDR is sent. Is only allowed to be omitted when the CPO has not implemented the Sessions module or this CDR is the result of a reservation that never became a charging session, thus no OCPI Session.

Unique ID of the Booking for which this cdr can also be sent. Is only allowed to be omitted when the Session was reserved.

Token used to start this charging session, including all the relevant information to identify the unique token.

Method used for authentication. Multiple AuthMethods are possible during a charging sessions, for example when the session was started with a reservation: ReserveNow: COMMAND. When the driver arrives and starts charging using a Token that is whitelisted: WHITELIST. The last method SHALL be used in the CDR.

Reference to the authorization given by the eMSP. When the eMSP provided an authorization_reference in either real-time authorization, StartSession or ReserveNow, this field SHALL contain the same value. When different authorization_reference values have been given by the eMSP that are relevant to this Session, the last given value SHALL be used here.

Location where the charging session took place, including only the relevant EVSE and Connector.

Identification of the Meter inside the Charge Point.

Currency of the CDR in ISO 4217 Code.

List of relevant Tariffs, see: Tariff. When relevant, a Free of Charge tariff should also be in this list, and point to a defined Free of Charge Tariff.

List of Charging Periods that make up this charging session.

Signed data that belongs to this charging Session.

Total sum of all the costs of this transaction in the specified currency.

Total sum of all the fixed costs in the specified currency, except fixed price components of parking and reservation. The cost not depending on amount of time/energy used etc. Can contain costs like a start tariff.

Total energy charged, in kWh.

Total sum of all the cost of all the energy used, in the specified currency.

Total duration of the charging session (including the duration of charging and not charging), in hours.

Total sum of all the cost related to duration of charging during this transaction, in the specified currency.

Total duration of the charging session where the EV was not charging (no energy was transferred between EVSE and EV), in hours.

Total sum of all the cost related to parking of this transaction, including fixed price components, in the specified currency.

Total sum of all the cost related to a reservation of a Charge Point, including fixed price components, in the specified currency.

Optional remark, can be used to provide additional human readable information to the CDR, for example: reason why a transaction was stopped.

This field can be used to reference an invoice, that will later be send for this CDR. Making it easier to link a CDR to a given invoice. Maybe even group CDRs that will be on the same invoice.

When set to true, this is a Credit CDR, and the field credit_reference_id needs to be set as well.

Is required to be set for a Credit CDR. This SHALL contain the id of the CDR for which this is a Credit CDR.

When set to true, this CDR is for a charging session using the home charger of the EV Driver for which the energy cost needs to be financial compensated to the EV Driver.