Invoice events
Invoice lifecycle, line items, payments, and integrations.
| Event type | Description | Identifiers |
|---|---|---|
invoice.created | An invoice was created | invoiceId; optional patientId |
invoice.updated | An invoice was updated (excluding line-item-only changes) | invoiceId; optional patientId |
invoice.deleted | An invoice was deleted | invoiceId; optional patientId |
invoice.lineItems.added | One or more line items were added | invoiceId |
invoice.lineItems.removed | One or more line items were removed | invoiceId |
invoice.paid | An invoice was fully paid | invoiceId; optional patientId |
invoice.partiallyPaid | A payment reduced but did not clear the outstanding balance | invoiceId; optional patientId |
invoice.refunded | An invoice was refunded | invoiceId |
invoice.shared | An invoice was shared with a patient | invoiceId; optional patientId |
invoice.integrations.healthcode.statusUpdated | Healthcode integration status changed on an invoice | invoiceId |
invoice.integrations.xero.synced | Invoice was synced to Xero | invoiceId |