Accounts

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.

POST/1/accounts

Create Account

Authorization
User sessionAPI credential
Permissions
accounts:write
OAuth
-
Request
Request bodyapplication/json
accountTierBillingPlanIdstring | null
accountTierBillingPlanRequestsobject[]
requestIdstring
requestedBillingPlanIdstring | null
requestedBillingPlanStatusstring
allowedBillingPlanIdsstring[]
allowedMspBillingPlanIdsstring[]
billingobject
accountHolderNamestring | null
addressstring
addressLine2string | null
bicNostring | null
citystring | null
countryCodestringREQUIRED
cpoReferenceTextstring | null
emailstring <email>
ibanNostring | null
mspReferenceTextstring | null
paymentMethodstringREQUIRED
autopaymanual
default autopay
postalCodestring | null
regionstring | null
sepaAcceptedboolean | null
default false
sepaAcceptedAtstring <date-time> | null
billingCountryCodestring
billingCurrencystring
chamberOfCommerceNostring | null
contactobject
emailstring <email>REQUIRED
firstNamestringREQUIRED
genderstring
femalemale
lastNamestringREQUIRED
phoneCountryCodestring | null
phoneNostring | null
creditBillingobject
accountHolderNamestring
addressstring | null
addressLine2string | null
bicNostring | null
citystring | null
countryCodestring | null
emailstring <email> | null
ibanNostring | null
postalCodestring | null
referenceTextstring | null
csmeClientIdsstring[]
defaultLangCodestring
enableApiAccessboolean
enableCPOboolean
enableDirectPaymentboolean
enableFieldServiceboolean
externalIdstring
fieldServiceobject
emailstring <email> | null
hasNoVatNoboolean
hasNoVatNoReasonstring | null
isInstallerAccountboolean
legacyIdstring
namestringREQUIRED
nonLegacyboolean
notifyEVSEIssuesboolean
notifyEVSEIssuesRecipientstring
paymentTermnumber
platformFeaturesstring[]
requestedCardsstring[]
signupCompletedboolean
trustTierinteger | null
min -1max 5
typestringREQUIRED
vatNostring | null
Responses
201Account Created application/json
dataAccountResource
activeUsersnumber
billingAccountBillingDetail
accountHolderNamestring
addressstring
addressLine2string
bankVerifiedAtstring <date-time>
bicNostring
citystring
countryCodestring
cpoReferenceTextstring
emailstring
emailVerifiedAtstring <date-time>
ibanNostring
mspReferenceTextstring
paymentMethodstring
autopaymanual
postalCodestring
regionstring
sepaAcceptedboolean
sepaAcceptedAtstring <date-time>
validBicboolean
validIbanboolean
verificationSourcestring
payBridge
billingCurrencystring
chamberOfCommerceNostring
contactAccountContactDetail
emailstring
emailVerifiedAtstring <date-time>
firstNamestring
lastNamestring
phoneCountryCodestring
phoneNostring
phoneNoVerifiedAtstring <date-time>
createdAtstring
creditBillingobject
creditNumericReferenceCodenumber
defaultChargingRestrictionIdstring
defaultLangCodestring
deletedboolean
enableApiAccessboolean
externalIdstring
featureFlagsstring[]
hasNoVatNoboolean
hasNoVatNoReasonstring
idstringREQUIRED
labelsstring[]
legacyIdstring
namestring
numericReferenceCodenumber
paymentTermnumber
platformFeaturesstring[]
providerIdstringREQUIRED
timeZonestring
trustTiernumber
typestringREQUIRED
updatedAtstring
uuidstring
vatNostring
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/1/accounts/search/fast

Search Accounts

