Sign in

v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB
Events

Create event (legacy)

post/v3/events

Request body

customerIdstring required

The ID of the customer

datetimestring date-time required

The date and time of the event

eventTypeIdstring required

The type of event

valuestring required

The value of the event, usually a number

differentiatorstring

The differentiator of the event

metadataobject required

event metadata

invoiceGroupstring

The invoice group for split invoicing

Example request

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "datetime": "2021-01-01T00:00:00.000Z",
  "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "123",
  "differentiator": "DIFF",
  "invoiceGroup": "123"
}

Response

The Event

customerIdstring required

The ID of the customer

datetimestring date-time required

The date and time of the event

eventTypeIdstring required

The type of event

valuestring required

The value of the event, usually a number

differentiatorstring

The differentiator of the event

metadataobject required

event metadata

invoiceGroupstring

The invoice group for split invoicing

idstring required

The id of the event

Example response

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "datetime": "2021-01-01T00:00:00.000Z",
  "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "123",
  "differentiator": "DIFF",
  "invoiceGroup": "123",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}