MSP · CDRs

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

ROADCDR additional charges module
Non-standard eMSP endpoint listing the roaming additional charges applied to CDRs.
Not part of the OCPI specification. Available on every connection.
ROADRoad deviations in this section

Road enables these for your connection on request.

  • Additional fields
    Adds fields OCPI 2.1.1 does not define: the owning party (country_code and party_id) on every object, and extra location data such as a publish flag, charging accessibility, parking places and the details needed for national access point reporting. Sessions and CDRs also carry VAT-inclusive totals.
    When not enabled: Objects carry only the fields the OCPI specification defines.
  • Remapped party identity
    country_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 origin
    Non-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.
GET/emsp/2.1.1/cdr-additional-charges

List CDR additional charges

Responses
200OCPI response envelope application/json
dataobject[]
idstring
cdrobject
idstring
start_date_timeobject
stop_date_timeobject
auth_idstring
authorization_idstring
auth_methodstring
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
related_locationsobject[]
evsesobject[]
directionsobject[]
operatorobject
suboperatorobject
ownerobject
facilitiesstring[]
time_zonestring
opening_timesobject
charging_when_closedboolean
imagesobject[]
energy_mixobject
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
help_phonestring
registry_infoobject
tariffsobject[]
idstring
currencystring
tariff_alt_textobject[]
tariff_alt_urlstring
elementsobject[]
energy_mixobject
last_updatedobject
country_codestring
party_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
total_costnumber <double>
total_energynumber <double>
total_timenumber <double>
total_parking_timenumber <double>
remarkstring
last_updatedobject
country_codestring
party_idstring
home_charging_compensationboolean
session_idstring
authorization_referencestring
connection_idstring
connection_namestring
total_cost_incl_vatnumber <double>
corrected_cdr_idstring
validation_statusstring
validation_reasonstring
creditboolean
credit_reference_idstring
fundingobject
country_codestring
party_idstring
idstring
statusstring
currencystring
amountnumber <double>
credit_targetobject
connection_idstring
country_codestring
party_idstring
charge_rule_idstring
charge_rule_descriptionstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
POST/emsp/2.1.1/cdrs

Post a CDR

