API for EVerest API clients implementing session cost.
default local MQTT
The ID of the module as defined in the EVerest config file.
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
The tariff message
Message containing cost information
Transaction id of ocpp.
To which token this message is bound.
The identifier type
Message with session price information to show the user.
Format of the message to be displayed
Additional properties are allowed.
{
"ocpp_transaction_id": "string",
"identifier_id": "string",
"identifier_type": "IdToken",
"messages": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
]
}
Direction: Module to EVerest
Available only on servers:
Accepts the following message:
The session cost record
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energie Wh import) for the start of this chunk
Metervalue (energie Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
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".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
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".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
{
"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"
}
Accepts the following message:
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Heartbeat
Accepts the following message:
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
CommunicationCheck
The tariff message
Message containing cost information
Transaction id of ocpp.
To which token this message is bound.
The identifier type
Message with session price information to show the user.
Format of the message to be displayed
Additional properties are allowed.
The session cost record
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energie Wh import) for the start of this chunk
Metervalue (energie Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
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".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
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".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
Charging price for a category
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Cost category
Currency in 3 alphabetical characters according to ISO 4217.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
Price components when idle
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".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
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".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energie Wh import) for the start of this chunk
Metervalue (energie Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
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".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
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".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
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.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
A chunk of the session cost. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energie Wh import) for the start of this chunk
Metervalue (energie Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message containing cost information
Transaction id of ocpp.
To which token this message is bound.
The identifier type
Message with session price information to show the user.
Format of the message to be displayed
Additional properties are allowed.
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached