Charging Policies (beta)

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/charging-policies

Create Charging Policy

Authorization
User sessionAPI credential
Permissions
charging-policies:write
OAuth
-
Request
Request bodyapplication/json
associatedChargingGroupIdsstring[]REQUIRED
currencystringREQUIRED
descriptionstring
labelstringREQUIRED
sessionLimitsobject
maxTotalCostnumber
tariffRulesobject[]REQUIRED
customerGroupIdsstring[]REQUIRED
labelstring
paymentOptionsstring[]
publishToPlatformsstring[]
tariffConfigurationobjectREQUIRED
configurationobjectREQUIRED
componentsobject[]REQUIRED
descriptionsobject[]
idstring
idstring
marketEnergyPricingobject
deliveryAreastringREQUIRED
AUTBELDEUFRANLD
providerIdstring
validityPeriodobject
enabledbooleanREQUIRED
endinteger | any
startinteger | any
Responses
201Created application/json
dataobject
idstringREQUIRED
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/charging-policies/order

Get Charging Policy Order

Authorization
User sessionAPI credential
Permissions
charging-policies:read
OAuth
-
Responses
200Charging Policy Order application/json
dataChargingPolicyOrder
chargingPolicyIdsstring[]REQUIRED
versionnumberREQUIRED
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
PUT/1/charging-policies/order

Reorder Charging Policies

Authorization
User sessionAPI credential
Permissions
charging-policies:write
OAuth
-
Request
Request bodyapplication/json
chargingPolicyIdsstring[]REQUIRED
versionintegerREQUIRED
min 0max 4294967295
Responses
200Reordered application/json
dataChargingPolicyOrderVersion
versionnumberREQUIRED
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
409The order changed since it was loaded, or chargingPolicyIds is not exactly the prioritised policies of the owner. error.type is CHARGING_POLICY_ORDER_CONFLICT. Load the order again and retry. application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/charging-policies/search

Search Charging Policies

Authorization
User sessionAPI credential
Permissions
charging-policies:read
OAuth
-
Request
Query parameters1
includestring
Request bodyapplication/json
associatedChargingGroupIdsstring[]
createdAtany | any
$gtestring <date-time>
$ltestring <date-time>
currenciesstring[]
customerGroupIdsstring[]
includeAccountPoliciesboolean
limitinteger
default 50min 1
paymentOptionsstring[]
querystring
skipinteger
default 0min 0
tariffPriceTypesstring[]
Responses
200Charging Policies application/json
dataPopulatedChargingPolicy[]
accountIdstring
associatedChargingGroupIdsstring[]
associatedChargingGroupsChargingGroup[]
accountIdstring
createdAtstring <date-time>REQUIRED
descriptionstring
filtersChargingGroupFilter[]REQUIRED
accountIdsChargingGroupFilterAccountIDs
connectorsChargingGroupFilterConnectors
locationIdsChargingGroupFilterLocationIDs
idstringREQUIRED
labelstringREQUIRED
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
associatedConnectorsChargingPolicyConnectorAssociation[]
chargingStationIdstringREQUIRED
ocppConnectorIdnumberREQUIRED
ocppEvseIdnumberREQUIRED
createdAtstring <date-time>REQUIRED
currencystringREQUIRED
descriptionstring
idstringREQUIRED
labelstringREQUIRED
prioritynumber
providerIdstringREQUIRED
sessionLimitsSessionLimits
maxTotalCostnumber
tariffRulesPopulatedTariffRule[]REQUIRED
customerGroupIdsstring[]
customerGroupsEmbeddedCustomerGroup[]
accountIdstring
createdAtstring <date-time>REQUIRED
descriptionstring
filtersCustomerGroupFilter[]REQUIRED
idstringREQUIRED
labelstringREQUIRED
providerobjectREQUIRED
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
labelstring
paymentOptionsstring[]
publishToPlatformsstring[]
tariffConfigurationTariffConfiguration
configurationTariffREQUIRED
createdAtstring <date-time>REQUIRED
idstringREQUIRED
marketEnergyPricingMarketEnergyPricing
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
tariffConfigurationIdstring
validityPeriodobject
enabledbooleanREQUIRED
endstring <date-time>
startstring <date-time>
updatedAtstring <date-time>REQUIRED
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/charging-policies/{id}

Get Charging Policy

Authorization
User sessionAPI credential
Permissions
charging-policies:read
OAuth
-
Request
Path parameters1
idstringREQUIRED
Query parameters1
includestring
Responses
200Charging Policy application/json
dataPopulatedChargingPolicy
accountIdstring
associatedChargingGroupIdsstring[]
associatedChargingGroupsChargingGroup[]
accountIdstring
createdAtstring <date-time>REQUIRED
descriptionstring
filtersChargingGroupFilter[]REQUIRED
accountIdsChargingGroupFilterAccountIDs
connectorsChargingGroupFilterConnectors
locationIdsChargingGroupFilterLocationIDs
idstringREQUIRED
labelstringREQUIRED
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
associatedConnectorsChargingPolicyConnectorAssociation[]
chargingStationIdstringREQUIRED
ocppConnectorIdnumberREQUIRED
ocppEvseIdnumberREQUIRED
createdAtstring <date-time>REQUIRED
currencystringREQUIRED
descriptionstring
idstringREQUIRED
labelstringREQUIRED
prioritynumber
providerIdstringREQUIRED
sessionLimitsSessionLimits
maxTotalCostnumber
tariffRulesPopulatedTariffRule[]REQUIRED
customerGroupIdsstring[]
customerGroupsEmbeddedCustomerGroup[]
accountIdstring
createdAtstring <date-time>REQUIRED
descriptionstring
filtersCustomerGroupFilter[]REQUIRED
idstringREQUIRED
labelstringREQUIRED
providerobjectREQUIRED
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
labelstring
paymentOptionsstring[]
publishToPlatformsstring[]
tariffConfigurationTariffConfiguration
configurationTariffREQUIRED
createdAtstring <date-time>REQUIRED
idstringREQUIRED
marketEnergyPricingMarketEnergyPricing
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
tariffConfigurationIdstring
validityPeriodobject
enabledbooleanREQUIRED
endstring <date-time>
startstring <date-time>
updatedAtstring <date-time>REQUIRED
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
PUT/1/charging-policies/{id}

Update Charging Policy

Authorization
User sessionAPI credential
Permissions
charging-policies:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Request bodyapplication/json
associatedChargingGroupIdsstring[]REQUIRED
currencystringREQUIRED
descriptionstring
idstring
labelstringREQUIRED
sessionLimitsobject
maxTotalCostnumber
tariffRulesobject[]REQUIRED
customerGroupIdsstring[]REQUIRED
labelstring
paymentOptionsstring[]
publishToPlatformsstring[]
tariffConfigurationobjectREQUIRED
configurationobjectREQUIRED
componentsobject[]REQUIRED
descriptionsobject[]
idstring
idstring
marketEnergyPricingobject
deliveryAreastringREQUIRED
AUTBELDEUFRANLD
providerIdstring
validityPeriodobject
enabledbooleanREQUIRED
endinteger | any
startinteger | any
Responses
204Updated 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
DELETE/1/charging-policies/{id}

Delete Charging Policy

Authorization
User sessionAPI credential
Permissions
charging-policies:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
204Deleted 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