Accepts one of the following messages:

• #0

  Message IDAdhocInvoiceCreated

  Payload

  Expand all

  object

  Event emitted when an ad-hoc invoice is created.

  contactUuid

  required

  string

  UUID of the contact the invoice belongs to

  transactionId

  required

  string

  UUID of the related charging session transaction

  invoiceId

  required

  string

  UUID of the created invoice

  number

  Expand all

  oneOf

  Invoice number

  Default value:null

  Adheres to <anonymous-schema-5>:

  string

  Or to <anonymous-schema-6>:

  null

  documentPdfLink

  required

  string

  URL to download the invoice PDF

  status

  Expand all

  oneOf

  Invoice status: draft, open, or closed

  Default value:null

  Adheres to <anonymous-schema-9>:

  string

  Or to <anonymous-schema-10>:

  null

  grossTotal

  Expand all

  oneOf

  Gross total of the invoice (invoice currency).

  Default value:null

  Adheres to com.chargepoint.beenergised.shared.Money:

  Expand all

  object

  A monetary value with explicit currency. When this record is present, both fields are populated; absence of a monetary value is signalled by the parent union resolving to null.

  amount

  required

  string

  must match: ^[-ÿ]*$

  Avro decimal(18,4): two's-complement big-endian unscaled integer.

  currency

  required

  string

  ISO 4217 currency code

  Additional properties are allowed.

  Or to <anonymous-schema-14>:

  null

  grossLocalCurrency

  Expand all

  oneOf

  Gross total in the mandant's local currency. Null when the invoice is not in a foreign currency.

  Default value:null

  Adheres to <anonymous-schema-16>:

  any

  Or to <anonymous-schema-17>:

  null

  netTotal

  Expand all

  oneOf

  Net total of the invoice (invoice currency).

  Default value:null

  Adheres to <anonymous-schema-19>:

  any

  Or to <anonymous-schema-20>:

  null

  netLocalCurrency

  Expand all

  oneOf

  Net total in the mandant's local currency. Null when the invoice is not in a foreign currency.

  Default value:null

  Adheres to <anonymous-schema-22>:

  any

  Or to <anonymous-schema-23>:

  null

  chargingSession

  Expand all

  required

  object

  Charging session associated with this invoice

  stationId

  Expand all

  oneOf

  UUID of the charging station

  Default value:null

  Adheres to <anonymous-schema-25>:

  string

  Or to <anonymous-schema-26>:

  null

  connectorId

  Expand all

  oneOf

  UUID of the connector

  Default value:null

  Adheres to <anonymous-schema-28>:

  string

  Or to <anonymous-schema-29>:

  null

  evseId

  Expand all

  oneOf

  EVSE ID of the connector

  Default value:null

  Adheres to <anonymous-schema-31>:

  string

  Or to <anonymous-schema-32>:

  null

  startUtc

  Expand all

  oneOf

  Session start time in UTC (ISO 8601)

  Default value:null

  Adheres to <anonymous-schema-34>:

  string

  Or to <anonymous-schema-35>:

  null

  endUtc

  Expand all

  oneOf

  Session end time in UTC (ISO 8601)

  Default value:null

  Adheres to <anonymous-schema-37>:

  string

  Or to <anonymous-schema-38>:

  null

  consumptionKwh

  Expand all

  oneOf

  Energy consumption in kWh

  Default value:null

  Adheres to <anonymous-schema-40>:

  number

  format: float

  Or to <anonymous-schema-41>:

  null

  Additional properties are allowed.

  invoiceLines

  Expand all

  required

  array<object>

  Invoice line items

  object

  A single line item on the invoice.

  id

  required

  integer

  [ -2147483648 .. 2147483647 ]

  Line item ID

  category

  Expand all

  oneOf

  Cost category: charging_process, fee, or others

  Default value:null

  Adheres to <anonymous-schema-45>:

  string

  Or to <anonymous-schema-46>:

  null

  name

  required

  string

  Line item name

  sku

  Expand all

  oneOf

  Stock keeping unit

  Default value:null

  Adheres to <anonymous-schema-49>:

  string

  Or to <anonymous-schema-50>:

  null

  description

  Expand all

  oneOf

  Line item description

  Default value:null

  Adheres to <anonymous-schema-52>:

  string

  Or to <anonymous-schema-53>:

  null

  deliveryDate

  Expand all

  oneOf

  Delivery date (YYYY-MM-DD)

  Default value:null

  Adheres to <anonymous-schema-55>:

  string

  Or to <anonymous-schema-56>:

  null

  amount

  Expand all

  required

  object

  Monetary amounts for the line

  netLocalCurrency

  Expand all

  oneOf

  Total net amount of the line.

  Default value:null

  Adheres to <anonymous-schema-58>:

  any

  Or to <anonymous-schema-59>:

  null

  grossLocalCurrency

  Expand all

  oneOf

  Total gross amount of the line.

  Default value:null

  Adheres to <anonymous-schema-61>:

  any

  Or to <anonymous-schema-62>:

  null

  discount

  Expand all

  oneOf

  Discount amount in invoice currency.

  Default value:null

  Adheres to <anonymous-schema-64>:

  any

  Or to <anonymous-schema-65>:

  null

  nonDiscountedPrice

  Expand all

  oneOf

  Original price before discount.

  Default value:null

  Adheres to <anonymous-schema-67>:

  any

  Or to <anonymous-schema-68>:

  null

  Additional properties are allowed.

  tax

  Expand all

  required

  object

  Tax details for the line

  id

  Expand all

  oneOf

  Tax rate ID

  Default value:null

  Adheres to <anonymous-schema-70>:

  integer

  [ -2147483648 .. 2147483647 ]

  Or to <anonymous-schema-71>:

  null

  account

  Expand all

  oneOf

  Tax revenue account number

  Default value:null

  Adheres to <anonymous-schema-73>:

  string

  Or to <anonymous-schema-74>:

  null

  name

  Expand all

  oneOf

  Tax rate name

  Default value:null

  Adheres to <anonymous-schema-76>:

  string

  Or to <anonymous-schema-77>:

  null

  percent

  Expand all

  oneOf

  Tax percentage (e.g. 27.0 for 27%).

  Default value:null

  Adheres to <anonymous-schema-79>:

  number

  format: double

  Or to <anonymous-schema-80>:

  null

  amount

  Expand all

  oneOf

  Tax amount in invoice currency.

  Default value:null

  Adheres to <anonymous-schema-82>:

  any

  Or to <anonymous-schema-83>:

  null

  Additional properties are allowed.

  accounting

  Expand all

  required

  object

  Accounting details for the line

  revenueAccount

  Expand all

  oneOf

  Revenue account number

  Default value:null

  Adheres to <anonymous-schema-85>:

  string

  Or to <anonymous-schema-86>:

  null

  expenseAccount

  Expand all

  oneOf

  Expense account number

  Default value:null

  Adheres to <anonymous-schema-88>:

  string

  Or to <anonymous-schema-89>:

  null

  purchasePrice

  Expand all

  oneOf

  Purchase price in invoice currency.

  Default value:null

  Adheres to <anonymous-schema-91>:

  any

  Or to <anonymous-schema-92>:

  null

  singlePrice

  Expand all

  oneOf

  Single unit price in invoice currency.

  Default value:null

  Adheres to <anonymous-schema-94>:

  any

  Or to <anonymous-schema-95>:

  null

  quantity

  Expand all

  oneOf

  Quantity

  Default value:null

  Adheres to <anonymous-schema-97>:

  number

  format: float

  Or to <anonymous-schema-98>:

  null

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  This example has been generated automatically.

