Documentation

CPO Sessions

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

CPO Session Endpoints

POST/2/sessions/cpo/mine

Search My CPO Sessions

Search CPO sessions accessible to the current user.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Request bodyapplication/json
dateFieldstring
endedAtstartedAt
filenamestring
default cpo-sessions.csv
formatstring
csvjsonxlsx
default json
fromstring <date-time>
limitinteger
default 100min 1max 1000000
locationIdstring
monthinteger
min 1max 12
paymentFlowsstring[]
searchPhrasestring
skipinteger
default 0min 0
sortobject
default {"field":"endedAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
tostring <date-time>
yearinteger
min 2000max 2100
Responses
200OK application/json
dataCpoSessionResource[]REQUIRED
accountobject
accountIdstring
authorizationobject
billingPlanobject
idstringREQUIRED
namestringREQUIRED
typestringREQUIRED
connectorIdnumber
createdAtstringREQUIRED
currencystringREQUIRED
dischargedKwhnumber
durationSecondsnumber
endedAtstring
evseControllerobject
evseControllerIdstring
excludedboolean
excludedReasonstring
externalCalculatedPricenumber
externalIdstring
externalProviderobject
externalProviderIdstring
externalUniqueIdstring
idstringREQUIRED
kwhnumberREQUIRED
locationobject
locationIdstring
mspLocationobject
powerTypestring
priceWithFXobject
providerobject
providerContextstringREQUIRED
providerIdstringREQUIRED
reimbursementobject
roamingIdstring
startedAtstring
statusstringREQUIRED
updatedAtstringREQUIRED
userobject
userIdstring
validityobject
vatInfoobject
metaobjectREQUIRED
limitnumberREQUIRED
skipnumberREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/2/sessions/cpo/mine/usage

Get My CPO Session Usage

Returns aggregated usage totals (sessions, kWh, duration, cost) per currency for CPO sessions accessible to the current user.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Request bodyapplication/json
locationIdstring
monthinteger

Month (1-12) to filter totals by. Only valid together with year; rejected without it.

min 1max 12
paymentFlowsstring[]
yearinteger
min 2000max 2100
Responses
200OK application/json
dataCPOSessionUsageTotals[]
currencystringREQUIRED

ISO 4217 currency code the totals are denominated in

totalCostnumberREQUIRED

Total session cost in the given currency

totalDurationSecondsnumberREQUIRED

Total charging duration in seconds

totalKwhnumberREQUIRED

Total energy delivered in kWh

totalSessionsnumberREQUIRED

Number of sessions matching the filters

metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/2/sessions/cpo/mine/{session}

Get My CPO Session

Returns a CPO session if accessible to the current user.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Path parameters1
sessionstringREQUIRED
Responses
200OK application/json
dataCpoSessionResource
accountobject
accountIdstring
authorizationobject
billingPlanobject
idstringREQUIRED
namestringREQUIRED
typestringREQUIRED
connectorIdnumber
createdAtstringREQUIRED
currencystringREQUIRED
dischargedKwhnumber
durationSecondsnumber
endedAtstring
evseControllerobject
evseControllerIdstring
excludedboolean
excludedReasonstring
externalCalculatedPricenumber
externalIdstring
externalProviderobject
externalProviderIdstring
externalUniqueIdstring
idstringREQUIRED
kwhnumberREQUIRED
locationobject
locationIdstring
mspLocationobject
powerTypestring
priceWithFXobject
providerobject
providerContextstringREQUIRED
providerIdstringREQUIRED
reimbursementobject
roamingIdstring
startedAtstring
statusstringREQUIRED
updatedAtstringREQUIRED
userobject
userIdstring
validityobject
vatInfoobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED