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

GET/2/sessions/cpo/evse-payment-terminal-session/{id}

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.

Authorization
User sessionAPI credential
Permissions
cpo-sessions:read
OAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
200OK application/json
dataEvsePaymentTerminalSessionResource
acquirerstring
authorizedAmountnumber
cardIdUsedForPaymentstring
cardLast4Digitsstring
cardTypestring
connectorIdnumber
cpoSessionIdstring
evseControllerIdstring
evseIdnumber
externalAcquirerboolean
externalPaymentIdstring
externalPriceInclVatnumber
externalRecordobject
formattedReceiptStringstring
idstringREQUIRED
locationIdstring
paymentTerminalIdstring
statusstringREQUIRED
terminalProviderstringREQUIRED
uidstring
vatInfoobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource 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/search/fast

Search CPO Sessions

This endpoint allows for searching of CPO sessions using various filters. It is optimized for speed and supports pagination. The response includes a list of sessions and metadata about the pagination.

Authorization
User sessionAPI credential
Permissions
cpo-sessions:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring
connectorIdstring
createdAtobject
$eqnumber | string <date-time>
$gtenumber | string <date-time>
$ltenumber | string <date-time>
currencystring
currencyConvertModestring
to-eur
endedAtobject
$eqnumber | string <date-time>
$gtenumber | string <date-time>
$ltenumber | string <date-time>
evseControllerIdstring
excludedboolean
excludedReasonstring[]
externalCalculatedPriceobject
$eqnumber
$gtenumber
$ltenumber
filenamestring
default sessions-cpo.csv
formatstring
default json
fromstring <date-time>
hasDedicatedReimbursementRecordsboolean
idstring
idsstring[]
keywordsstring
kwhobject
$eqnumber
$gtenumber
$ltenumber
limitnumber
default 50
locationIdstring
onlyInvoicedboolean
onlyUnInvoicedboolean
paymentFlowsstring[]
paymentStatusesstring[]
reimbursementAmountobject
$eqnumber
$gtenumber
$ltenumber
reimbursementExcludedReasonstring[]
reimbursementIsIncludedboolean
revenueTypestring
otherplatformtotal
roamingCdrDeliveryStatusstring
deliveredfailedpending
roamingSyncFailedboolean
roamingSyncStatusstring
syncedunsynced
searchIdstring
searchPhrasestring
skipnumber
default 0
sortobject
default {"field":"endedAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
statusstring
ACTIVECOMPLETED
syncHasErrorsboolean
tostring <date-time>
tokenInfraProviderIdsstring[]
totalCostobject
$eqnumber
$gtenumber
$ltenumber
unqualifiedSyncboolean
updatedAtobject
$eqnumber | string <date-time>
$gtenumber | string <date-time>
$ltenumber | string <date-time>
validityInvalidReasonstring[]
validityIsValidboolean
Responses
200OK application/json
dataobject[]
_idstring
accountIdstring
authorizationobject
cpoPaymentIdstring
paymentobject
productPaymentFlowstring
pspstring
statusstring
sourceobject
namestring
cdrSyncedToRoamingNetworkAtstring
connectorIdstring
createdAtstring <date-time>
currencystring
debitInvoiceIdstring
debitInvoiceIdsstring[]
durationSecondsnumber
endedAtstring <date-time>
energyCostsnumber
evseControllerobject
ocppIdentitystring
evseControllerIdstring
exchangeRateobject
ratenumber
sourceCountryCodestring
sourceCurrencystring
targetCurrencystring
exchangeRateIdstring
exchangeRateRationumber
excludedboolean
excludedReasonstring
externalCalculatedPricenumber
externalIdstring
externalUniqueIdstring
idstring
idleCostsnumber
invoiceIdstring
isSimulatedboolean
kwhnumber
locationobject
accessPolicystring
accountIdstring
namestring
providerIdstring
userIdstring
locationIdstring
originalCurrencystring
originalExternalCalculatedPricenumber
priceWithFXobject
originalAmountnumber
originalAmountWithVATnumber
originalCurrencystring
originalReimbursementAmountnumber
originalReimbursementAmountWithVATnumber
originalTotalCostnumber
originalTotalCostWithVATnumber
ratenumber
targetAmountnumber
targetAmountWithVATnumber
targetCurrencystring
targetReimbursementAmountnumber
targetReimbursementAmountWithVATnumber
targetTotalCostnumber
targetTotalCostWithVATnumber
providerContextstring
cpo
providerIdstring
rawRecordobject
evseIdstring
signedDataboolean
signedMeterDataboolean
tokenVisualNumberstring
reimbursementobject
excludedReasonstring
hasDedicatedReimbursementRecordsboolean
isIncludedboolean

Tri-state: absent or null means the external funder has not answered yet.

reimbursementAmountnumber
sourceCountryCodestring
startCostsnumber
startedAtstring <date-time>
statusstring
syncobject
ocpiobject
cdrobject
syncHasErrorsboolean
timeCostsnumber
tokenTypestring
tokenUidstring
totalCostnumber
totalPricenumber
validityobject
invalidReasonstring
isValidboolean
vatInfoobject
vatPercentagenumber
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource 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/{session}

Get Session

Authorization
User sessionAPI credential
Permissions
cpo-sessions:read
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
403Forbidden: missing a required permission, or no access to this resource 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/{session}/reimbursements

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.

Authorization
User sessionAPI credential
Permissions
cpo-sessions:read
OAuth
-
Request
Path parameters1
sessionstringREQUIRED
Query parameters1
includestring
Responses
200OK application/json
dataSessionReimbursementResource[]
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburse
accountobject

Only populated when the request passes include=accountId, and then only with the account's name.

idstringREQUIRED
namestringREQUIRED
accountIdstringREQUIRED
createdAtstringREQUIRED
detailsobject | objectREQUIRED

How the amount was calculated. Not authoritative.

idstringREQUIRED
incurredAtstringREQUIRED

The session's endedAt, which is the billing date of the reimbursement.

invoiceIdstring
isExcludedbooleanREQUIRED
migrationAtstring
migrationIdstring
providerIdstringREQUIRED
reimbursementAmountobjectREQUIRED

The amount being reimbursed. Authoritative.

currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
sessionIdstringREQUIRED
updatedAtstringREQUIRED
userIdstring
vatRuleVatRuleREQUIRED
calculatedAtstring <date-time>
erpSystemstring
exactnetsuite
erpVatCodestring | number

ERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.

exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource 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