• #1

  Message IDEmspCdrEvent

  Payload

  Expand all

  object

  EMSP-perspective final CDR pushed once per session to Styx after plausibility=VALID. Contract: SPQR-189 'Session & CDR Schema (MF Service)'. Borrows OCPI 3.0 structure; not OCPI-compliant. Field names are snake_case to match the customer-communicated contract.

  schema_version

  string

  SemVer of the message schema.

  Default value:"1.1.0"

  event_id

  required

  string

  Unique per push, UUIDv7. Receiver dedup key.

  event_date

  required

  string

  When the event was generated (ISO-8601 UTC).

  cdr_id

  required

  string

  Immutable CDR ID.

  transaction_id

  required

  integer

  [ -2147483648 .. 2147483647 ]

  Numeric charge_log.id.

  mandant_uuid

  required

  string

  Owner mandant; also the styx-mandant-id header.

  role

  Expand all

  required

  array<string>

  Perspective(s) this CDR represents.

  Items:

  string

  Allowed values:
  • "CPO"
  • "EMP"

  roaming_connection

  Expand all

  oneOf

  UUID of the roaming connection; null on INTERNAL.

  Default value:null

  Adheres to <anonymous-schema-108>:

  string

  Or to <anonymous-schema-109>:

  null

  start_date_time

  required

  string

  Session start (ISO-8601 UTC).

  end_date_time

  required

  string

  Session end (ISO-8601 UTC).

  plausibility_status

  required

  string

  CDR only pushed on VALID.

  Allowed values:
  • "VALID"
  • "INVALID"

  cdr_token

  Expand all

  required

  object

  Authentication token used for the session.

  tag_id

  Expand all

  oneOf

  RFID tag ID / card identifier.

  Default value:null

  Adheres to <anonymous-schema-114>:

  string

  Or to <anonymous-schema-115>:

  null

  contract_id

  Expand all

  oneOf

  EMAID/EMI3 (e.g. AT-HTB-C12345678-9).

  Default value:null

  Adheres to <anonymous-schema-117>:

  string

  Or to <anonymous-schema-118>:

  null

  type

  Expand all

  oneOf

  Token type (optional, future).

  Default value:null

  Adheres to <anonymous-schema-120>:

  string

  Allowed values:
  • "RFID"
  • "APP_USER"
  • "AD_HOC_USER"
  • "OTHER"

  Or to <anonymous-schema-121>:

  null

  Additional properties are allowed.

  auth_method

  Expand all

  oneOf

  Authorization method (optional, future).

  Default value:null

  Adheres to <anonymous-schema-123>:

  string

  Allowed values:
  • "WHITELIST"
  • "AUTH_REQUEST"
  • "COMMAND"

  Or to <anonymous-schema-124>:

  null

  auth_reference_id

  Expand all

  oneOf

  Same value as on the Session; correlates Session <-> CDR.

  Default value:null

  Adheres to <anonymous-schema-126>:

  string

  Or to <anonymous-schema-127>:

  null

  cdr_location

  Expand all

  required

  object

  Location snapshot.

  id

  required

  string

  Location UUID. Currently equals station_id (cp.uuid) because the charge_log has no resolved location entity yet; will carry the real location UUID once location resolution is available.

  station_id

  string

  Station (charge point) UUID = cp.uuid.

  Default value:""

  name

  required

  string

  Location name.

  address

  required

  string

  Street address.

  city

  required

  string

  City.

  postal_code

  required

  string

  Postal code.

  country

  required

  string

  ISO-3166 alpha-3.

  coordinates

  Expand all

  required

  object

  Geo coordinates.

  latitude

  required

  string

  Latitude (decimal degrees, string).

  longitude

  required

  string

  Longitude (decimal degrees, string).

  Additional properties are allowed.

  evse_uid

  required

  string

  EVSE UUID.

  evse_id

  required

  string

  Standard EVSE ID.

  connector_id

  required

  string

  Local connector number.

  connector_standard

  required

  string

  OCPI ConnectorType; UNKNOWN for unmapped standards.

  Allowed values:
  • "CHADEMO"
  • "CHAOJI"
  • "DOMESTIC_A"
  • "DOMESTIC_B"
  • "DOMESTIC_C"
  • "DOMESTIC_D"
  • "DOMESTIC_E"
  • "DOMESTIC_F"
  • "DOMESTIC_G"
  • "DOMESTIC_H"
  • "DOMESTIC_I"
  • "DOMESTIC_J"
  • "DOMESTIC_K"
  • "DOMESTIC_L"
  • "DOMESTIC_M"
  • "DOMESTIC_N"
  • "DOMESTIC_O"
  • "GBT_AC"
  • "GBT_DC"
  • "IEC_60309_2_single_16"
  • "IEC_60309_2_three_16"
  • "IEC_60309_2_three_32"
  • "IEC_60309_2_three_64"
  • "IEC_62196_T1"
  • "IEC_62196_T1_COMBO"
  • "IEC_62196_T2"
  • "IEC_62196_T2_COMBO"
  • "IEC_62196_T3A"
  • "IEC_62196_T3C"
  • "NEMA_5_20"
  • "NEMA_6_30"
  • "NEMA_6_50"
  • "NEMA_10_30"
  • "NEMA_10_50"
  • "NEMA_14_30"
  • "NEMA_14_50"
  • "PANTOGRAPH_BOTTOM_UP"
  • "PANTOGRAPH_TOP_DOWN"
  • "TESLA_R"
  • "TESLA_S"
  • "UNKNOWN"

  connector_format

  required

  string

  Socket or fixed cable.

  Allowed values:
  • "SOCKET"
  • "CABLE"

  connector_power_type

  required

  string

  Power type.

  Allowed values:
  • "AC_1_PHASE"
  • "AC_3_PHASE"
  • "DC"

  Additional properties are allowed.

  currency

  required

  string

  ISO-4217.

  total_cost

  Expand all

  required

  object

  Final total cost (billing-grade).

  excl_vat

  required

  number

  format: double

  Amount excluding VAT (major units).

  incl_vat

  Expand all

  oneOf

  Amount including VAT (major units); null when gross/VAT is not available.

  Default value:null

  Adheres to <anonymous-schema-146>:

  number

  format: double

  Or to <anonymous-schema-147>:

  null

  Additional properties are allowed.

  total_energy

  required

  number

  format: double

  Total energy, kWh.

  total_energy_cost

  Expand all

  required

  object

  Final total cost (billing-grade).

  excl_vat

  required

  number

  format: double

  Amount excluding VAT (major units).

  incl_vat

  Expand all

  oneOf

  Amount including VAT (major units); null when gross/VAT is not available.

  Default value:null

  Adheres to <anonymous-schema-146>:

  number

  format: double

  Or to <anonymous-schema-147>:

  null

  Additional properties are allowed.

  total_time

  required

  number

  format: double

  Total time, hours.

  total_time_cost

  Expand all

  required

  object

  Final total cost (billing-grade).

  excl_vat

  required

  number

  format: double

  Amount excluding VAT (major units).

  incl_vat

  Expand all

  oneOf

  Amount including VAT (major units); null when gross/VAT is not available.

  Default value:null

  Adheres to <anonymous-schema-146>:

  number

  format: double

  Or to <anonymous-schema-147>:

  null

  Additional properties are allowed.

  total_parking_time

  required

  number

  format: double

  Total parking time, hours.

  total_parking_cost

  Expand all

  oneOf

  Parking cost (optional).

  Default value:null

  Adheres to <anonymous-schema-152>:

  any

  Or to <anonymous-schema-153>:

  null

  total_fixed_cost

  Expand all

  oneOf

  Fixed/session fee (optional).

  Default value:null

  Adheres to <anonymous-schema-155>:

  any

  Or to <anonymous-schema-156>:

  null

  local_currency

  Expand all

  oneOf

  When different from currency.

  Default value:null

  Adheres to <anonymous-schema-158>:

  string

  Or to <anonymous-schema-159>:

  null

  exchange_rate

  Expand all

  oneOf

  currency -> local_currency exchange rate.

  Default value:null

  Adheres to <anonymous-schema-161>:

  number

  format: double

  Or to <anonymous-schema-162>:

  null

  total_cost_local_currency

  Expand all

  oneOf

  Total cost in local currency.

  Default value:null

  Adheres to <anonymous-schema-164>:

  any

  Or to <anonymous-schema-165>:

  null

  taxes

  Expand all

  required

  array<object>

  Applied taxes.

  object

  name

  required

  string

  Tax name (VAT, Sales Tax, ...).

  percent

  required

  number

  format: double

  Tax percentage (e.g. 20.0).

  amount

  required

  number

  format: double

  Tax amount (currency, major units).

  amount_local_currency

  Expand all

  oneOf

  Tax amount in local currency.

  Default value:null

  Adheres to <anonymous-schema-171>:

  number

  format: double

  Or to <anonymous-schema-172>:

  null

  Additional properties are allowed.

  purchase_cost

  Expand all

  oneOf

  Only on EMP roaming-inbound CDRs.

  Default value:null

  Adheres to <anonymous-schema-174>:

  any

  Or to <anonymous-schema-175>:

  null

  tariffs

  Expand all

  required

  array<object>

  Tariff(s) applied to the session.

  object

  The rate (tariff) and its cost rate applied to the session. Empty for roaming-inbound CDRs, which carry no be.energised rate.

  id

  required

  string

  Rate UUID (charge_log.rate).

  name

  Expand all

  oneOf

  Rate display name; falls back to the rate slug, null if neither is set.

  Default value:null

  Adheres to <anonymous-schema-179>:

  string

  Or to <anonymous-schema-180>:

  null

  type

  required

  string

  Tariff type. be.energised Rate types do not map onto these symbols; currently always REGULAR (mapping TBD with the customer).

  Allowed values:
  • "REGULAR"
  • "AD_HOC_PAYMENT"
  • "PROFILE_CHEAP"
  • "PROFILE_FAST"
  • "PROFILE_GREEN"

  currency

  required

  string

  ISO-4217 of the rate.

  cost_rate_id

  Expand all

  oneOf

  Cost rate UUID (charge_log.rate_cost); null when none is attached.

  Default value:null

  Adheres to <anonymous-schema-184>:

  string

  Or to <anonymous-schema-185>:

  null

  cost_rate_name

  Expand all

  oneOf

  Cost rate name; null when none is attached.

  Default value:null

  Adheres to <anonymous-schema-187>:

  string

  Or to <anonymous-schema-188>:

  null

  price_components

  Expand all

  array<object>

  Per-dimension pricing of the cost rate (energy/time intervals + session fee).

  Default value:[]

  object

  A priced dimension of the cost rate.

  type

  required

  string

  Priced dimension: per-kWh energy, per-time, or a flat session fee.

  Allowed values:
  • "ENERGY"
  • "TIME"
  • "FLAT"

  price

  required

  number

  format: double

  Net per-unit price for ENERGY/TIME, or the flat net amount for FLAT (major units).

  step_size

  Expand all

  oneOf

  Billing increment the price applies to (RateCostInterval.unit); null for FLAT.

  Default value:null

  Adheres to <anonymous-schema-193>:

  number

  format: double

  Or to <anonymous-schema-194>:

  null

  unit

  Expand all

  oneOf

  Unit the step_size/price is expressed in. TIME granularity (minute vs second) TBD with the customer.

  Default value:null

  Adheres to <anonymous-schema-196>:

  string

  Allowed values:
  • "KWH"
  • "MINUTE"
  • "HOUR"
  • "SESSION"

  Or to <anonymous-schema-197>:

  null

  Additional properties are allowed.

  Additional properties are allowed.

  charging_periods

  Expand all

  oneOf

  Per-period metering (optional, future).

  Default value:null

  Adheres to <anonymous-schema-199>:

  Expand all

  array<object>

  object

  start_date_time

  required

  string

  Period start (ISO-8601 UTC).

  dimensions

  Expand all

  required

  array<object>

  Metered dimensions for the period.

  object

  type

  required

  string

  Dimension type.

  Allowed values:
  • "ENERGY"
  • "TIME"
  • "POWER"
  • "STATE_OF_CHARGE"
  • "MAX_CURRENT"
  • "MIN_CURRENT"
  • "PARKING_TIME"
  • "FLAT"

  volume

  required

  number

  format: double

  Quantity for this dimension.

  Additional properties are allowed.

  tariff_id

  Expand all

  oneOf

  Tariff applied for the period.

  Default value:null

  Adheres to <anonymous-schema-205>:

  string

  Or to <anonymous-schema-206>:

  null

  Additional properties are allowed.

  Or to <anonymous-schema-207>:

  null

  signed_data

  Expand all

  oneOf

  OCMF/EICHRECHT signed data (optional, future).

  Default value:null

  Adheres to SignedData:

  Expand all

  object

  encoding_method

  required

  string

  OCMF or EICHRECHT.

  encoding_method_version

  required

  integer

  [ -2147483648 .. 2147483647 ]

  Encoding method version.

  public_key

  required

  string

  Public key.

  signed_values

  Expand all

  required

  array<object>

  Signed meter values.

  object

  nature

  required

  string

  Reading nature.

  Allowed values:
  • "START"
  • "END"
  • "INTERMEDIATE"

  plain_data

  required

  string

  Plain reading.

  signed_data

  required

  string

  Signed reading.

  Additional properties are allowed.

  url

  Expand all

  oneOf

  Optional URL to signed data.

  Default value:null

  Adheres to <anonymous-schema-217>:

  string

  Or to <anonymous-schema-218>:

  null

  Additional properties are allowed.

  Or to <anonymous-schema-219>:

  null

  remark

  Expand all

  oneOf

  Free-form remark.

  Default value:null

  Adheres to <anonymous-schema-221>:

  string

  Or to <anonymous-schema-222>:

  null

  invoice_reference_id

  Expand all

  oneOf

  Invoice reference.

  Default value:null

  Adheres to <anonymous-schema-224>:

  string

  Or to <anonymous-schema-225>:

  null

  credit

  required

  boolean

  True if this CDR is a correction/credit note.

  additional_fields

  Expand all

  oneOf

  Free key-value (cost_center, po_number, ...).

  Default value:null

  Adheres to <anonymous-schema-228>:

  Expand all

  object

  Additional properties:

  string

  Or to <anonymous-schema-230>:

  null

  Additional properties are allowed.

  Examples

  Payload

  This example has been generated automatically.

• #2

  Message IDEmspSessionEvent

  Payload

  Expand all

  object

  EMSP-perspective charging session event (STARTED/UPDATED/ENDED) pushed to Styx for MF-Service. Contract: SPQR-189 'Session & CDR Schema (MF Service)'. Borrows OCPI 3.0 structure; not OCPI-compliant. Field names are snake_case to match the customer-communicated contract.

  schema_version

  string

  SemVer of the message schema.

  Default value:"1.1.0"

  event_id

  required

  string

  Unique per push, UUIDv7 (time-orderable). Receiver dedup key.

  event_type

  required

  string

  Session lifecycle event.

  Allowed values:
  • "STARTED"
  • "UPDATED"
  • "ENDED"

  update_reason

  Expand all

  oneOf

  Why this push was emitted; distinguishes a heartbeat or a status change from a real meter update. Populated by the trigger; null until wired. Enum values TBD jointly with CPO Services.

  Default value:null

  Adheres to <anonymous-schema-235>:

  string

  Allowed values:
  • "METER_VALUE"
  • "HEARTBEAT"
  • "STATUS_CHANGE"

  Or to <anonymous-schema-236>:

  null

  event_date

  required

  string

  When the event was generated (ISO-8601 UTC, Z).

  id

  required

  string

  Session ID = charge_log.uuid.

  transaction_id

  required

  integer

  [ -2147483648 .. 2147483647 ]

  Numeric charge_log.id (legacy join).

  mandant_uuid

  required

  string

  Owner mandant of this view; also the styx-mandant-id header.

  role

  Expand all

  required

  array<string>

  Perspective(s) this view represents.

  Items:

  string

  Allowed values:
  • "CPO"
  • "EMP"

  roaming_connection

  Expand all

  oneOf

  UUID of the roaming connection used; null on INTERNAL. Immutable.

  Default value:null

  Adheres to <anonymous-schema-244>:

  string

  Or to <anonymous-schema-245>:

  null

  start_date_time

  required

  string

  Session start (ISO-8601 UTC).

  end_date_time

  Expand all

  oneOf

  Session end; null while ACTIVE.

  Default value:null

  Adheres to <anonymous-schema-248>:

  string

  Or to <anonymous-schema-249>:

  null

  status

  required

  string

  Operational state of the session.

  Allowed values:
  • "ACTIVE"
  • "COMPLETED"
  • "INVALID"
  • "PENDING"
  • "RESERVATION"

  plausibility_status

  required

  string

  Billing eligibility set by the plausibility check.

  Allowed values:
  • "PENDING"
  • "VALID"
  • "INVALID"

  stop_reason

  Expand all

  oneOf

  OCPP StopTransaction reason, mapped from charge_log.stop_reason. Only set on ENDED.

  Default value:null

  Adheres to <anonymous-schema-253>:

  string

  Allowed values:
  • "DEAUTHORIZED"
  • "EMERGENCY_STOP"
  • "EV_DISCONNECTED"
  • "HARD_RESET"
  • "LOCAL"
  • "OTHER"
  • "POWER_LOSS"
  • "REBOOT"
  • "REMOTE"
  • "SOFT_RESET"
  • "UNLOCK_COMMAND"

  Or to <anonymous-schema-254>:

  null

  connector_status

  Expand all

  oneOf

  OCPP connector status; set on a status-change push. Populated by the trigger; null until wired. Enum values TBD jointly with CPO Services.

  Default value:null

  Adheres to <anonymous-schema-256>:

  string

  Allowed values:
  • "AVAILABLE"
  • "PREPARING"
  • "CHARGING"
  • "SUSPENDED_EV"
  • "SUSPENDED_EVSE"
  • "FINISHING"
  • "RESERVED"
  • "UNAVAILABLE"
  • "FAULTED"

  Or to <anonymous-schema-257>:

  null

  error_code

  Expand all

  oneOf

  OCPP ChargePointErrorCode; set when connector_status is FAULTED.

  Default value:null

  Adheres to <anonymous-schema-259>:

  string

  Or to <anonymous-schema-260>:

  null

  cdr_token

  Expand all

  required

  object

  Authentication token used for the session.

  tag_id

  Expand all

  oneOf

  RFID tag ID / card identifier.

  Default value:null

  Adheres to <anonymous-schema-262>:

  string

  Or to <anonymous-schema-263>:

  null

  contract_id

  Expand all

  oneOf

  EMAID/EMI3 (e.g. AT-HTB-C12345678-9).

  Default value:null

  Adheres to <anonymous-schema-265>:

  string

  Or to <anonymous-schema-266>:

  null

  type

  Expand all

  oneOf

  Token type (optional, future).

  Default value:null

  Adheres to <anonymous-schema-268>:

  string

  Allowed values:
  • "RFID"
  • "APP_USER"
  • "AD_HOC_USER"
  • "OTHER"

  Or to <anonymous-schema-269>:

  null

  Additional properties are allowed.

  auth_method

  Expand all

  oneOf

  Authorization method (optional, future).

  Default value:null

  Adheres to <anonymous-schema-271>:

  string

  Allowed values:
  • "WHITELIST"
  • "AUTH_REQUEST"
  • "COMMAND"

  Or to <anonymous-schema-272>:

  null

  auth_reference_id

  Expand all

  oneOf

  Reference to the authorization process; correlates Session to CDR.

  Default value:null

  Adheres to <anonymous-schema-274>:

  string

  Or to <anonymous-schema-275>:

  null

  location_id

  required

  string

  Location UUID. Currently equals station_id (cp.uuid) because the charge_log has no resolved location entity yet; will carry the real location UUID once location resolution is available.

  station_id

  string

  Station (charge point) UUID = cp.uuid.

  Default value:""

  evse_uid

  required

  string

  cp_connector.uuid.

  evse_id

  required

  string

  Standard EVSE ID (e.g. ATHTBE12345*1).

  connector_id

  required

  string

  cp_connector.id (numeric surrogate, stringified).

  total_energy

  required

  number

  format: double

  Cumulative energy delivered, kWh.

  meter_start_wh

  required

  integer

  [ -9223372036854776000 .. 9223372036854776000 ]

  Meter reading at start (Wh). long: cumulative station registers exceed 32-bit int.

  meter_end_wh

  Expand all

  oneOf

  Meter reading at end (Wh); null while ACTIVE. long: cumulative station registers exceed 32-bit int.

  Default value:null

  Adheres to <anonymous-schema-284>:

  integer

  [ -9223372036854776000 .. 9223372036854776000 ]

  Or to <anonymous-schema-285>:

  null

  current_power_kw

  Expand all

  oneOf

  Current charging power; only when supported by hardware/partner.

  Default value:null

  Adheres to <anonymous-schema-287>:

  number

  format: double

  Or to <anonymous-schema-288>:

  null

  state_of_charge_percent

  Expand all

  oneOf

  Battery SoC; not stored in be.energised yet (emitted null).

  Default value:null

  Adheres to <anonymous-schema-290>:

  number

  format: double

  Or to <anonymous-schema-291>:

  null

  charging_periods

  Expand all

  oneOf

  Per-period metering (optional, future).

  Default value:null

  Adheres to <anonymous-schema-293>:

  Expand all

  array<object>

  object

  start_date_time

  required

  string

  Period start (ISO-8601 UTC).

  dimensions

  Expand all

  required

  array<object>

  Metered dimensions for the period.

  object

  type

  required

  string

  Dimension type.

  Allowed values:
  • "ENERGY"
  • "TIME"
  • "POWER"
  • "STATE_OF_CHARGE"
  • "MAX_CURRENT"
  • "MIN_CURRENT"
  • "PARKING_TIME"
  • "FLAT"

  volume

  required

  number

  format: double

  Quantity for this dimension.

  Additional properties are allowed.

  tariff_id

  Expand all

  oneOf

  Tariff applied for the period.

  Default value:null

  Adheres to <anonymous-schema-299>:

  string

  Or to <anonymous-schema-300>:

  null

  Additional properties are allowed.

  Or to <anonymous-schema-301>:

  null

  currency

  required

  string

  ISO-4217.

  total_cost

  Expand all

  required

  object

  Preliminary total cost (live).

  excl_vat

  required

  number

  format: double

  Amount excluding VAT (major units).

  incl_vat

  Expand all

  oneOf

  Amount including VAT (major units); null when gross/VAT is not available.

  Default value:null

  Adheres to <anonymous-schema-305>:

  number

  format: double

  Or to <anonymous-schema-306>:

  null

  Additional properties are allowed.

  cost_breakdown

  Expand all

  required

  object

  Preliminary cost breakdown (live).

  energy

  Expand all

  required

  object

  Preliminary total cost (live).

  excl_vat

  required

  number

  format: double

  Amount excluding VAT (major units).

  incl_vat

  Expand all

  oneOf

  Amount including VAT (major units); null when gross/VAT is not available.

  Default value:null

  Adheres to <anonymous-schema-305>:

  number

  format: double

  Or to <anonymous-schema-306>:

  null

  Additional properties are allowed.

  time

  Expand all

  required

  object

  Preliminary total cost (live).

  excl_vat

  required

  number

  format: double

  Amount excluding VAT (major units).

  incl_vat

  Expand all

  oneOf

  Amount including VAT (major units); null when gross/VAT is not available.

  Default value:null

  Adheres to <anonymous-schema-305>:

  number

  format: double

  Or to <anonymous-schema-306>:

  null

  Additional properties are allowed.

  session

  Expand all

  required

  object

  Preliminary total cost (live).

  excl_vat

  required

  number

  format: double

  Amount excluding VAT (major units).

  incl_vat

  Expand all

  oneOf

  Amount including VAT (major units); null when gross/VAT is not available.

  Default value:null

  Adheres to <anonymous-schema-305>:

  number

  format: double

  Or to <anonymous-schema-306>:

  null

  Additional properties are allowed.

  parking

  Expand all

  oneOf

  Parking cost component (optional).

  Default value:null

  Adheres to <anonymous-schema-308>:

  any

  Or to <anonymous-schema-309>:

  null

  Additional properties are allowed.

  local_currency

  Expand all

  oneOf

  When different from currency.

  Default value:null

  Adheres to <anonymous-schema-311>:

  string

  Or to <anonymous-schema-312>:

  null

  exchange_rate

  Expand all

  oneOf

  currency -> local_currency exchange rate.

  Default value:null

  Adheres to <anonymous-schema-314>:

  number

  format: double

  Or to <anonymous-schema-315>:

  null

  total_cost_local_currency

  Expand all

  oneOf

  Total cost in local currency.

  Default value:null

  Adheres to <anonymous-schema-317>:

  any

  Or to <anonymous-schema-318>:

  null

  Additional properties are allowed.

  Examples

  Payload

  This example has been generated automatically.

