Documentation

Remote Sessions

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

Remote Session Management

POST/1/remote-sessions/msp

Start Remote Session

Start a new MSP remote session.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Request bodyapplication/json
connectorIdstringREQUIRED
currencystringREQUIRED
evseUidstringREQUIRED
locationIdstringREQUIRED
paymentInstrumentIdstringREQUIRED
paymentTypestringREQUIRED
PSP_PREAUTH
preauthAmountnumberREQUIRED
min 0
redirectUrlstring
default https://success.payment.complete/
tokenIdstring
Responses
200OK application/json
dataMspRemoteSession
accountIdstring
activeSessionobject
accountIdstring
currencystring
currentTotalnumber
currentTotalWithTaxnumber
deletedboolean
deletedAtstring <date-time>
externalIdstring
externalUniqueIdstring
idstring
infraProviderIdstring
kwhnumber
locationobject
locationIdstring
migrationAtstring <date-time>
migrationIdstring
ocpiCredentialsNamespacestring
ocpiCredentialsVersionUrlstring
ocpiExternalLocationIdstring
providerContextstring
cpomsp
providerIdstring
rawRecordobject
auth_idstring
remoteSessionIdstring
startedAtstring <date-time>
statusstring
tokenContractIdstring
tokenIdstring
tokenUidstring
userIdstring
vatInfoobject
activeSessionIdstring
authorizationReferencestring
cancelledReasonstring
CHARGESTATION_TIMED_OUTNOT_SUPPORTED_BY_CHARGING_STATIONNO_ACTIVE_SESSION_RECEIVEDREJECTED_BY_CHARGING_STATIONREJECTED_BY_CPOREQUESTED_BY_CUSTOMERUNKNOWN_SESSION
connectorIdstringREQUIRED
countryCodestring
createdAtstring <date-time>
errorobject
errorIdstring
messagestringREQUIRED
evseIdstringREQUIRED
externalPaymentExternalPayment
authorizedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
capturedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
hasErrorbooleanREQUIRED
idstringREQUIRED
infraProviderIdstring
locationobject
accessPolicystring
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburse
accountIdstring
addressstring
auditEntiresboolean
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
authorizationTypesstring[]
connectorsobject[]
evse_idstring
uidstring
facilitiesstring[]
geoLocationobject
coordinatesobjectREQUIRED
typestringREQUIRED
hasTariffInfoboolean
idstring
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestring
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
partyIdstring
postalCodestring
postal_codestring
powerTypestring
providerContextstring
msp
providerIdstring
publishboolean
publishingModestring
privatepublic
sourcestring
cpoeclearingocpiroad-cpo-internal
statusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
tariffCountryCodestring
tariffPartyIdstring
timestampsboolean
timezonestring
typestring
userIdstring
locationIdstring
migrationAtstring <date-time>
migrationIdstring
mspLocationobject
mspSessionobject
accountIdstring
authTypestring
AUTH_REQUESTCOMMANDWHITELIST
authorizationReferencestring
billingInfoBillingInfo
locationAccessPolicystring
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburse
usageReimbursementobject[]
billingPlanIdstring
calculatedDiscountnumber
calculatedPricenumber
calculatedPriceTypestring
cdrIdstring
cdrSyncedToRoamingNetworkAtstring <date-time>
chargePointIdstring
chargingFinishedAtstring <date-time>
connectorIdstring
connectorTypestring
costSettingOverrideobject
cpoEvseControllerIdstring
cpoProviderIdstring
cpoProviderNamestring
createdAtstring <date-time>
creditSessionIdstring
currencystring
debitInvoiceIdstring
debitInvoiceIdsstring[]
deletedboolean
deletedAtstring <date-time>
dischargedKwhnumber
durationSecondsnumber
eligibleIdleMinutesnumber
endedAtstring <date-time>
energyCostsnumber
evseControllerIdstring
evsePaymentTerminalSessionIdstring
exchangeRateCheckedboolean
exchangeRateIdstring
excludedboolean
excludedReasonstring
externalCalculatedPricenumber
externalCalculatedPriceOverridenboolean
externalIdstring
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
externalProviderIdstring
externalUniqueIdstring
fraudDetectionobject
fraudDetectionCompletedboolean
hadConcurrentTxboolean
idstring
idleCostsnumber
importBatchIdstring
importSourcestring
infraProviderIdstring
integrityValidationobject
integrityValidationCompletedboolean
invoiceIdstring
isSimulatedboolean
kwhnumber
limitSessionLimit
maxIdleCostsSessionCostLimit
maxTimeCostsSessionCostLimit
maxTotalCostsSessionCostLimit
locationobject
addressstring
citystring
countryCodestring
postalCodestring
locationBillingPlanIdstring
locationIdstring
mspLocationIdstring
mspPaymentMSPPaymentSession
exchangeRateIdstring
feesobject
paymentReceiptIdstring
sessionCostsAmountBSONMoneyREQUIRED
totalAmountBSONMoneyREQUIRED
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalLocationIdstring
ocppVersionstring
operatorPlatformAuthorizationOperatorPlatformAuthorization
idstringREQUIRED
targetedPaymentOptionstring
CHARGE_CARDSCAN_TO_PAYTAP_TO_PAY
tariffConfigurationIdstring
tariffIdstring
paymentPolicystring
deferredimmediate
powerTypestring
acdc
providerContextstring
msp
providerIdstring
rawRecordobject
advancedCostsobject
cancelledByCredentialIdstring
cancelledByUserIdstring
chargingStatestring
ChargingEVConnectedIdleSuspendedEVSuspendedEVSE
connectorInfoEvseControllerConnector
costSettingobject
dischargeMeterStartnumber
dischargeMeterStopnumber
evseIdstring
initializedboolean
internalTokenobject
locationInfoobject
meterLastReceivedAtstring <date-time>
meterLastSamplenumber
meterLastTimestampstring
meterStartnumber
meterStopnumber
ocppConnectorIdnumber
ocppEvseIdnumber
ocppTransactionIdstring
signedDataSignedMeterData
signedMeterDataSignedMeterData[]
startTransactionReceivedAtstring <date-time>
stopTimestampstring
stopTransactionReceivedAtstring <date-time>
tokenAuthIdstring
tokenCustomIdstring
tokenInfraProviderIdstring
tokenIssuerNamestring
tokenTypestring
reimbursementobject
excludedReasonstring
AUTHORIZED_NON_BILLABLE_RFIDEXTERNAL_PAYMENT_FAILEDEXTERNAL_PAYMENT_SOLUTIONEXTERNAL_REIMBURSEMENTHISTORICAL_ENDINVALID_SESSIONMANUAL_EXCLUSIONNO_AUTO_REIMBURSEMENTNO_COSTTEMPORARILY_EXCLUDED_WAITING_FOR_MISSING_DATAUNSPECIFIED
hasDedicatedReimbursementRecordsboolean
isFundingCollectedExternallyboolean

