Session
Represents a charging session. A session captures all data related to a single charging event, from start to finish.
Field for the caller (EMSP) to include an internal reference. Can be used for reconciling OMNI sessions with the EMSP's own database.
Internal identifier for the connector used in this session.
Unique identifier of the connector used in this session.
ISO-3166 alpha-2 country code of the CPO that owns the location.
ISO-4217 code of the currency used for this session.
The timestamp when the session ended. Format: RFC3339 in UTC timezone. Null if session is still active.
Unique identifier of the EVSE used in this session.
The EVSE ID (Charge Box ID) from the CSMS.
Unique identifier of the session. Format: UUID string.
Total energy consumed during the session in kWh.
Timestamp when this session was last updated. Format: RFC3339 in UTC timezone.
Unique identifier of the location where the session took place.
Identifier of the energy meter used during the session (if available).
The timestamp when the session was started. Format: RFC3339 in UTC timezone.
The status of the session.
| Value | Description |
|---|---|
| PENDING | A request to begin a charging session with no definitive outcome yet |
| RESERVATION | A successful reservation of a particular EVSE/connector is in progress |
| ACTIVE | At least one active charging period in which a vehicle is drawing energy is in progress |
| STOPPED | Energy consumption portion has stopped (Deprecated) |
| COMPLETED | The whole charging session including any post-charging period has been completed |
| RESERVATION_FAILURE | Reserving an EVSE/connector has failed |
| START_FAILURE | Starting an EVSE/connector has definitively failed |
| PENDING_COMPLETION | Session is detected to have ended on the charger, but data such as cost and meter values have not been finalized |
| INVALID | CPO reports that the session is invalid and will not be billed |
total_cost Price
Method used to authenticate this session. Enum: AUTH_REQUEST, COMMAND, WHITELIST.
cdr_token CdrToken
Token information associated with a charging session. Identifies the user and their authorization method.
Unique identifier of the token.
External identifier of the token from the EMSP system.
Entity code of the EMSP that issued this token.
Protocol used for this token (e.g., VoltNow, VoltPOS, OCPI).
Type of user associated with this token.
Contract ID associated with this token.
VoltNet tokenized user ID representation.
License plate of the vehicle associated with this token.
charging_periods ChargingPeriod[]
List of charging periods that make up this session. Each period has its own tariff_element applied.
Unique identifier of the charging period.
UID of the session this charging period belongs to.
Timestamp when this period started. Format: RFC3339 in UTC timezone.
dimensions CdrDimension[]
List of dimensions that describe the volume charged during this period.
Type of CDR dimension. Based on OCPI 2.2.1 CdrDimensionType.
| Value | Description | Unit |
|---|---|---|
| CURRENT | Average charging current (Session only) | A |
| ENERGY | Total energy charged/discharged | kWh |
| ENERGY_EXPORT | Energy fed back to grid (Session only) | kWh |
| ENERGY_IMPORT | Energy charged (Session only) | kWh |
| MAX_CURRENT | Maximum current over all phases | A |
| MIN_CURRENT | Minimum current over all phases | A |
| MAX_POWER | Maximum power reached | kW |
| MIN_POWER | Minimum power reached | kW |
| PARKING_TIME | Time not charging | hours |
| POWER | Average power (Session only) | kW |
| RESERVATION_TIME | Time reserved but not in use | hours |
| STATE_OF_CHARGE | EV state of charge (Session only) | % |
| TIME | Time charging | hours |
| OVERTIME | Time exceeding timebelt reservation | hours |
| OVERTIME_GRACE | Grace period before overtime | hours |
| OVERTIME_FLAT | Flat penalty for exceeding timebelt | - |
| RESERVATION_FLAT | Flat fee for reservation | - |
| VOLTAGE | Voltage at point in time | V |
UID of the tariff applied during this period.
Entity code of the EMSP that owns this session.
Meter reading at the start of the session in kWh.
Meter reading at the end of the session in kWh.
volumes Volumes
for now we only store volumes that were charged by non-free prices. Can be extended.
costs_by_type CostsByType
energy Price
time Price
flat Price
parking_time Price
reservation_time Price
reservation_flat Price
platform_flat Price
reservation_overtime Price
reservation ReservationSummary
Reason the session was stopped.
tariffs Tariff[]
List of tariffs applied to this session.
ISO-3166 alpha-2 country code where this tariff applies.
ISO-4217 currency code for this tariff.
Unique identifier for the tariff.
Start date/time when this tariff becomes active. Format: RFC3339 in UTC timezone.
End date/time when this tariff expires. Format: RFC3339 in UTC timezone.
min_price Price
max_price Price
Type of tariff (e.g., AD_HOC_PAYMENT, REGULAR).
price_per_kwh Price
price_per_min Price
price_flat Price
price_per_min_parked Price
Maximum price per minute for idle time.
Grace period in seconds before idle charges begin.
idle_blackout_period IdleBlackoutPeriod
price_modifiers OMNIPriceModifier[]
List of price modifiers that can adjust the base tariff.
Seconds before grace period ends to send notification.
elements TariffElement[]
List of tariff elements with time/power restrictions.
price_components PriceComponent[]
restrictions TariffRestrictions
tariff_alt_text DisplayText[]
Human-readable tariff description with i18n support.
ISO 639-1 language code (e.g., "en", "nl", "de").
The localized text content.
URL to a web page with more tariff information.
Maximum price threshold before stopping the session.
Minimum energy delta threshold for auto-stop.
Number of consecutive readings below threshold to trigger stop.
Time threshold in seconds to trigger auto-stop.
price_platform_flat Price
Entity code of the CPO that owns this tariff.
Timestamp when this tariff was last updated. Format: RFC3339 in UTC timezone.
Total energy consumed below this threshold is free, otherwise pricing applies.
Rounding policy snapshotted from the tariff owner.
price_per_min_booked Price
price_per_min_overtime Price
Human-readable string identifying the connector gun. Usually a short name such as "Gun A" or "Connector 1".
Indicates how min_price was handled for this session. Enum: TARIFF_MIN, MIN, IGNORE, CLIFF.
The minimum price applied to this session, if applicable.
External ID for this session (e.g., from CPO system).
Indicates the mechanism the user used to start the session. Enum: UNKNOWN_START_METHOD, OTHER_START_METHOD, APP_START, RFID_START, TRANSIENT_WEB, TRANSIENT_POS, ROAMING.
total_discount Price
Rounding policy snapshotted on the session.
External invoice reference associated with this session.
{
"client_reference": "string",
"connector_id": "string",
"connector_uid": "string",
"country_code": "string",
"currency": "string",
"end_date_time": "string",
"evse_uid": "string",
"evse_id": "string",
"uid": "string",
"kwh": 0,
"last_updated": "string",
"location_uid": "string",
"meter_id": "string",
"start_date_time": "string",
"status": "string",
"total_cost": {
"excl_vat": 0,
"incl_vat": 0
},
"auth_method": "string",
"cdr_token": {
"uid": "string",
"external_id": "string",
"entity_code": "string",
"protocol": "string",
"user_type": "string",
"contract_id": "string",
"user_id": "string",
"license_plate": "string"
},
"charging_periods": [
{
"uid": "string",
"session_uid": "string",
"start_date_time": "string",
"dimensions": [
{
"charging_period_uid": "string",
"type": "string",
"volume": 0,
"session_stage": "string"
}
],
"tariff_uid": "string"
}
],
"entity_code": "string",
"meter_value_start_kwh": 0,
"meter_value_end_kwh": 0,
"volumes": {
"total_time_charged_hr": 0,
"total_reservation_time_charged_hr": 0,
"total_energy_charged_kwh": 0,
"total_parking_time_charged_hr": 0
},
"costs_by_type": {
"energy": {
"excl_vat": 0,
"incl_vat": 0
},
"time": {
"excl_vat": 0,
"incl_vat": 0
},
"flat": {
"excl_vat": 0,
"incl_vat": 0
},
"parking_time": {
"excl_vat": 0,
"incl_vat": 0
},
"reservation_time": {
"excl_vat": 0,
"incl_vat": 0
},
"reservation_flat": {
"excl_vat": 0,
"incl_vat": 0
},
"platform_flat": {
"excl_vat": 0,
"incl_vat": 0
},
"reservation_overtime": {
"excl_vat": 0,
"incl_vat": 0
}
},
"reservation": {
"uid": "string",
"cpo_reservation_id": "string",
"emsp_reservation_id": "string",
"status": "string",
"starts_at": "string",
"expires_at": "string",
"updated_at": "string",
"ends_at": "string",
"reservation_type": "string"
},
"stop_reason": "string",
"tariffs": [
{
"country_code": "string",
"currency": "string",
"uid": "string",
"start_date_time": "string",
"end_date_time": "string",
"min_price": {
"excl_vat": 0,
"incl_vat": 0
},
"max_price": {
"excl_vat": 0,
"incl_vat": 0
},
"type": "string",
"price_per_kwh": {
"excl_vat": 0,
"incl_vat": 0
},
"price_per_min": {
"excl_vat": 0,
"incl_vat": 0
},
"price_flat": {
"excl_vat": 0,
"incl_vat": 0
},
"price_per_min_parked": {
"excl_vat": 0,
"incl_vat": 0
},
"max_price_per_min_parked": 0,
"grace_period_seconds": "string",
"idle_blackout_period": {
"day_of_week": [
"string"
],
"start_time_of_day": "string",
"end_time_of_day": "string"
},
"price_modifiers": [
{
"uid": "string",
"value": 0,
"type": "string",
"vat": 0,
"tariff_dimension_types": [
"string"
]
}
],
"grace_period_notification_seconds": 0,
"elements": [
{
"uid": "string",
"price_components": [
{
"type": "string",
"price": 0,
"vat": 0,
"step_size": "string"
}
],
"restrictions": {
"start_time": "string",
"end_time": "string",
"start_date": "string",
"end_date": "string",
"min_kwh": 0,
"max_kwh": 0,
"min_current": 0,
"max_current": 0,
"min_power": 0,
"max_power": 0,
"min_duration": "string",
"max_duration": "string",
"day_of_week": [
"string"
],
"reservation": "string",
"max_average_power": 0,
"reservation_min_kwh": 0,
"reservation_max_kwh": 0,
"advance_booking_days_min": "string",
"advance_booking_days_max": "string"
},
"session_stage": "string"
}
],
"tariff_alt_text": [
{
"language": "string",
"text": "string"
}
],
"tariff_alt_url": "string",
"max_price_threshold": 0,
"min_delta_wh_threshold": 0,
"consecutive_delta_below_threshold_to_stop": 0,
"time_threshold_to_stop_seconds": 0,
"price_platform_flat": {
"excl_vat": 0,
"incl_vat": 0
},
"entity_code": "string",
"last_updated": "string",
"min_charging_threshold_kwh": 0,
"rounding_mode": "string",
"price_per_min_booked": {
"excl_vat": 0,
"incl_vat": 0
},
"price_per_min_overtime": {
"excl_vat": 0,
"incl_vat": 0
}
}
],
"connector_physical_reference": "string",
"min_price_type": "string",
"min_price": 0,
"external_id": "string",
"start_method": "string",
"total_discount": {
"excl_vat": 0,
"incl_vat": 0
},
"is_voided": true,
"rounding_mode": "string",
"invoice_reference_id": "string"
}