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 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-101>:

  string

  Or to <anonymous-schema-102>:

  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.

• #2

  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.

• #3

  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-117>:

  string

  Or to <anonymous-schema-118>:

  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.

• #4

  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.