if funds decision comes from an external entity

isIncludedboolean

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

isIncludedReceivedAtstring <date-time>

When reimbursement decision comes from an external service

relatedConcurrentSessionsstring[]
remoteSessionIdstring
roamingCdrDeliveryReceiptobject
errorstring
receivedAtstring <date-time>
statusstring
DELIVEREDFAILED
timestampstring <date-time>
serviceExternalIdstring
serviceExternalProviderIdstring
startCostsnumber
startedAtstring <date-time>
stateOfChargenumber
statusstring
syncobject
ocpiobject
syncEclearingStatusobject
syncHasErrorsboolean
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timeCostsnumber
tokenBillingPlanIdstring
tokenContractIdstring
tokenIdstring
tokenInfraProviderIdstring
tokenTypestring
tokenUidstring
totalCostnumber
totalPricenumber
unauthorizedstring
updatedAtstring <date-time>
userIdstring
validityobject
invalidReasonstring
DUPLICATEDFAILED_TO_STARTHIGH_ENERGY_USAGEIMPROBABLE_ENERGY_USAGEINTERNAL_TOKENINVALID_END_TIMEINVALID_START_TIMELOW_ENERGY_USAGEMAINTENANCE_TOKENMANUAL_CANCELLATIONMISSING_OR_INVALID_SESSIONNON_ACCEPTED_AUTHREPLACED_WITH_CORRECTED_SESSIONSHORT_DURATIONUNKNOWN_METER_VALUESUNSPECIFIED
isValidbooleanREQUIRED
vatInfoVatRule
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
mspSessionIdstring
ocpiCredentialIdstring
ocpiExternalLocationIdstring
partyIdstring
paymentIdstring
paymentTypestring
AD_HOC_TOKENPSP_PREAUTHTOKEN
paymentVoidScheduledAtstring <date-time>
providerContextstringREQUIRED
msp
providerIdstringREQUIRED
statusstring
ACTIVECANCELLEDCOMPLETEDERRORPENDINGSTARTINGSTOPPEDSTOPPING
statusChangedAtstring <date-time>
stopRequestedAtstring <date-time>
tariffCurrencystring
tokenCustomIdstring
tokenIdstring
tokenUidstring
transactionIdstring
updatedAtstring <date-time>
userIdstring
virtualTokenIdstring
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/1/remote-sessions/msp/preauth-limits/{locationId}/{evseUid}/{connectorId}

