EVerest API definition for session cost consumer 1.0.0 documentation

EVerest API definition for session cost consumer 1.0.0

Apache-2.0
application/json
ID: pionix:de:everest:session_cost_consumer_API

API for EVerest API clients which allows to access modules that implement session_cost.

#EVerest
#SessionCost

Servers

mqtt://localhost:1883/everest_api/1/session_cost_consumer/{module_id}mqttdefault
default local MQTT

object
module_id
required
string
The ID of the module as defined in the EVerest config file.

Operations

RECEIVE e2m/tariff_message
Operation IDreceive_tariff_message
Available only on servers:
- default
Accepts the following message:
Receive tariff messagetariff_message
Message to show tariff information
application/json
Message IDtariff_message
object
Message containing cost information

ocpp_transaction_id
string
Transaction id of ocpp.

identifier_id
string
To which token this message is bound.

identifier_type
string
The identifier type

Allowed values:
"IdToken"
"SessionId"
"TransactionId"
required
array<object>
Message with session price information to show the user.

format
string
Format of the message to be displayed

Allowed values:
"ASCII"
"HTML"
"URI"
"UTF8"
"QRCODE"
language
string
content
required
string
Additional properties are allowed.
Examples
{ "ocpp_transaction_id": "string", "identifier_id": "string", "identifier_type": "IdToken", "messages": [ { "format": "ASCII", "language": "string", "content": "string" } ] }

This example has been generated automatically.
RECEIVE e2m/session_cost
Operation IDreceive_session_cost
Available only on servers:
- default
Accepts the following message:
Receive session costsession_cost
Message to show session cost
application/json
Message IDsession_cost
object
Session cost object containing the total cost of the session and a list of chunks

object
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose

request_id
integer
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1

required
object
Type for an id token

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken: This has to be printable case insensitive ascii

type
required
string
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.

Allowed values:
"Central"
"eMAID"
"MacAddress"
"ISO14443"
"ISO15693"
"KeyCode"
"Local"
"NoAuthorization"
array<object>
A list of additional custom id tokens than can be used for providing additional information for validation

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken

type
required
string
[ 0 .. 50 ] characters
Custom type of the token

Additional properties are allowed.
object
Type for an id token

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken: This has to be printable case insensitive ascii

type
required
string
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.

Allowed values:
"Central"
"eMAID"
"MacAddress"
"ISO14443"
"ISO15693"
"KeyCode"
"Local"
"NoAuthorization"
array<object>
A list of additional custom id tokens than can be used for providing additional information for validation

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken

type
required
string
[ 0 .. 50 ] characters
Custom type of the token

Additional properties are allowed.
authorization_type
required
string
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process

Allowed values:
"OCPP"
"RFID"
"Autocharge"
"PlugAndCharge"
"BankCard"
array<integer>
A list of connector ids to which the authorization can be assigned

Items:
integer
>= 1
prevalidated
boolean
Indicates that the id token is already validated by the provider

certificate
string
<= 5500 characters
The X.509 certificated presented by EV and encoded in PEM format

array<object>
[ 1 .. 4 ] items
Contains the information needed to verify the EV Contract Certificate via OCSP

hashAlgorithm
required
string
Used algorithms for the hashes provided

Allowed values:
"SHA256"
"SHA384"
"SHA512"
issuerNameHash
required
string
<= 128 characters
Hashed value of the Issuer Distinguished Name

issuerKeyHash
required
string
<= 128 characters
Hashed value of the issuers public key

serialNumber
required
string
<= 40 characters
The serial number of the certificate

responderURL
required
string
<= 512 characters
This contains the responder URL

Additional properties are allowed.
session_id
required
string
The session id

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
array<object>
List of cost chunks. The total cost of the session is the sum of all chunks.

timestamp_from
string
format: date-time
Absolute timestamp for the start of this chunk in RFC3339 UTC format

timestamp_to
string
format: date-time
Absolute timestamp for the end of this chunk in RFC3339 UTC format

metervalue_from
integer
Metervalue (energy Wh import) for the start of this chunk

metervalue_to
integer
Metervalue (energy Wh import) for the end of this chunk

object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
category
string
Cost category

Allowed values:
"Energy"
"Time"
"FlatFee"
"Other"
object
Price components when idle

grace_minutes
integer
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".

object
Price object containing the currency and the value of money.

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
required
object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
array<object>
Charging prices.

category
string
Cost category

Allowed values:
"Energy"
"Time"
"FlatFee"
"Other"
object
Price object containing the currency and the value of money.

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
required
object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
Additional properties are allowed.
object
Pricing for the next period