ROADAdditional fieldsROADRemapped party identity
Request
Request bodyREQUIREDapplication/json
idstring
start_date_timeobject
stop_date_timeobject
auth_idstring
authorization_idstring
auth_methodstring
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
nameobject
languagestring
textstring
latitudestring
longitudestring
related_locationsobject[]
nameobject
languagestring
textstring
latitudestring
longitudestring
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
period_beginstring
period_endstring
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
voltageinteger <int32>
amperageinteger <int32>
tariff_idstring
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
capabilitiesstring[]
max_electric_powerinteger <int32>
floor_levelstring
coordinatesobject
nameobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
parkingobject[]
parking_idstring
evse_positionstring
accepted_service_providersstring[]
registry_infoobject
commissioned_atobject
decommissioned_atobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
price_componentsobject[]
restrictionsobject
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
idstring
physical_referencestring
vehicle_typesstring[]
max_vehicle_weightinteger <int32>
max_vehicle_heightinteger <int32>
max_vehicle_lengthinteger <int32>
max_vehicle_widthinteger <int32>
parking_space_lengthinteger <int32>
parking_space_widthinteger <int32>
dangerous_goods_allowedboolean
directionstring
drive_throughboolean
restricted_to_typeboolean
reservation_requiredboolean
time_limitinteger <int32>
roofedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestring
registry_infoobject
operator_contactobject
phonestring
hotlinestring
emailstring
contact_personstring
websitestring
addressstring
citystring
postal_codestring
countrystring
owner_contactobject
phonestring
hotlinestring
emailstring
contact_personstring
websitestring
addressstring
citystring
postal_codestring
countrystring
aggregate_power_wattsinteger <int32>
grid_voltage_levelstring
commissioned_atobject
ocpp_versionstring
smart_charging_capableboolean
ad_hoc_payment_availableboolean
ad_hoc_price_urlstring
roaming_availableboolean
roaming_hubsstring[]
payment_instrumentsstring[]
free_of_chargeboolean
parking_places_totalinteger <int32>
parking_places_disabledinteger <int32>
parking_feeboolean
green_energy_certifiedboolean
green_energy_certificatestring
tariffsobject[]
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
typestring
pricenumber <double>
step_sizeinteger <int32>
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
typestring
volumenumber <double>
total_costnumber <double>
total_energynumber <double>
total_timenumber <double>
total_parking_timenumber <double>
remarkstring
last_updatedobject
country_codestringROAD
party_idstringROAD
home_charging_compensationboolean
session_idstring
authorization_referencestring
connection_idstringROAD
connection_namestring
total_cost_incl_vatnumber <double>ROAD
corrected_cdr_idstring
validation_statusstring
validation_reasonstring
creditboolean
credit_reference_idstring
fundingobject
country_codestring
party_idstring
idstring
statusstring
Responses
200OCPI response envelope application/json
dataobject
idstring
start_date_timeobject
stop_date_timeobject
auth_idstring
authorization_idstring
auth_methodstring
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
nameobject
latitudestring
longitudestring
related_locationsobject[]
nameobject
latitudestring
longitudestring
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
capabilitiesstring[]
connectorsobject[]
floor_levelstring
coordinatesobject
physical_referencestring
directionsobject[]
parking_restrictionsstring[]
imagesobject[]
last_updatedobject
parkingobject[]
accepted_service_providersstring[]
registry_infoobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
suboperatorobject
namestring
websitestring
logoobject
ownerobject
namestring
websitestring
logoobject
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
twentyfoursevenboolean
exceptional_openingsobject[]
exceptional_closingsobject[]
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
idstring
physical_referencestring
vehicle_typesstring[]
max_vehicle_weightinteger <int32>
max_vehicle_heightinteger <int32>
max_vehicle_lengthinteger <int32>
max_vehicle_widthinteger <int32>
parking_space_lengthinteger <int32>
parking_space_widthinteger <int32>
dangerous_goods_allowedboolean
directionstring
drive_throughboolean
restricted_to_typeboolean
reservation_requiredboolean
time_limitinteger <int32>
roofedboolean
imagesobject[]
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestring
registry_infoobject
operator_contactobject
owner_contactobject
aggregate_power_wattsinteger <int32>
grid_voltage_levelstring
commissioned_atobject
ocpp_versionstring
smart_charging_capableboolean
ad_hoc_payment_availableboolean
ad_hoc_price_urlstring
roaming_availableboolean
roaming_hubsstring[]
payment_instrumentsstring[]
free_of_chargeboolean
parking_places_totalinteger <int32>
parking_places_disabledinteger <int32>
parking_feeboolean
green_energy_certifiedboolean
green_energy_certificatestring
tariffsobject[]
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
restrictionsobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
typestring
volumenumber <double>
total_costnumber <double>
total_energynumber <double>
total_timenumber <double>
total_parking_timenumber <double>
remarkstring
last_updatedobject
country_codestringROAD
party_idstringROAD
home_charging_compensationboolean
session_idstring
authorization_referencestring
connection_idstringROAD
connection_namestring
total_cost_incl_vatnumber <double>ROAD
corrected_cdr_idstring
validation_statusstring
validation_reasonstring
creditboolean
credit_reference_idstring
fundingobject
country_codestring
party_idstring
idstring
statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/emsp/2.1.1/cdrs/{cdr_id}

Get a CDR