Get Preauth Limits

Returns preauth currency limits for a connector.

Request
Path parameters3
locationIdstringREQUIRED
evseUidstringREQUIRED
connectorIdstringREQUIRED
Responses
200OK application/json
dataPreauthCurrencyLimits
currencystringREQUIRED

The currency the limits below relate to

defaultnumberREQUIRED

The amount pre-authorised when no amount is specified

maxnumberREQUIRED

The maximum amount that can be pre-authorised

minnumberREQUIRED

The minimum amount that can be pre-authorised

metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request 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/1/remote-sessions/msp/token/{tokenId}

Get Remote Sessions by Token

Get remote sessions by token ID.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Path parameters1
tokenIdstringREQUIRED
Responses
200OK application/json
dataMspRemoteSessionResource[]
accountIdstring
activeSessionobject
activeSessionIdstring
canCancelboolean
cancelledReasonstring
connectorIdstringREQUIRED
countryCodestring
cpoSessionobject
cpoSessionIdstring
createdAtstringREQUIRED
errorobject
errorIdstring
messagestring
evseIdstringREQUIRED
externalPaymentobject
hasErrorbooleanREQUIRED
idstringREQUIRED
infraProviderIdstring
locationobject
addressstring
citystring
countrystring
idstring
namestring
postal_codestring
locationIdstring
mspSessionobject
mspSessionIdstring
partyIdstring
paymentIdstring
paymentTypestring
providerContextstringREQUIRED
providerIdstringREQUIRED
sourcestring
statusstringREQUIRED
statusChangedAtstring
stopRequestedAtstring
tariffCurrencystring
tokenCustomIdstring
tokenIdstring
tokenUidstring
transactionIdstring
updatedAtstringREQUIRED
userobject
userIdstring
virtualTokenIdstring
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/1/remote-sessions/msp/{sessionId}

Get Remote Session

Get a remote session by ID.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Path parameters1
sessionIdstringREQUIRED
Responses
200OK application/json
dataMspRemoteSessionResource
accountIdstring
activeSessionobject
activeSessionIdstring
canCancelboolean
cancelledReasonstring
connectorIdstringREQUIRED
countryCodestring
cpoSessionobject
cpoSessionIdstring
createdAtstringREQUIRED
errorobject
errorIdstring
messagestring
evseIdstringREQUIRED
externalPaymentobject
hasErrorbooleanREQUIRED
idstringREQUIRED
infraProviderIdstring
locationobject
addressstring
citystring
countrystring
idstring
namestring
postal_codestring
locationIdstring
mspSessionobject
mspSessionIdstring
partyIdstring
paymentIdstring
paymentTypestring
providerContextstringREQUIRED
providerIdstringREQUIRED
sourcestring
statusstringREQUIRED
statusChangedAtstring
stopRequestedAtstring
tariffCurrencystring
tokenCustomIdstring
tokenIdstring
tokenUidstring
transactionIdstring
updatedAtstringREQUIRED
userobject
userIdstring
virtualTokenIdstring
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
POST/1/remote-sessions/msp/{sessionId}/cancel

Cancel Remote Session

Cancel a pending MSP remote session.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Path parameters1
sessionIdstringREQUIRED
Responses
200OK application/json
successbooleanREQUIRED
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/1/remote-sessions/msp/{sessionId}/stop

Stop Remote Session

