Asynchronous Usage Event Callbacks

Receives callbacks with rating results via API webhooks.

For more information, please search through the Gotransverse online documentation:

Request Content-Types: application/json
Response Content-Types: application/json
Version: 2.0.0

Paths

POST /events/bulk

Webhook with outcome of usage event processing

rated and erred outcome of submitted usage events

Request Content-Types: application/json
Request Example
{
  "rated_events": [
    {
      "service_period": {
        "id": "string"
      },
      "description": "string",
      "event_charges": [
        {
          "usage_uom": "string",
          "usage_amount": "number",
          "rate": "number",
          "charge": "number",
          "usage_rule": {
            "id": "string"
          },
          "charge_category": {
            "id": "string"
          },
          "id": "string"
        }
      ],
      "start_time": "string (date-time)",
      "end_time": "string (date-time)",
      "service_resource_identifier": "string",
      "service_resource_type": "string",
      "usage_uom": "string",
      "usage_amount": "number",
      "reference_id": "string",
      "sequence_id": "string",
      "text01": "string",
      "text02": "string",
      "text03": "string",
      "text04": "string",
      "text05": "string",
      "number1": "number",
      "number2": "number",
      "number3": "number",
      "number4": "number",
      "number5": "number",
      "boolean01": "boolean",
      "boolean02": "boolean",
      "boolean03": "boolean",
      "boolean04": "boolean",
      "boolean05": "boolean",
      "date01": "string (date-time)",
      "date02": "string (date-time)",
      "date03": "string (date-time)",
      "date04": "string (date-time)",
      "date05": "string (date-time)",
      "id": "string"
    }
  ],
  "erred_events": [
    {
      "unrated_event": {
        "start_time": "string (date-time)",
        "end_time": "string (date-time)",
        "service_resource_identifier": "string",
        "service_resource_type": "string",
        "usage_uom": "string",
        "usage_amount": "number",
        "reference_id": "string",
        "sequence_id": "string",
        "text01": "string",
        "text02": "string",
        "text03": "string",
        "text04": "string",
        "text05": "string",
        "number1": "number",
        "id": "string"
      }
    }
  ]
}
200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

Schema Definitions

BulkUsageEventsResponse: object

rated_events: RatedUsageEvent
erred_events: AsyncErredUsageEvent
Example
{
  "rated_events": [
    {
      "service_period": {
        "id": "string"
      },
      "total_charge": "number",
      "description": "string",
      "event_charges": [
        {
          "usage_uom": "string",
          "usage_amount": "number",
          "rate": "number",
          "charge": "number",
          "usage_rule": {
            "id": "string"
          },
          "charge_category": {
            "id": "string"
          },
          "id": "string"
        }
      ],
      "start_time": "string (date-time)",
      "end_time": "string (date-time)",
      "service_resource_identifier": "string",
      "service_resource_type": "string",
      "usage_uom": "string",
      "usage_amount": "number",
      "reference_id": "string",
      "sequence_id": "string",
      "text01": "string",
      "text02": "string",
      "text03": "string",
      "text04": "string",
      "text05": "string",
      "number1": "number",
      "number2": "number",
      "number3": "number",
      "number4": "number",
      "number5": "number",
      "boolean01": "boolean",
      "boolean02": "boolean",
      "boolean03": "boolean",
      "boolean04": "boolean",
      "boolean05": "boolean",
      "date01": "string (date-time)",
      "date02": "string (date-time)",
      "date03": "string (date-time)",
      "date04": "string (date-time)",
      "date05": "string (date-time)",
      "id": "string"
    }
  ],
  "erred_events": [
    {
      "unrated_event": {
        "start_time": "string (date-time)",
        "end_time": "string (date-time)",
        "service_resource_identifier": "string",
        "service_resource_type": "string",
        "usage_uom": "string",
        "usage_amount": "number",
        "reference_id": "string",
        "sequence_id": "string",
        "text01": "string",
        "text02": "string",
        "text03": "string",
        "text04": "string",
        "text05": "string",
        "number1": "number",
        "id": "string"
      }
    }
  ]
}

AsyncErredUsageEvent:

Example
{
  "unrated_event": {
    "start_time": "string (date-time)",
    "end_time": "string (date-time)",
    "service_resource_identifier": "string",
    "service_resource_type": "string",
    "usage_uom": "string",
    "usage_amount": "number",
    "reference_id": "string",
    "sequence_id": "string",
    "text01": "string",
    "text02": "string",
    "text03": "string",
    "text04": "string",
    "text05": "string",
    "number1": "number",
    "number2": "number",
    "number3": "number",
    "number4": "number",
    "number5": "number",
    "boolean01": "boolean",
    "boolean02": "boolean",
    "boolean03": "boolean",
    "boolean04": "boolean",
    "boolean05": "boolean",
    "date01": "string (date-time)",
    "date02": "string (date-time)",
    "date03": "string (date-time)",
    "date04": "string (date-time)",
    "date05": "string (date-time)",
    "id": "string"
  }
}