• #3

  Message IDOutgoingConnectorStatusUpdateMessage

  Payload

  Expand all

  object

  mandantUuid

  required

  string

  UUID of the tenant in be.ENERGISED, the station is associated with.

  chargeboxIdentity

  Expand all

  oneOf

  Default value:null

  Adheres to <anonymous-schema-321>:

  string

  Or to <anonymous-schema-322>:

  null

  cpUuid

  required

  string

  UUID of the charger, which identifies the charger uniquely in the system

  connectorUuid

  required

  string

  The uuid of the connector.

  connectorStatus

  Expand all

  required

  object

  simple

  required

  string

  The simple status of a connector.

  Allowed values:
  • "AVAILABLE"
  • "UNAVAILABLE"
  • "OCCUPIED"
  • "EMPTY"

  ocpp

  required

  string

  The raw ocpp status of a connector.

  Allowed values:
  • "EMPTY"
  • "AVAILABLE"
  • "UNAVAILABLE"
  • "NOTCONFIGURED"
  • "OCCUPIED"
  • "FAULTED"
  • "CHARGING_SUSPENDED_EV"
  • "OUT_OF_SERVICE"
  • "UNKNOWN"
  • "RESERVED"
  • "PLANNED"
  • "PREPARING"
  • "FINISHING"
  • "CHARGING"
  • "SUSPENDED_EV"
  • "SUSPENDED_EVSE"
  • "CONSTRUCTION"

  public

  required

  string

  The public status of a connector.

  Allowed values:
  • "AVAILABLE"
  • "UNAVAILABLE"
  • "NOTCONFIGURED"
  • "OCCUPIED"
  • "FAULTED"
  • "CHARGING_SUSPENDED_EV"
  • "OUT_OF_SERVICE"
  • "UNKNOWN"
  • "RESERVED"
  • "PLANNED"
  • "EMPTY"
  • "CONSTRUCTION"
  • "PREPARING"
  • "FINISHING"
  • "CHARGING"
  • "SUSPENDED_EV"
  • "SUSPENDED_EVSE"

  Additional properties are allowed.

  timestamp

  required

  integer

  [ -9223372036854776000 .. 9223372036854776000 ]

  ISO 8601 timestamp indicating when the connector status changed

  Additional properties are allowed.

  Examples

  Payload

  This example has been generated automatically.