Stop an active MSP remote session.

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Request
Path parameters1
sessionIdstringREQUIRED
Responses
200OK application/json
dataMspRemoteSession
accountIdstring
activeSessionobject
accountIdstring
currencystring
currentTotalnumber
currentTotalWithTaxnumber
deletedboolean
deletedAtstring <date-time>
externalIdstring
externalUniqueIdstring
idstring
infraProviderIdstring
kwhnumber
locationobject
locationIdstring
migrationAtstring <date-time>
migrationIdstring
ocpiCredentialsNamespacestring
ocpiCredentialsVersionUrlstring
ocpiExternalLocationIdstring
providerContextstring
cpomsp
providerIdstring
rawRecordobject
auth_idstring
remoteSessionIdstring
startedAtstring <date-time>
statusstring
tokenContractIdstring
tokenIdstring
tokenUidstring
userIdstring
vatInfoobject
activeSessionIdstring
authorizationReferencestring
cancelledReasonstring
CHARGESTATION_TIMED_OUTNOT_SUPPORTED_BY_CHARGING_STATIONNO_ACTIVE_SESSION_RECEIVEDREJECTED_BY_CHARGING_STATIONREJECTED_BY_CPOREQUESTED_BY_CUSTOMERUNKNOWN_SESSION
connectorIdstringREQUIRED
countryCodestring
createdAtstring <date-time>
errorobject
errorIdstring
messagestringREQUIRED
evseIdstringREQUIRED
externalPaymentExternalPayment
authorizedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
capturedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
hasErrorbooleanREQUIRED
idstringREQUIRED
infraProviderIdstring
locationobject
accessPolicystring
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburse
accountIdstring
addressstring
auditEntiresboolean
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
authorizationTypesstring[]
connectorsobject[]
evse_idstring
uidstring
facilitiesstring[]
geoLocationobject
coordinatesobjectREQUIRED
typestringREQUIRED
hasTariffInfoboolean
idstring
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestring
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
partyIdstring
postalCodestring
postal_codestring
powerTypestring
providerContextstring
msp
providerIdstring
publishboolean
publishingModestring
privatepublic
sourcestring
cpoeclearingocpiroad-cpo-internal
statusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
tariffCountryCodestring
tariffPartyIdstring
timestampsboolean
timezonestring
typestring
userIdstring
locationIdstring
migrationAtstring <date-time>
migrationIdstring
mspLocationobject
mspSessionobject
accountIdstring
authTypestring
AUTH_REQUESTCOMMANDWHITELIST
authorizationReferencestring
billingInfoBillingInfo
locationAccessPolicystring
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburse
usageReimbursementobject[]
billingPlanIdstring
calculatedDiscountnumber
calculatedPricenumber
calculatedPriceTypestring
cdrIdstring
cdrSyncedToRoamingNetworkAtstring <date-time>
chargePointIdstring
chargingFinishedAtstring <date-time>
connectorIdstring
connectorTypestring
costSettingOverrideobject
cpoEvseControllerIdstring
cpoProviderIdstring
cpoProviderNamestring
createdAtstring <date-time>
creditSessionIdstring
currencystring
debitInvoiceIdstring
debitInvoiceIdsstring[]
deletedboolean
deletedAtstring <date-time>
dischargedKwhnumber
durationSecondsnumber
eligibleIdleMinutesnumber
endedAtstring <date-time>
energyCostsnumber
evseControllerIdstring
evsePaymentTerminalSessionIdstring
exchangeRateCheckedboolean
exchangeRateIdstring
excludedboolean
excludedReasonstring
externalCalculatedPricenumber
externalCalculatedPriceOverridenboolean
externalIdstring
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
externalProviderIdstring
externalUniqueIdstring
fraudDetectionobject
fraudDetectionCompletedboolean
hadConcurrentTxboolean
idstring
idleCostsnumber
importBatchIdstring
importSourcestring
infraProviderIdstring
integrityValidationobject
integrityValidationCompletedboolean
invoiceIdstring
isSimulatedboolean
kwhnumber
limitSessionLimit
maxIdleCostsSessionCostLimit
maxTimeCostsSessionCostLimit
maxTotalCostsSessionCostLimit
locationobject
addressstring
citystring
countryCodestring
postalCodestring
locationBillingPlanIdstring
locationIdstring
mspLocationIdstring
mspPaymentMSPPaymentSession
exchangeRateIdstring
feesobject
paymentReceiptIdstring
sessionCostsAmountBSONMoneyREQUIRED
totalAmountBSONMoneyREQUIRED
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalLocationIdstring
ocppVersionstring
operatorPlatformAuthorizationOperatorPlatformAuthorization
idstringREQUIRED
targetedPaymentOptionstring
CHARGE_CARDSCAN_TO_PAYTAP_TO_PAY
tariffConfigurationIdstring
tariffIdstring
paymentPolicystring
deferredimmediate
powerTypestring
acdc
providerContextstring
msp
providerIdstring
rawRecordobject
advancedCostsobject
cancelledByCredentialIdstring
cancelledByUserIdstring
chargingStatestring
ChargingEVConnectedIdleSuspendedEVSuspendedEVSE
connectorInfoEvseControllerConnector
costSettingobject
dischargeMeterStartnumber
dischargeMeterStopnumber
evseIdstring
initializedboolean
internalTokenobject
locationInfoobject
meterLastReceivedAtstring <date-time>
meterLastSamplenumber
meterLastTimestampstring
meterStartnumber
meterStopnumber
ocppConnectorIdnumber
ocppEvseIdnumber
ocppTransactionIdstring
signedDataSignedMeterData
signedMeterDataSignedMeterData[]
startTransactionReceivedAtstring <date-time>
stopTimestampstring
stopTransactionReceivedAtstring <date-time>
tokenAuthIdstring
tokenCustomIdstring
tokenInfraProviderIdstring
tokenIssuerNamestring
tokenTypestring
reimbursementobject
excludedReasonstring
AUTHORIZED_NON_BILLABLE_RFIDEXTERNAL_PAYMENT_FAILEDEXTERNAL_PAYMENT_SOLUTIONEXTERNAL_REIMBURSEMENTHISTORICAL_ENDINVALID_SESSIONMANUAL_EXCLUSIONNO_AUTO_REIMBURSEMENTNO_COSTTEMPORARILY_EXCLUDED_WAITING_FOR_MISSING_DATAUNSPECIFIED
hasDedicatedReimbursementRecordsboolean
isFundingCollectedExternallyboolean