timestamp_from
required
string
format: date-time
Time when these prices become active.

required
array<object>
Price components while charging

category
string
Cost category

Allowed values:
"Energy"
"Time"
"FlatFee"
"Other"
object
Price object containing the currency and the value of money.

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
required
object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
Additional properties are allowed.
object
Price components when idle

grace_minutes
integer
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".

object
Price object containing the currency and the value of money.

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
required
object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
status
required
string
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.

Allowed values:
"Running"
"Idle"
"Finished"
array<object>
Message to show to the user containing information about the price

format
string
Format of the message to be displayed

Allowed values:
"ASCII"
"HTML"
"URI"
"UTF8"
"QRCODE"
language
string
content
required
string
qr_code
string
QR Code with more information. For example when the charging is finished, to download the invoice from

Additional properties are allowed.
Examples
{ "id_tag": { "request_id": 0, "id_token": { "value": "string", "type": "Central", "additional_info": [ { "value": "string", "type": "string" } ] }, "parent_id_token": { "value": "string", "type": "Central", "additional_info": [ { "value": "string", "type": "string" } ] }, "authorization_type": "OCPP", "connectors": [ 1 ], "prevalidated": true, "certificate": "string", "iso15118CertificateHashData": [ { "hashAlgorithm": "SHA256", "issuerNameHash": "string", "issuerKeyHash": "string", "serialNumber": "string", "responderURL": "string" } ] }, "session_id": "string", "currency": { "code": "AED", "decimals": 0 }, "cost_chunks": [ { "timestamp_from": "2019-08-24T14:15:22Z", "timestamp_to": "2019-08-24T14:15:22Z", "metervalue_from": 0, "metervalue_to": 0, "cost": { "value": 0 }, "category": "Energy" } ], "idle_price": { "grace_minutes": 0, "hour_price": { "currency": { "code": "AED", "decimals": 0 }, "value": { "value": 0 } } }, "charging_price": [ { "category": "Energy", "price": { "currency": { "code": "AED", "decimals": 0 }, "value": { "value": 0 } } } ], "next_period": { "timestamp_from": "2019-08-24T14:15:22Z", "charging_price": [ { "category": "Energy", "price": { "currency": { "code": "AED", "decimals": 0 }, "value": { "value": 0 } } } ], "idle_price": { "grace_minutes": 0, "hour_price": { "currency": { "code": "AED", "decimals": 0 }, "value": { "value": 0 } } } }, "status": "Running", "message": [ { "format": "ASCII", "language": "string", "content": "string" } ], "qr_code": "string" }

This example has been generated automatically.
RECEIVE e2m/heartbeat
Operation IDreceive_heartbeat
Available only on servers:
- default
Accepts the following message:
Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
application/json
Message IDreceive_heartbeat
Payload
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

Examples
#1 Example
Heartbeat
42
SEND m2e/communication_check
Operation IDsend_communication_check
Available only on servers:
- default
Accepts the following message:
Send communication checksend_communication_check
Signal to EVerest that communication is good or check shall be stopped
application/json
Message IDsend_communication_check
Payload
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'

Examples
#1 Example
CommunicationCheck

Messages

#1Receive tariff messagereceive_tariff_message
Message to show tariff information
- application/json
Message IDreceive_tariff_message
object
Message containing cost information

ocpp_transaction_id
string
Transaction id of ocpp.

identifier_id
string
To which token this message is bound.

identifier_type
string
The identifier type

Allowed values:
"IdToken"
"SessionId"
"TransactionId"
required
array<object>
Message with session price information to show the user.

format
string
Format of the message to be displayed

Allowed values:
"ASCII"
"HTML"
"URI"
"UTF8"
"QRCODE"
language
string
content
required
string
Additional properties are allowed.
#2Receive session costreceive_session_cost
Message to show session cost
- application/json
Message IDreceive_session_cost
object
Session cost object containing the total cost of the session and a list of chunks

object
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose

request_id
integer
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1

required
object
Type for an id token

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken: This has to be printable case insensitive ascii

type
required
string
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.

Allowed values:
"Central"
"eMAID"
"MacAddress"
"ISO14443"
"ISO15693"
"KeyCode"
"Local"
"NoAuthorization"
array<object>
A list of additional custom id tokens than can be used for providing additional information for validation

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken

type
required
string
[ 0 .. 50 ] characters
Custom type of the token

Additional properties are allowed.
object
Type for an id token

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken: This has to be printable case insensitive ascii

type
required
string
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.

Allowed values:
"Central"
"eMAID"
"MacAddress"
"ISO14443"
"ISO15693"
"KeyCode"
"Local"
"NoAuthorization"
array<object>
A list of additional custom id tokens than can be used for providing additional information for validation

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken

type
required
string
[ 0 .. 50 ] characters
Custom type of the token

Additional properties are allowed.
authorization_type
required
string
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process

Allowed values:
"OCPP"
"RFID"
"Autocharge"
"PlugAndCharge"
"BankCard"
array<integer>
A list of connector ids to which the authorization can be assigned

Items:
integer
>= 1
prevalidated
boolean
Indicates that the id token is already validated by the provider

certificate
string
<= 5500 characters
The X.509 certificated presented by EV and encoded in PEM format

array<object>
[ 1 .. 4 ] items
Contains the information needed to verify the EV Contract Certificate via OCSP

hashAlgorithm
required
string
Used algorithms for the hashes provided

Allowed values:
"SHA256"
"SHA384"
"SHA512"
issuerNameHash
required
string
<= 128 characters
Hashed value of the Issuer Distinguished Name

issuerKeyHash
required
string
<= 128 characters
Hashed value of the issuers public key

serialNumber
required
string
<= 40 characters
The serial number of the certificate

responderURL
required
string
<= 512 characters
This contains the responder URL

Additional properties are allowed.
session_id
required
string
The session id

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
array<object>
List of cost chunks. The total cost of the session is the sum of all chunks.

timestamp_from
string
format: date-time
Absolute timestamp for the start of this chunk in RFC3339 UTC format

timestamp_to
string
format: date-time
Absolute timestamp for the end of this chunk in RFC3339 UTC format

metervalue_from
integer
Metervalue (energy Wh import) for the start of this chunk

metervalue_to
integer
Metervalue (energy Wh import) for the end of this chunk

object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
category
string
Cost category

Allowed values:
"Energy"
"Time"
"FlatFee"
"Other"
object
Price components when idle

grace_minutes
integer
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".

object
Price object containing the currency and the value of money.

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
required
object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
array<object>
Charging prices.

category
string
Cost category

Allowed values:
"Energy"
"Time"
"FlatFee"
"Other"
object
Price object containing the currency and the value of money.

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
required
object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
Additional properties are allowed.
object
Pricing for the next period

timestamp_from
required
string
format: date-time
Time when these prices become active.

required
array<object>
Price components while charging

category
string
Cost category

Allowed values:
"Energy"
"Time"
"FlatFee"
"Other"
object
Price object containing the currency and the value of money.

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
required
object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
Additional properties are allowed.
object
Price components when idle

grace_minutes
integer
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".

object
Price object containing the currency and the value of money.

required
object
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.

code
string
3 characters
Currency in 3 alphabetical characters according to ISO 4217.

Allowed values:
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BOV"
"BRL"
"BSD"
"BTN"
"BWP"
"BYN"
"BZD"
"CAD"
"CDF"
"CHE"
"CHF"
"CHW"
"CLF"
"CLP"
"CNY"
"COP"
"COU"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HTG"
"HUF"
"IDR"
"ILS"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MRU"
"MUR"
"MVR"
"MWK"
"MXN"
"MXV"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLE"
"SLL"
"SOS"
"SRD"
"SSP"
"STN"
"SVC"
"SYP"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"USN"
"UYI"
"UYU"
"UYW"
"UZS"
"VED"
"VES"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XDR"
"XOF"
"XPF"
"XSU"
"XUA"
"YER"
"ZAR"
"ZMW"
"ZWL"
decimals
integer
>= 0
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).

Additional properties are allowed.
required
object
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'

value
required
integer
The amount of minor units of the currency.

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
status
required
string
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.

Allowed values:
"Running"
"Idle"
"Finished"
array<object>
Message to show to the user containing information about the price

format
string
Format of the message to be displayed

Allowed values:
"ASCII"
"HTML"
"URI"
"UTF8"
"QRCODE"
language
string
content
required
string
qr_code
string
QR Code with more information. For example when the charging is finished, to download the invoice from

Additional properties are allowed.
#3Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
- application/json
Message IDreceive_heartbeat
Payload
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
#4Send communication checksend_communication_check
Signal to EVerest that communication is good or check shall be stopped
- application/json
Message IDsend_communication_check
Payload
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'

Schemas

CommunicationCheck
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
HeartBeatId
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

EVerest API definition for session cost consumer 1.0.0

Servers

Operations

RECEIVE e2m/tariff_message

Examples

This example has been generated automatically.

RECEIVE e2m/session_cost

Examples

This example has been generated automatically.

RECEIVE e2m/heartbeat

Examples

#1 Example

SEND m2e/communication_check

Examples

#1 Example

Messages

Schemas