RatedUsageEvent:

service_period: ServicePeriodRef
total_charge: number
description: string
event_charges: EventCharge
Example
{
  "service_period": {
    "id": "string"
  },
  "total_charge": "number",
  "description": "string",
  "event_charges": [
    {
      "usage_uom": "string",
      "usage_amount": "number",
      "rate": "number",
      "charge": "number",
      "usage_rule": {
        "id": "string"
      },
      "charge_category": {
        "id": "string"
      },
      "id": "string"
    }
  ],
  "start_time": "string (date-time)",
  "end_time": "string (date-time)",
  "service_resource_identifier": "string",
  "service_resource_type": "string",
  "usage_uom": "string",
  "usage_amount": "number",
  "reference_id": "string",
  "sequence_id": "string",
  "text01": "string",
  "text02": "string",
  "text03": "string",
  "text04": "string",
  "text05": "string",
  "number1": "number",
  "number2": "number",
  "number3": "number",
  "number4": "number",
  "number5": "number",
  "boolean01": "boolean",
  "boolean02": "boolean",
  "boolean03": "boolean",
  "boolean04": "boolean",
  "boolean05": "boolean",
  "date01": "string (date-time)",
  "date02": "string (date-time)",
  "date03": "string (date-time)",
  "date04": "string (date-time)",
  "date05": "string (date-time)",
  "id": "string"
}

UsageEvent:

start_time: string (date-time)
end_time: string (date-time)
service_resource_identifier: string
service_resource_type: ServiceResourceType
usage_uom: UsageDurationUom
usage_amount: number
reference_id: string
sequence_id: string
text01: string
text02: string
text03: string
text04: string
text05: string
number1: number
number2: number
number3: number
number4: number
number5: number
boolean01: boolean
boolean02: boolean
boolean03: boolean
boolean04: boolean
boolean05: boolean
date01: string (date-time)
date02: string (date-time)
date03: string (date-time)
date04: string (date-time)
date05: string (date-time)
Example
{
  "start_time": "string (date-time)",
  "end_time": "string (date-time)",
  "service_resource_identifier": "string",
  "service_resource_type": "string",
  "usage_uom": "string",
  "usage_amount": "number",
  "reference_id": "string",
  "sequence_id": "string",
  "text01": "string",
  "text02": "string",
  "text03": "string",
  "text04": "string",
  "text05": "string",
  "number1": "number",
  "number2": "number",
  "number3": "number",
  "number4": "number",
  "number5": "number",
  "boolean01": "boolean",
  "boolean02": "boolean",
  "boolean03": "boolean",
  "boolean04": "boolean",
  "boolean05": "boolean",
  "date01": "string (date-time)",
  "date02": "string (date-time)",
  "date03": "string (date-time)",
  "date04": "string (date-time)",
  "date05": "string (date-time)",
  "id": "string"
}

Error: object

code: string

A code for the specific error. Used to help in determining possible root causes of an error.

message: string

A message providing additional detail for an error.

Example
{
  "code": "string",
  "message": "string"
}

ServicePeriodRef:

Example
{
  "id": "string"
}

EventCharge:

usage_uom: UsageDurationUom
usage_amount: number
rate: number
charge: number
usage_rule: UsageRuleRef
charge_category: UsageChargeCategoryRef
Example
{
  "usage_uom": "string",
  "usage_amount": "number",
  "rate": "number",
  "charge": "number",
  "usage_rule": {
    "id": "string"
  },
  "charge_category": {
    "id": "string"
  },
  "id": "string"
}

Entity: object

A representation of the Gotransverse entity object.

id: string

The internal entity id for this entity representation

Example
{
  "id": "string"
}

ServiceResourceType: string

string GENERIC_SERVICE_RESOURCE

UsageDurationUom: string

string MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, EVENT, BYTE, KILOBYTE, MEGABYTE, GIGABYTE, TERABYTE, COUNT, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, CURRENCY, WATT, KILOWATT, MEGAWATT, GIGAWATT, WATTS_PER_HOUR, KILOWATTS_PER_HOUR, MEGAWATTS_PER_HOUR, GIGAWATTS_PER_HOUR

UsageRuleRef:

Example
{
  "id": "string"
}

UsageChargeCategoryRef:

Example
{
  "id": "string"
}