CPO Sessions
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.
CPO Session Endpoints
Get Payment Terminal Session
Sessions that are run via Payment Terminals result in an additional entity that we dub a Payment Terminal Session. Payment Terminal Sessions are used to coordinate sessions authorized via Payment Terminals, in addition to storing any relevant payment information.
Note that not all Payment Terminal sessions result in funds drawn from external sources; some Payment Terminals also support taps from typical EV charging RFID tags/cards. The cardType field can be used check what flavour of card was used.
The id value can be obtained from the evsePaymentTerminalSessionId field of a CPO session.
User sessionAPI credentialcpo-sessions:readPath parameters1
200OK application/json
dataEvsePaymentTerminalSessionResource
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Search CPO Sessions
Returns the CPO sessions of the provider in the Provider header, sorted by endedAt with the newest first unless sort says otherwise. Sessions still in progress have no endedAt and come last. With a searchPhrase, the best matches come first.
Results come from a search index that follows the sessions, so a new session or a recent change can take a moment to appear. Each result holds the session fields kept in that index. For the full session, use GET /2/sessions/cpo/{session}.
Page with skip and limit. Together they must stay at or below 10,000. To reach sessions beyond that, narrow the search, for example with from and to.
Range filters (endedAt, kwh, externalCalculatedPrice, totalCost, reimbursementAmount) take $gte and $lte bounds, or $eq for one exact value.
User sessionAPI credentialcpo-sessions:readRequest bodyapplication/json
Only sessions of this account.
Only sessions on this connector. Connector IDs repeat between charging stations, so combine it with evseControllerId.
Only sessions in this currency, for example EUR.
to-eur converts the priceWithFX target amounts to euros, at the exchange rate in effect when the session ended.
to-eurendedAtobjectRange filter on the time the session ended.
Range filter on the time the session ended.
Only sessions on this EVSE controller.
Legacy exclusion flag. Use validityIsValid and reimbursementIsIncluded instead.
Legacy exclusion reasons. Use validityInvalidReason and reimbursementExcludedReason instead.
externalCalculatedPriceobjectRange filter on the price of the session, excluding VAT, in the session currency.
Range filter on the price of the session, excluding VAT, in the session currency.
Only sessions that ended at or after this time.
true for sessions with dedicated reimbursement records, false for the others.
kwhobjectRange filter on the energy delivered, in kWh.
Range filter on the energy delivered, in kWh.
Number of results to return. skip plus limit must stay at or below 10,000.
50Browser locale, e.g. nl-NL, for a CSV export: sets its decimal sign and delimiter. Without it the CSV keeps its default format.
Only sessions at this location.
Send true for sessions that are on an invoice. false applies no filter.
Send true for sessions that are not on an invoice yet. false applies no filter.
Only sessions paid in one of these ways. charge-card covers every session without an ad hoc payment.
Only sessions whose ad hoc payment has one of these statuses.
reimbursementAmountobjectRange filter on the reimbursement amount, excluding VAT, in the session currency.
Range filter on the reimbursement amount, excluding VAT, in the session currency.
Only sessions excluded from reimbursement for one of these reasons.
Only sessions included in (true) or excluded from (false) reimbursement. Sessions still waiting for the external funder match neither.
delivered or failed as the CDR delivery receipt reports it, or pending for a sent CDR without a receipt yet. Leaves out sessions with an ad hoc payment.
deliveredfailedpendingWith roamingSyncStatus set to unsynced, send true for sessions whose CDR push failed.
synced for sessions whose CDR was sent to the roaming network, unsynced for the others. Leaves out sessions with an ad hoc payment.
syncedunsyncedText to look for. It matches the session ID exactly, and part of the external IDs, token UID, token visual number, internal token reference and EVSE ID. It also matches the email addresses and phone number of the account, and the name and address of the location.
Number of results to skip.
0sortobjectField and direction to sort by. Use a date or number field, such as endedAt, startedAt, kwh or durationSeconds.
default {"field":"endedAt","order":"desc"}
Field and direction to sort by. Use a date or number field, such as endedAt, startedAt, kwh or durationSeconds.
{"field":"endedAt","order":"desc"}ascdescACTIVE for sessions in progress, COMPLETED for sessions that have ended.
ACTIVECOMPLETEDOnly sessions that ended at or before this time.
Only roaming sessions whose token comes from one of these eMSPs, given as OCPI country code and party ID, for example NLABC.
totalCostobjectRange filter on the total cost of the session, excluding VAT, in the session currency.
Range filter on the total cost of the session, excluding VAT, in the session currency.
Only invalid sessions with one of these reasons.
Only valid (true) or invalid (false) sessions.
200OK application/json
dataobject[]
authorizationobject
paymentobject
sourceobject
evseControllerobject
exchangeRateobject
locationobject
priceWithFXobject
cporawRecordobject
reimbursementobject
Tri-state: absent or null means the external funder has not answered yet.
syncobject
ocpiobject
validityobject
vatInfoobject
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Get Session
User sessionAPI credentialcpo-sessions:readPath parameters1
200OK application/json
dataCpoSessionResource
billingPlanobject
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Get Session Reimbursements
Returns dedicated reimbursement records for a CPO session. These records are reliable only when the session explicitly has dedicated reimbursement records enabled.
User sessionAPI credentialcpo-sessions:readPath parameters1
Query parameters1
Comma-separated relationship paths to return as records instead of ids. Allowed: accountId
200OK application/json
dataSessionReimbursementResource[]
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburseaccountobjectOnly populated when the request passes include=accountId, and then only with the account's name.
Only populated when the request passes include=accountId, and then only with the account's name.
How the amount was calculated. Not authoritative.
The session's endedAt, which is the billing date of the reimbursement.
reimbursementAmountobjectREQUIREDThe amount being reimbursed. Authoritative.
The amount being reimbursed. Authoritative.
vatRuleVatRuleREQUIRED
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.