Authorization
User sessionAPI credential
Permissions
accounts:read
OAuth
-
Request
Request bodyapplication/json
accountTierstring
accountTierBillingPlanstring
accountTierBillingPlansstring[]
accountTiersstring[]
billingCountriesstring[]
billingCurrenciesstring[]
countryCodestring
createdAtobject
$gtenumber | string <date-time>
$ltenumber | string <date-time>
externalIdstring
fromstring <date-time>
hasErrorsboolean
idstring
idsstring[]
importIdstring
includeDeletedboolean
includeParentProviderAccountsboolean
default false
isInstallerAccountboolean
default false
keywordsstring
labelsstring[]
limitnumber
default 50
maybeIncludeChildProviderAccountsboolean
default false
namestring
platformFeaturesstring[]
searchPhrasestring
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
tostring <date-time>
trustTiersnumber[]
typesstring[]
unqualifiedSyncboolean
Responses
200OK application/json
dataAccountResource[]
activeUsersnumber
billingAccountBillingDetail
accountHolderNamestring
addressstring
addressLine2string
bankVerifiedAtstring <date-time>
bicNostring
citystring
countryCodestring
cpoReferenceTextstring
emailstring
emailVerifiedAtstring <date-time>
ibanNostring
mspReferenceTextstring
paymentMethodstring
autopaymanual
postalCodestring
regionstring
sepaAcceptedboolean
sepaAcceptedAtstring <date-time>
validBicboolean
validIbanboolean
verificationSourcestring
payBridge
billingCurrencystring
chamberOfCommerceNostring
contactAccountContactDetail
emailstring
emailVerifiedAtstring <date-time>
firstNamestring
lastNamestring
phoneCountryCodestring
phoneNostring
phoneNoVerifiedAtstring <date-time>
createdAtstring
creditBillingobject
creditNumericReferenceCodenumber
defaultChargingRestrictionIdstring
defaultLangCodestring
deletedboolean
enableApiAccessboolean
externalIdstring
featureFlagsstring[]
hasNoVatNoboolean
hasNoVatNoReasonstring
idstringREQUIRED
labelsstring[]
legacyIdstring
namestring
numericReferenceCodenumber
paymentTermnumber
platformFeaturesstring[]
providerIdstringREQUIRED
timeZonestring
trustTiernumber
typestringREQUIRED
updatedAtstring
uuidstring
vatNostring
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/1/accounts/{account}

Get Account

Authorization
User sessionAPI credential
Permissions
accounts:read
OAuth
-
Request
Path parameters1
accountstringREQUIRED
Responses
200Account application/json
dataAccountResource
activeUsersnumber
billingAccountBillingDetail
accountHolderNamestring
addressstring
addressLine2string
bankVerifiedAtstring <date-time>
bicNostring
citystring
countryCodestring
cpoReferenceTextstring
emailstring
emailVerifiedAtstring <date-time>
ibanNostring
mspReferenceTextstring
paymentMethodstring
autopaymanual
postalCodestring
regionstring
sepaAcceptedboolean
sepaAcceptedAtstring <date-time>
validBicboolean
validIbanboolean
verificationSourcestring
payBridge
billingCurrencystring
chamberOfCommerceNostring
contactAccountContactDetail
emailstring
emailVerifiedAtstring <date-time>
firstNamestring
lastNamestring
phoneCountryCodestring
phoneNostring
phoneNoVerifiedAtstring <date-time>
createdAtstring
creditBillingobject
creditNumericReferenceCodenumber
defaultChargingRestrictionIdstring
defaultLangCodestring
deletedboolean
enableApiAccessboolean
externalIdstring
featureFlagsstring[]
hasNoVatNoboolean
hasNoVatNoReasonstring
idstringREQUIRED
labelsstring[]
legacyIdstring
namestring
numericReferenceCodenumber
paymentTermnumber
platformFeaturesstring[]
providerIdstringREQUIRED
timeZonestring
trustTiernumber
typestringREQUIRED
updatedAtstring
uuidstring
vatNostring
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
PATCH/1/accounts/{account}

Update Account