ROADAdditional fieldsROADRemapped party identity
Request
Path parameters1
cdr_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
idstring
start_date_timeobject
stop_date_timeobject
auth_idstring
authorization_idstring
auth_methodstring
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
nameobject
latitudestring
longitudestring
related_locationsobject[]
nameobject
latitudestring
longitudestring
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
capabilitiesstring[]
connectorsobject[]
floor_levelstring
coordinatesobject
physical_referencestring
directionsobject[]
parking_restrictionsstring[]
imagesobject[]
last_updatedobject
parkingobject[]
accepted_service_providersstring[]
registry_infoobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
suboperatorobject
namestring
websitestring
logoobject
ownerobject
namestring
websitestring
logoobject
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
twentyfoursevenboolean
exceptional_openingsobject[]
exceptional_closingsobject[]
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
idstring
physical_referencestring
vehicle_typesstring[]
max_vehicle_weightinteger <int32>
max_vehicle_heightinteger <int32>
max_vehicle_lengthinteger <int32>
max_vehicle_widthinteger <int32>
parking_space_lengthinteger <int32>
parking_space_widthinteger <int32>
dangerous_goods_allowedboolean
directionstring
drive_throughboolean
restricted_to_typeboolean
reservation_requiredboolean
time_limitinteger <int32>
roofedboolean
imagesobject[]
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestring
registry_infoobject
operator_contactobject
owner_contactobject
aggregate_power_wattsinteger <int32>
grid_voltage_levelstring
commissioned_atobject
ocpp_versionstring
smart_charging_capableboolean
ad_hoc_payment_availableboolean
ad_hoc_price_urlstring
roaming_availableboolean
roaming_hubsstring[]
payment_instrumentsstring[]
free_of_chargeboolean
parking_places_totalinteger <int32>
parking_places_disabledinteger <int32>
parking_feeboolean
green_energy_certifiedboolean
green_energy_certificatestring
tariffsobject[]
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
restrictionsobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
typestring
volumenumber <double>
total_costnumber <double>
total_energynumber <double>
total_timenumber <double>
total_parking_timenumber <double>
remarkstring
last_updatedobject
country_codestringROAD
party_idstringROAD
home_charging_compensationboolean
session_idstring
authorization_referencestring
connection_idstringROAD
connection_namestring
total_cost_incl_vatnumber <double>ROAD
corrected_cdr_idstring
validation_statusstring
validation_reasonstring
creditboolean
credit_reference_idstring
fundingobject
country_codestring
party_idstring
idstring
statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/emsp/2.1.1/cdrs/{country_code}/{party_id}/{id}

Get a CDR by origin

ROADAdditional fieldsROADRemapped party identityROADRoad extension: CDR retrieval by origin
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
idstring
start_date_timeobject
stop_date_timeobject
auth_idstring
authorization_idstring
auth_methodstring
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
nameobject
latitudestring
longitudestring
related_locationsobject[]
nameobject
latitudestring
longitudestring
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
capabilitiesstring[]
connectorsobject[]
floor_levelstring
coordinatesobject
physical_referencestring
directionsobject[]
parking_restrictionsstring[]
imagesobject[]
last_updatedobject
parkingobject[]
accepted_service_providersstring[]
registry_infoobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
suboperatorobject
namestring
websitestring
logoobject
ownerobject
namestring
websitestring
logoobject
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
twentyfoursevenboolean
exceptional_openingsobject[]
exceptional_closingsobject[]
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
idstring
physical_referencestring
vehicle_typesstring[]
max_vehicle_weightinteger <int32>
max_vehicle_heightinteger <int32>
max_vehicle_lengthinteger <int32>
max_vehicle_widthinteger <int32>
parking_space_lengthinteger <int32>
parking_space_widthinteger <int32>
dangerous_goods_allowedboolean
directionstring
drive_throughboolean
restricted_to_typeboolean
reservation_requiredboolean
time_limitinteger <int32>
roofedboolean
imagesobject[]
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestring
registry_infoobject
operator_contactobject
owner_contactobject
aggregate_power_wattsinteger <int32>
grid_voltage_levelstring
commissioned_atobject
ocpp_versionstring
smart_charging_capableboolean
ad_hoc_payment_availableboolean
ad_hoc_price_urlstring
roaming_availableboolean
roaming_hubsstring[]
payment_instrumentsstring[]
free_of_chargeboolean
parking_places_totalinteger <int32>
parking_places_disabledinteger <int32>
parking_feeboolean
green_energy_certifiedboolean
green_energy_certificatestring
tariffsobject[]
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
restrictionsobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
typestring
volumenumber <double>
total_costnumber <double>
total_energynumber <double>
total_timenumber <double>
total_parking_timenumber <double>
remarkstring
last_updatedobject
country_codestringROAD
party_idstringROAD
home_charging_compensationboolean
session_idstring
authorization_referencestring
connection_idstringROAD
connection_namestring
total_cost_incl_vatnumber <double>ROAD
corrected_cdr_idstring
validation_statusstring
validation_reasonstring
creditboolean
credit_reference_idstring
fundingobject
country_codestring
party_idstring
idstring
statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.