• #4

  Message IDOutgoingOcppBrokerMessage

  Payload

  Expand all

  object

  mandantUuid

  required

  string

  UUID of the tenant in be.ENERGISED, the station is associated with.

  chargeboxIdentity

  required

  string

  cpUuid

  required

  string

  UUID of the charger, which identifies the charger uniquely in the system

  direction

  required

  string

  Direction of message 'INCOMING' for messages from the charger to the CSMS, 'OUTGOING' for messages from the CSMS to the charger

  Allowed values:
  • "INCOMING"
  • "OUTGOING"

  timestamp

  required

  integer

  [ -9223372036854776000 .. 9223372036854776000 ]

  ISO 8601 timestamp indicating when the message was sent or received

  payload

  required

  string

  Raw OCPP message payload

  Additional properties are allowed.

  Examples

  Payload

  This example has been generated automatically.

• #5

  Message IDOutgoingStationStatusUpdateMessage

  Payload

  Expand all

  object

  mandantUuid

  required

  string

  UUID of the tenant in be.ENERGISED, the station is associated with.

  chargeboxIdentity

  Expand all

  oneOf

  Default value:null

  Adheres to <anonymous-schema-337>:

  string

  Or to <anonymous-schema-338>:

  null

  cpUuid

  required

  string

  UUID of the charger, which identifies the charger uniquely in the system

  connectionStatus

  required

  string

  Connection status of the station. 'ONLINE' indicates the station is connected, 'OFFLINE' indicates it is disconnected, and 'PENDING' indicates the connection status is in transition.

  Allowed values:
  • "ONLINE"
  • "OFFLINE"
  • "PENDING"

  timestamp

  required

  integer

  [ -9223372036854776000 .. 9223372036854776000 ]

  ISO 8601 timestamp indicating when the connection status changed

  Additional properties are allowed.

  Examples

  Payload

  This example has been generated automatically.