Authorization
User sessionAPI credential
Permissions
accounts:write
OAuth
-
Request
Path parameters1
accountstringREQUIRED
Request bodyapplication/json
accountTierBillingPlanIdstring | null
accountTierBillingPlanRequestsobject[]
requestIdstring
requestedBillingPlanIdstring | null
requestedBillingPlanStatusstring
allowedBillingPlanIdsstring[]
allowedMspBillingPlanIdsstring[]
billingobject
accountHolderNamestring | null
addressstring
addressLine2string | null
bicNostring | null
citystring | null
countryCodestringREQUIRED
cpoReferenceTextstring | null
emailstring <email>
ibanNostring | null
mspReferenceTextstring | null
paymentMethodstringREQUIRED
autopaymanual
default autopay
postalCodestring | null
regionstring | null
sepaAcceptedboolean | null
default false
sepaAcceptedAtstring <date-time> | null
billingCurrencystring
chamberOfCommerceNostring | null
contactobject
emailstring <email>REQUIRED
firstNamestringREQUIRED
genderstring
femalemale
lastNamestringREQUIRED
phoneCountryCodestring | null
phoneNostring | null
creditBillingobject
accountHolderNamestring
addressstring | null
addressLine2string | null
bicNostring | null
citystring | null
countryCodestring | null
emailstring <email> | null
ibanNostring | null
postalCodestring | null
referenceTextstring | null
csmeClientIdsstring[]
defaultLangCodestring
enableCPOboolean
enableDirectPaymentboolean
enableFieldServiceboolean
externalIdstring
fieldServiceobject
emailstring <email> | null
hasNoVatNoboolean
hasNoVatNoReasonstring | null
installerPartnerProgramobject
enabledboolean
endDatestring <date-time> | null
startDatestring <date-time>
isInstallerAccountboolean
labelsstring[]
legacyIdstring
namestring
nonLegacyboolean
notifyEVSEIssuesboolean
notifyEVSEIssuesRecipientstring
paymentTermnumber
platformFeaturesstring[]
requestedCardsstring[]
signupCompletedboolean
suboperatorSettingsobject
namestring | null
trustTierinteger
min -1max 5
trustTierAutoTransitionEnabledboolean
typestring
vatNostring | null
Responses
200Account application/json
dataAccountResource
activeUsersnumber
billingAccountBillingDetail
accountHolderNamestring
addressstring
addressLine2string
bankVerifiedAtstring <date-time>
bicNostring
citystring
countryCodestring
cpoReferenceTextstring
emailstring
emailVerifiedAtstring <date-time>
ibanNostring
mspReferenceTextstring
paymentMethodstring
autopaymanual
postalCodestring
regionstring
sepaAcceptedboolean
sepaAcceptedAtstring <date-time>
validBicboolean
validIbanboolean
verificationSourcestring
payBridge
billingCurrencystring
chamberOfCommerceNostring
contactAccountContactDetail
emailstring
emailVerifiedAtstring <date-time>
firstNamestring
lastNamestring
phoneCountryCodestring
phoneNostring
phoneNoVerifiedAtstring <date-time>
createdAtstring
creditBillingobject
creditNumericReferenceCodenumber
defaultChargingRestrictionIdstring
defaultLangCodestring
deletedboolean
enableApiAccessboolean
externalIdstring
featureFlagsstring[]
hasNoVatNoboolean
hasNoVatNoReasonstring
idstringREQUIRED
labelsstring[]
legacyIdstring
namestring
numericReferenceCodenumber
paymentTermnumber
platformFeaturesstring[]
providerIdstringREQUIRED
timeZonestring
trustTiernumber
typestringREQUIRED
updatedAtstring
uuidstring
vatNostring
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
DELETE/1/accounts/{account}

Soft delete Account

Authorization
User sessionAPI credential
Permissions
accounts:write
OAuth
-
Request
Path parameters1
accountstringREQUIRED
Responses
204Account deleted text/plain
Returns a file (Text).
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/1/accounts/{account}/restore

Restore soft deleted Account

Authorization
User sessionAPI credential
Permissions
accounts:write
OAuth
-
Request
Path parameters1
accountstringREQUIRED
Responses
204Account restored text/plain
Returns a file (Text).
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