if funds decision comes from an external entity

isIncludedboolean

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

isIncludedReceivedAtstring <date-time>

When reimbursement decision comes from an external service

relatedConcurrentSessionsstring[]
remoteSessionIdstring
roamingCdrDeliveryReceiptobject
errorstring
receivedAtstring <date-time>
statusstring
DELIVEREDFAILED
timestampstring <date-time>
serviceExternalIdstring
serviceExternalProviderIdstring
startCostsnumber
startedAtstring <date-time>
stateOfChargenumber
statusstring
syncobject
ocpiobject
syncEclearingStatusobject
syncHasErrorsboolean
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timeCostsnumber
tokenBillingPlanIdstring
tokenContractIdstring
tokenIdstring
tokenInfraProviderIdstring
tokenTypestring
tokenUidstring
totalCostnumber
totalPricenumber
unauthorizedstring
updatedAtstring <date-time>
userIdstring
validityobject
invalidReasonstring
DUPLICATEDFAILED_TO_STARTHIGH_ENERGY_USAGEIMPROBABLE_ENERGY_USAGEINTERNAL_TOKENINVALID_END_TIMEINVALID_START_TIMELOW_ENERGY_USAGEMAINTENANCE_TOKENMANUAL_CANCELLATIONMISSING_OR_INVALID_SESSIONNON_ACCEPTED_AUTHREPLACED_WITH_CORRECTED_SESSIONSHORT_DURATIONUNKNOWN_METER_VALUESUNSPECIFIED
isValidbooleanREQUIRED
vatInfoVatRule
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
mspSessionIdstring
ocpiCredentialIdstring
ocpiExternalLocationIdstring
partyIdstring
paymentIdstring
paymentTypestring
AD_HOC_TOKENPSP_PREAUTHTOKEN
paymentVoidScheduledAtstring <date-time>
providerContextstringREQUIRED
msp
providerIdstringREQUIRED
statusstring
ACTIVECANCELLEDCOMPLETEDERRORPENDINGSTARTINGSTOPPEDSTOPPING
statusChangedAtstring <date-time>
stopRequestedAtstring <date-time>
tariffCurrencystring
tokenCustomIdstring
tokenIdstring
tokenUidstring
transactionIdstring
updatedAtstring <date-time>
userIdstring
virtualTokenIdstring
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