• #6

  Message IDEmspRoamingConnectorStatusUpdate

  Payload

  Expand all

  object

  Connector status update for real-time availability; delivered via Styx MF-Service.

  mandantUuid

  required

  string

  UUID of the tenant in be.ENERGISED, the station is associated with.

  cpUuid

  required

  string

  UUID of the charger, which identifies the charger uniquely in the system

  connectorUuid

  required

  string

  The uuid of the connector.

  connectorStatus

  Expand all

  required

  object

  simple

  required

  string

  The simple status of a connector.

  Allowed values:
  • "AVAILABLE"
  • "UNAVAILABLE"
  • "OCCUPIED"
  • "EMPTY"

  ocpp

  required

  string

  The raw ocpp status of a connector.

  Allowed values:
  • "EMPTY"
  • "AVAILABLE"
  • "UNAVAILABLE"
  • "NOTCONFIGURED"
  • "OCCUPIED"
  • "FAULTED"
  • "CHARGING_SUSPENDED_EV"
  • "OUT_OF_SERVICE"
  • "UNKNOWN"
  • "RESERVED"
  • "PLANNED"
  • "PREPARING"
  • "FINISHING"
  • "CHARGING"
  • "SUSPENDED_EV"
  • "SUSPENDED_EVSE"
  • "CONSTRUCTION"

  public

  required

  string

  The public status of a connector.

  Allowed values:
  • "AVAILABLE"
  • "UNAVAILABLE"
  • "NOTCONFIGURED"
  • "OCCUPIED"
  • "FAULTED"
  • "CHARGING_SUSPENDED_EV"
  • "OUT_OF_SERVICE"
  • "UNKNOWN"
  • "RESERVED"
  • "PLANNED"
  • "EMPTY"
  • "CONSTRUCTION"
  • "PREPARING"
  • "FINISHING"
  • "CHARGING"
  • "SUSPENDED_EV"
  • "SUSPENDED_EVSE"

  Additional properties are allowed.

  timestamp

  required

  integer

  [ -9223372036854776000 .. 9223372036854776000 ]

  Time the status change occurred

  Additional properties are allowed.

  Examples

  Payload

  This example has been generated automatically.