Skip to content

STATEMENT_CREATED

This event is fired when a billing statement is created for a policy. It generates the statement document and billing information.

When and what fires this event?

If this event is defined on a product, and it has actions that are enabled:

  • System: fires automatically when a billing statement is generated;
  • API: can fire this event externally on demand;
  • Billing workflows: fires when statements need to be created.

Request payload

POST: https://api.{ENV}.dais.com/ioi/v3/event/fire

curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/event/fire' \
--header 'Authorization: Basic <yourAuthHere>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "STATEMENT_CREATED",
    "payload": {
        "statementId": "<statementId>"
    }
}'
{
  "type": "STATEMENT_CREATED",
  "payload": {
        "statementId": "b5d87fb6-1f92-44b7-882a-0470ce228395"
    }
}

Request payload fields

TypeRequiredDescription
typetrueMust be set to STATEMENT_CREATED
payloadtrueExplained below

Payload fields

TypeRequiredDescription
statementIdtrueUUID for the statement

Response json

{
  "triggerRequestId": "386861af-6875-49b2-b38c-c435263039be",
  "executedActionCount": 0,
  "expectedResponseCount": 0,
  "metadata": {}
}

Response fields

PropertyRequiredDescription
triggerRequestIdtrueUUID that uniquely identifies the trigger execution instance.
executedActionCounttrueNumber of actions executed during this trigger run.
expectedResponseCounttrueNumber of responses expected from the executed actions.
metadatatrueContains dynamically generated data from executed workflow actions.