---
title: "GET /billing/events"
method: GET
path: "/billing/events"
---

# GET /billing/events

`GET /billing/events`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/billing/events`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/billing/events/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

OK

- BillingServiceEventTypeDefinitions
  - `creditDistributionEvents` CreditDistributionEvents, required
    - `billing.creditdistribution.discard` CreditDistributionEventData
      - `creditLocator` string, ulid, required
    - `billing.creditdistribution.reverse` CreditDistributionEventData
      - `creditLocator` string, ulid, required
    - `billing.creditdistribution.create` CreditDistributionEventData
      - `creditLocator` string, ulid, required
    - `billing.creditdistribution.distribute` CreditDistributionEventData
      - `creditLocator` string, ulid, required
  - `delinquencyEventEvents` DelinquencyEventEvents, required
    - `billing.delinquency.delinquencyevent.cancel` DelinquencyEventEventData
      - `delinquencyLocator` string, ulid, required
      - `delinquencyEventLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.delinquency.delinquencyevent.activate` DelinquencyEventEventData
      - `delinquencyLocator` string, ulid, required
      - `delinquencyEventLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.delinquency.delinquencyevent.create` DelinquencyEventEventData
      - `delinquencyLocator` string, ulid, required
      - `delinquencyEventLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.delinquency.delinquencyevent.trigger` DelinquencyEventEventData
      - `delinquencyLocator` string, ulid, required
      - `delinquencyEventLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
  - `delinquencyEvents` DelinquencyEvents, required
    - `billing.delinquency.create` DelinquencyEventData
      - `delinquencyLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.delinquency.settle` DelinquencyEventData
      - `delinquencyLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.delinquency.lapse` DelinquencyEventData
      - `delinquencyLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.delinquency.fail` DelinquencyFailureEventData
      - `delinquencyLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
      - `delinquencyState` 'preGrace' | 'inGrace' | 'lapseTriggered' | 'settled' | 'lapseTransactionCreated', required
  - `disbursementEvents` DisbursementEvents, required
    - `billing.disbursement.create` DisbursementEventData
      - `disbursementLocator` string, ulid, required
    - `billing.disbursement.anonymize` DisbursementEventData
      - `disbursementLocator` string, ulid, required
    - `billing.disbursement.reject` DisbursementEventData
      - `disbursementLocator` string, ulid, required
    - `billing.disbursement.discard` DisbursementEventData
      - `disbursementLocator` string, ulid, required
    - `billing.disbursement.validate` DisbursementEventData
      - `disbursementLocator` string, ulid, required
    - `billing.disbursement.execute` DisbursementEventData
      - `disbursementLocator` string, ulid, required
    - `billing.disbursement.reverse` DisbursementEventData
      - `disbursementLocator` string, ulid, required
    - `billing.disbursement.approve` DisbursementEventData
      - `disbursementLocator` string, ulid, required
  - `installmentEvents` InstallmentEvents, required
    - `billing.installmentlattice.create` InstallmentLatticeCreateData
      - `installmentLatticeLocator` string, ulid, required
  - `invoiceEvents` InvoiceEvents, required
    - `billing.invoice.autopayfailed` InvoiceAutopayData
      - `invoiceLocator` string, ulid, required
      - `accountLocator` string, ulid, required
      - `invoiceType` 'normal' | 'aggregate', required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
      - `autopayTime` string, date-time, required
    - `billing.invoice.discard` InvoiceDiscardData
      - `invoiceLocator` string, ulid, required
      - `accountLocator` string, ulid, required
      - `invoiceType` 'normal' | 'aggregate', required
    - `billing.invoice.generate` InvoiceGeneratedEventData
      - `invoiceLocator` string, ulid, required
      - `accountLocator` string, ulid, required
      - `invoiceType` 'normal' | 'aggregate', required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
      - `generateTime` string, date-time, required
    - `billing.invoice.settle` InvoiceSettledEventData
      - `invoiceLocator` string, ulid, required
      - `accountLocator` string, ulid, required
      - `invoiceType` 'normal' | 'aggregate', required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.invoice.autopay` InvoiceAutopayData
      - `invoiceLocator` string, ulid, required
      - `accountLocator` string, ulid, required
      - `invoiceType` 'normal' | 'aggregate', required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
      - `autopayTime` string, date-time, required
    - `billing.invoice.unsettle` InvoiceSettledEventData
      - `invoiceLocator` string, ulid, required
      - `accountLocator` string, ulid, required
      - `invoiceType` 'normal' | 'aggregate', required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
  - `numberingEvents` BillingNumberingEvents, required
    - `payment.numberAssignmentFailed` NumberingEventData
      - `entityLocator` string, ulid, required
    - `disbursement.numberAssignmentFailed` NumberingEventData
      - `entityLocator` string, ulid, required
    - `invoice.numberAssignmentFailed` NumberingEventData
      - `entityLocator` string, ulid, required
  - `paymentEvents` PaymentEvents, required
    - `billing.payment.post` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.anonymize` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.cancel` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.validationfailed` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.request` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.reverse` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.distribute` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.execute` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.create` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.discard` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.payment.fail` PaymentEventData
      - `paymentLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
  - `shortfallCreditEvents` ShortfallCreditEvents, required
    - `billing.shortfallcredit.reverse` ShortfallEventData
      - `shortfallCreditLocator` string, ulid, required
    - `billing.shortfallcredit.distribute` ShortfallEventData
      - `shortfallCreditLocator` string, ulid, required
    - `billing.shortfallcredit.create` ShortfallEventData
      - `shortfallCreditLocator` string, ulid, required
  - `writeOffEvents` WriteOffEvents, required
    - `billing.writeoff.reverse` WriteOffEventData
      - `writeOffLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.writeoff.create` WriteOffEventData
      - `writeOffLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
    - `billing.writeoff.distribute` WriteOffEventData
      - `writeOffLocator` string, ulid, required
      - `policyLocators` ListPageResponseULID, required
        - `listCompleted` boolean, required
        - `items` string[], required
  - `holdEvents` HoldEvents, required
    - `billing.hold.create` HoldEventData
      - `holdLocator` string, ulid, required
    - `billing.hold.activate` HoldEventData
      - `holdLocator` string, ulid, required
    - `billing.hold.reset` HoldEventData
      - `holdLocator` string, ulid, required
    - `billing.hold.validate` HoldEventData
      - `holdLocator` string, ulid, required
    - `billing.hold.release` HoldEventData
      - `holdLocator` string, ulid, required
    - `billing.hold.discard` HoldEventData
      - `holdLocator` string, ulid, required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/77ee7d8172b9?raw)