eMSP · CDRs
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
ROADRoad deviations in this section
Road enables these for your connection on request.
- Remapped party identitycountry_code, party_id and EVSE ids on locations, tariffs and CDRs can differ from those of the party that created them. Road rewrites them according to rules set up for the connection.When not enabled: Objects keep the identity of the party that created them.
- CDR retrieval by originNon-standard eMSP endpoint returning a CDR by its OCPI natural key triple (country_code, party_id, external id), alongside the standard retrieval by id.Available on every connection.When not enabled: Not part of the OCPI specification.
POST/msp/cdrs
Post a CDR
Submits a charge detail record to the eMSP. The Location response header carries the URL of the stored CDR.
ROADRemapped party identity
Request
Request bodyREQUIREDapplication/json
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
session_idstring
cdr_tokenobject
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
cdr_locationobject
cdr_locationobject
idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
coordinatesobject
latitudestring
longitudestring
evse_uidstring
evse_idstringROAD
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
connector_idstring
connector_standardstring
connector_formatstring
connector_power_typestring
meter_idstring
currencystring
tariffsobject[]
tariffsobject[]
country_codestring
party_idstring
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
price_componentsobject[]
typestring
pricenumber <double>
vatnumber <double>
step_sizeinteger <int32>
restrictionsobject
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_currentnumber <double>
max_currentnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
reservationstring
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
charging_periodsobject[]
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
signed_dataobject
signed_dataobject
encoding_methodstring
encoding_method_versioninteger
public_keystring
signed_valuesobject[]
signed_valuesobject[]
naturestring
plain_datastring
signed_datastring
urlstring
total_costobject
total_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_fixed_costobject
total_fixed_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_energynumber <double>
total_energy_costobject
total_energy_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_timenumber <double>
total_time_costobject
total_time_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_parking_timenumber <double>
total_parking_costobject
total_parking_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_reservation_costobject
total_reservation_costobject
excl_vatnumber <double>
incl_vatnumber <double>
remarkstring
invoice_reference_idstring
creditboolean
credit_reference_idstring
home_charging_compensationboolean
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
dataobject
dataobject
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
session_idstring
cdr_tokenobject
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
cdr_locationobject
cdr_locationobject
idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
coordinatesobject
latitudestring
longitudestring
evse_uidstring
evse_idstringROAD
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
connector_idstring
connector_standardstring
connector_formatstring
connector_power_typestring
meter_idstring
currencystring
tariffsobject[]
tariffsobject[]
country_codestring
party_idstring
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
restrictionsobject
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
charging_periodsobject[]
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
signed_dataobject
signed_dataobject
encoding_methodstring
encoding_method_versioninteger
public_keystring
signed_valuesobject[]
signed_valuesobject[]
naturestring
plain_datastring
signed_datastring
urlstring
total_costobject
total_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_fixed_costobject
total_fixed_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_energynumber <double>
total_energy_costobject
total_energy_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_timenumber <double>
total_time_costobject
total_time_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_parking_timenumber <double>
total_parking_costobject
total_parking_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_reservation_costobject
total_reservation_costobject
excl_vatnumber <double>
incl_vatnumber <double>
remarkstring
invoice_reference_idstring
creditboolean
credit_reference_idstring
home_charging_compensationboolean
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/msp/cdrs/{cdr_id}
Get a CDR
Returns a single charge detail record by its id.
ROADRemapped party identity
Request
Path parameters1
cdr_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
dataobject
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
session_idstring
cdr_tokenobject
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
cdr_locationobject
cdr_locationobject
idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
coordinatesobject
latitudestring
longitudestring
evse_uidstring
evse_idstringROAD
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
connector_idstring
connector_standardstring
connector_formatstring
connector_power_typestring
meter_idstring
currencystring
tariffsobject[]
tariffsobject[]
country_codestring
party_idstring
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
restrictionsobject
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
charging_periodsobject[]
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
signed_dataobject
signed_dataobject
encoding_methodstring
encoding_method_versioninteger
public_keystring
signed_valuesobject[]
signed_valuesobject[]
naturestring
plain_datastring
signed_datastring
urlstring
total_costobject
total_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_fixed_costobject
total_fixed_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_energynumber <double>
total_energy_costobject
total_energy_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_timenumber <double>
total_time_costobject
total_time_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_parking_timenumber <double>
total_parking_costobject
total_parking_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_reservation_costobject
total_reservation_costobject
excl_vatnumber <double>
incl_vatnumber <double>
remarkstring
invoice_reference_idstring
creditboolean
credit_reference_idstring
home_charging_compensationboolean
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/msp/cdrs/{country_code}/{party_id}/{id}
Get a CDR by origin
Returns a single charge detail record by its originating party and external id.
ROADRemapped party identityROADRoad extension: CDR retrieval by origin
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
dataobject
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
session_idstring
cdr_tokenobject
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
cdr_locationobject
cdr_locationobject
idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
coordinatesobject
latitudestring
longitudestring
evse_uidstring
evse_idstringROAD
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
connector_idstring
connector_standardstring
connector_formatstring
connector_power_typestring
meter_idstring
currencystring
tariffsobject[]
tariffsobject[]
country_codestring
party_idstring
idstring
currencystring
typestring
tariff_alt_textobject[]
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
elementsobject[]
price_componentsobject[]
restrictionsobject
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
charging_periodsobject[]
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
signed_dataobject
signed_dataobject
encoding_methodstring
encoding_method_versioninteger
public_keystring
signed_valuesobject[]
signed_valuesobject[]
naturestring
plain_datastring
signed_datastring
urlstring
total_costobject
total_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_fixed_costobject
total_fixed_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_energynumber <double>
total_energy_costobject
total_energy_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_timenumber <double>
total_time_costobject
total_time_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_parking_timenumber <double>
total_parking_costobject
total_parking_costobject
excl_vatnumber <double>
incl_vatnumber <double>
total_reservation_costobject
total_reservation_costobject
excl_vatnumber <double>
incl_vatnumber <double>
remarkstring
invoice_reference_idstring
creditboolean
credit_reference_idstring
home_charging_compensationboolean
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.