api/pricing - single evse id
The single evse id endpoint creates a pricing structure for one evse id and authentication media combination. The endpoint accepts the following parameters
Parameter |
Required |
Description |
|---|---|---|
evseId |
yes |
Compliant with the following to calculate the stepCosts: specification for EVSE ID from “eMI3”. e.g. BE-BEC-E041503001” |
tag_id, emaid, authendicationUuid |
yes |
Tag Id, emaid or uuid from the card/token - only one of those three can be used at once |
consumption |
no |
fictional consumption in Wh which will be used in the calculation. If left empty no calculation will be done |
duration, duration_in_minutes |
no |
total duration in seconds or minutes. If left empty no calculation will be done |
currency |
no |
desired currency. If left empty default settings will be used |
include_tax |
no |
includes the tax which would be used for this cost rate (tax field will be not present if not set to true) |
next_price |
no |
set to |
Response contains a Rate object.
Sample Request for a single evse id
Parameter |
Value |
Description |
|---|---|---|
evseId |
DE*EEE*E000001 |
|
tag_id |
SOMETHING |
|
consumption |
90000 |
in Wh which are 90KWh |
duration |
1000 |
value in seconds |
curl --location --request GET 'https://yourinstancename.beenergised.cloud/api/pricing/?evseId=DE*EEE*E000001&tag_id=SOMETHING&consumption=90000&duration=1000' \
--header 'x-api-token: your_token'
{
"rateName": "Standard-Verkaufstarif eMSP",
"costId": 2206,
"currency": "EUR",
"localCurrency": "EUR",
"costTotalLocalCurrency": 38.42,
"currencyConversionRate": 1,
"costTotal": 38.42,
"costTime": 0,
"costPower": 36,
"costSessionFee": 2.42,
"priceStructure": {
"energy": {
"unit": "Wh",
"elements": [
{
"intervalChange": 100,
"stepCosts": 0,
"intervalCosts": 0
},
{
"intervalChange": 101,
"stepCosts": 0.0404,
"intervalCosts": 40.4
},
{
"intervalChange": 102,
"stepCosts": 0.0004,
"intervalCosts": 0.4
},
{
"intervalChange": 100000,
"stepCosts": 35.9592,
"intervalCosts": 0.4
}
]
},
"time": {
"unit": "min",
"elements": []
},
"sessionFee": {
"value": 2.42,
"gracePeriod": {
"unit": "sec",
"value": 12
},
"minimumEnergyConsumption": {
"unit": "Wh",
"value": 5.34
}
}
}
}
Sample Request for a single evse id with a desired currency
Parameter |
Value |
Description |
|---|---|---|
evseId |
CH*CHI*E00193 |
|
tag_id |
SOMETHING |
|
consumption |
80000 |
in Wh which are 80KWh |
duration |
1 |
value in seconds |
currency |
CHF |
currency following the ISO standard |
curl --location --request GET 'https://yourinstancename.beenergised.cloud/api/pricing/?evseId=CH*CHI*E00193&tag_id=SOMETHING&consumption=80000&duration=1¤cy=CHF' \
--header 'x-api-token: your_token'
{
"rateName": "Standard-Verkaufstarif eMSP",
"costId": 2020,
"currency": "CHF",
"localCurrency": "EUR",
"costTotalLocalCurrency": 57.913,
"currencyConversionRate": 1.0642,
"costTotal": 54.42,
"costTime": 0,
"costPower": 52,
"costSessionFee": 2.42,
"priceStructure": {
"energy": {
"unit": "Wh",
"elements": [
{
"intervalChange": 100,
"stepCosts": 0,
"intervalCosts": 0
},
{
"intervalChange": 101,
"stepCosts": 0.06565,
"intervalCosts": 65.65
},
{
"intervalChange": 102,
"stepCosts": 51.93435,
"intervalCosts": 0.65
}
]
},
"time": {
"unit": "min",
"elements": []
},
"sessionFee": {
"value": 2.42,
"gracePeriod": {
"unit": "sec",
"value": 12
},
"minimumEnergyConsumption": {
"unit": "Wh",
"value": 5.34
}
}
}
}
How to calculate the stepCosts?
{
"intervalChange": 102,
"stepCosts": 51.93435,
"intervalCosts": 0.65
}
stepConsumption = consumption - consumptionLastStep = 80000 Wh - 101 Wh= 79899 Wh = 79,899 kWh
intervalCost = stepConsumption * intervalCosts = 79,899 kWh * 0,65 CHF/kWh = CHF 51,93435
Sample Request for a dynamic rate
For a dynamic rate the response carries the applied schedule entry: its
scheduleUuid and validity, and pricingType 1 (recurring)
or 2 (unique). The entry is the one active at the time of the request.
Static rates return pricingType 0 with scheduleUuid and
validity null. The example below is a recurring rate queried during its
Thursday 00:00-08:00 slot.
Parameter |
Value |
Description |
|---|---|---|
evseId |
RO*PET*E1071DC6113 |
|
tag_id |
SOMETHING |
curl --location --request GET 'https://yourinstancename.beenergised.cloud/api/pricing/?evseId=RO*PET*E1071DC6113&tag_id=SOMETHING' \
--header 'x-api-token: your_token'
{
"rateName": "Dynamic Tariff",
"costId": 3120,
"costRateUuid": "b1e0c7a2-1f4d-4c9a-9b2e-2a7d5f0c1e34",
"pricingType": 1,
"currency": "EUR",
"localCurrency": "EUR",
"costTotalLocalCurrency": null,
"currencyConversionRate": 1,
"costTotal": null,
"costTime": null,
"costPower": null,
"costSessionFee": null,
"priceStructure": {
"energy": {
"unit": "Wh",
"elements": [
{
"intervalChange": 0,
"stepCosts": null,
"intervalCosts": 0.3
}
]
},
"time": {
"unit": "min",
"elements": []
},
"sessionFee": {
"value": 0,
"gracePeriod": {
"unit": "sec",
"value": 0
},
"minimumEnergyConsumption": {
"unit": "Wh",
"value": 0
}
}
},
"scheduleUuid": "3f6b2a10-8c4e-4d21-9f0a-1b2c3d4e5f60",
"validity": {
"type": "recurring",
"weekdays": [
{
"uuid": "a2c4e6f8-0b1d-4357-9ace-bdf013572468",
"weekday": 4,
"weekday_name": "THU",
"start_time": "00:00",
"end_time": "08:00"
}
]
}
}
Sample Request for a dynamic rate with the next price
With next_price=true the response adds a nextPrice block for the next
applicable schedule entry — its scheduleUuid, validity and full
priceStructure. The block is present only when a following entry exists.
Here the next slot is Thursday 08:00–10:00.
Parameter |
Value |
Description |
|---|---|---|
evseId |
RO*PET*E1071DC6113 |
|
tag_id |
SOMETHING |
|
next_price |
true |
include the next applicable price |
curl --location --request GET 'https://yourinstancename.beenergised.cloud/api/pricing/?evseId=RO*PET*E1071DC6113&tag_id=SOMETHING&next_price=true' \
--header 'x-api-token: your_token'
{
"rateName": "Dynamic Tariff",
"costId": 3120,
"costRateUuid": "b1e0c7a2-1f4d-4c9a-9b2e-2a7d5f0c1e34",
"pricingType": 1,
"currency": "EUR",
"localCurrency": "EUR",
"costTotalLocalCurrency": null,
"currencyConversionRate": 1,
"costTotal": null,
"costTime": null,
"costPower": null,
"costSessionFee": null,
"priceStructure": {
"energy": {
"unit": "Wh",
"elements": [
{
"intervalChange": 0,
"stepCosts": null,
"intervalCosts": 0.3
}
]
},
"time": {
"unit": "min",
"elements": []
},
"sessionFee": {
"value": 0,
"gracePeriod": {
"unit": "sec",
"value": 0
},
"minimumEnergyConsumption": {
"unit": "Wh",
"value": 0
}
}
},
"scheduleUuid": "3f6b2a10-8c4e-4d21-9f0a-1b2c3d4e5f60",
"validity": {
"type": "recurring",
"weekdays": [
{
"uuid": "a2c4e6f8-0b1d-4357-9ace-bdf013572468",
"weekday": 4,
"weekday_name": "THU",
"start_time": "00:00",
"end_time": "08:00"
}
]
},
"nextPrice": {
"scheduleUuid": "7a1c9d84-2e5f-4b03-8c16-9d0e1f2a3b4c",
"validity": {
"type": "recurring",
"weekdays": [
{
"uuid": "c4e6a8b0-1d3f-4681-a3c5-e7f90b2d4f68",
"weekday": 4,
"weekday_name": "THU",
"start_time": "08:00",
"end_time": "10:00"
}
]
},
"priceStructure": {
"energy": {
"unit": "Wh",
"elements": [
{
"intervalChange": 0,
"stepCosts": null,
"intervalCosts": 0.5
}
]
},
"time": {
"unit": "min",
"elements": []
},
"sessionFee": {
"value": 0,
"gracePeriod": {
"unit": "sec",
"value": 0
},
"minimumEnergyConsumption": {
"unit": "Wh",
"value": 0
}
}
}
}
}
Sample Request for a single evse id with tax
Parameter |
Value |
Description |
|---|---|---|
evseId |
CH*CHI*E00193 |
|
tag_id |
SOMETHING |
|
include_tax |
add tax to price structure |
curl --location --request GET 'https://yourinstancename.beenergised.cloud/api/pricing/?evseId=CH*CHI*E00193&tag_id=SOMETHING&include_tax' \
--header 'x-api-token: your_token'
{
"rateName": "Standard-Verkaufstarif eMSP",
"costId": 2020,
"currency": "CHF",
"localCurrency": "EUR",
"costTotalLocalCurrency": 57.913,
"currencyConversionRate": 1.0642,
"costTotal": 52,
"costTime": 0,
"costPower": 52,
"costSessionFee": 2.42,
"priceStructure": {
"energy": {
"unit": "Wh",
"elements": [
{
"intervalChange": 100,
"stepCosts": 0,
"intervalCosts": 0
},
{
"intervalChange": 101,
"stepCosts": 0.06565,
"intervalCosts": 65.65
},
{
"intervalChange": 102,
"stepCosts": 51.93435,
"intervalCosts": 0.65
}
],
"tax": 1.87
},
"time": {
"unit": "min",
"elements": [],
"tax": 1.24
},
"sessionFee": {
"value": 2.42,
"gracePeriod": {
"unit": "sec",
"value": 12,
},
"minimumEnergyConsumption": {
"unit": "Wh",
"value": 5.34,
}
}
}
}