Webhook event

`invoice.sent`

An Invoice was sent to the payor.

Payload schema

api_versionanyrequired
contextobject
Present only when source is api. Identifies the acting project and API key.
- developer_platform_api_key_idstring | null · uuid
- developer_platform_project_idstring | null · uuid
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
dataobjectrequired
- objectobjectrequired
  - booking_idsarrayrequired
    The Bookings associated with the Invoice.
    - itemsstring · uuid
  - clinician_idstring | null · uuidrequired
    The Clinician associated with the Invoice.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - currencystring | nullrequired
    The ISO 4217 currency code.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - invoice_notesstring | nullrequired
    The sanitized HTML notes on the Invoice.
  - invoice_numberstring | nullrequired
    The Invoice number, unique within the Organization.
  - line_itemsarrayrequired
    The charges included on the Invoice.
    - itemsobject
      - booking_idstring | null · uuidrequired
        The Booking associated with the line item.
      - created_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
      - currencystring | nullrequired
        The ISO 4217 currency code.
      - discount_amountinteger | nullrequired
        The discount in minor currency units.
      - gross_amountinteger | nullrequired
        The gross amount in minor currency units.
      - idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - net_amountinteger | nullrequired
        The net amount in minor currency units.
      - objectanyrequired
        Discriminator value emitted at object.
      - quantitynumber | nullrequired
        The quantity charged.
      - service_variant_idstring | null · uuidrequired
        The ServiceVariant associated with the charge.
      - tax_amountinteger | nullrequired
        The tax amount in minor currency units.
      - titlestring | nullrequired
        The line item description.
      - totalinteger | nullrequired
        The line total in minor currency units.
      - unit_priceinteger | nullrequired
        The unit price in minor currency units.
      - updated_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - linksobjectrequired
    URLs to related resources.
    - patientstring | null · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - patient_idstring | null · uuidrequired
    The Patient associated with the Invoice.
  - payor_typestring | nullrequired
    The type of party responsible for payment.
  - statusstring | nullrequired
    The Invoice's current status.
    Allowed values: awaiting_patient | being_processed | canceled | credited_error | credited_goodwill | credited_other | credited_overbilled | credited_service_not_delivered | draft | error | no_payment_required | overdue | overpaid | paid | partially_credited | partially_paid | partially_refunded | partially_written_off | payment_scheduled | refunded | scheduled_for_sending | sent_to_debt_collectors | sent_to_insurance_company | sent_to_other_recipient | unpaid | validated | written_off_nonpayer | written_off_other | null
  - subtotalinteger | nullrequired
    The subtotal in minor currency units.
  - supply_datestring | null · daterequired
    The date on which the invoiced services were supplied.
  - tax_amountinteger | nullrequired
    The tax amount in minor currency units.
  - titlestring | nullrequired
    The Invoice title.
  - totalintegerrequired
    The total in minor currency units.
  - total_discount_amountinteger | nullrequired
    The total discount in minor currency units.
  - total_outstandinginteger | nullrequired
    The outstanding amount in minor currency units.
  - total_paidinteger | nullrequired
    The paid amount in minor currency units.
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
developer_platform_project_idstring | null · uuidrequired
The project ID whose credential caused the change. Null for dashboard events.
idstringrequired
Event identifier prefixed with evt_.
livemodebooleanrequired
false for test-event deliveries.
objectanyrequired
sourcestringrequired
Origin of the change. api means a Developer Platform mutation; dashboard means a Carebit-initiated change.
Allowed values: api | dashboard
typeanyrequired

Example

{
  "id": "evt_00000000-0000-4000-8000-000000000012",
  "object": "event",
  "api_version": "v1",
  "created_at": "2026-01-01T09:00:00Z",
  "data":  … }
    "object":  … }
      "id": "00000000-0000-4000-8000-000000000027",
      "object": "invoice",
      "booking_ids":  … ]
        "00000000-0000-4000-8000-000000000001"
      ],
      "clinician_id": "00000000-0000-4000-8000-000000000002",
      "created_at": "2026-01-01T09:00:00Z",
      "currency": "gbp",
      "invoice_notes": "<p>Payment is due within 30 days.</p>",
      "invoice_number": "INV-1001",
      "line_items":  … ]
         … }
          "id": "00000000-0000-4000-8000-000000000028",
          "object": "invoice_line_item",
          "booking_id": "00000000-0000-4000-8000-000000000001",
          "created_at": "2026-01-01T09:00:00Z",
          "currency": "gbp",
          "discount_amount": 0,
          "gross_amount": 25000,
          "net_amount": 25000,
          "quantity": 1,
          "service_variant_id": "00000000-0000-4000-8000-000000000006",
          "tax_amount": 0,
          "title": "Initial consultation",
          "total": 25000,
          "unit_price": 25000,
          "updated_at": "2026-01-01T09:00:00Z"
        }
      ],
      "links":  … }
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
      },
      "patient_id": "00000000-0000-4000-8000-000000000004",
      "payor_type": "patient",
      "status": "unpaid",
      "subtotal": 25000,
      "supply_date": "2026-01-01",
      "tax_amount": 0,
      "title": "Initial consultation",
      "total": 25000,
      "total_discount_amount": 0,
      "total_outstanding": 25000,
      "total_paid": 0,
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "invoice.sent"
}

Prefer plain text? Append ?format=md or send Accept: text/markdown to receive this page as raw Markdown.