Skip to main content

Invoice events

Invoice lifecycle, line items, payments, and integrations.

Event typeDescriptionIdentifiers
invoice.createdAn invoice was createdinvoiceId; optional patientId
invoice.updatedAn invoice was updated (excluding line-item-only changes)invoiceId; optional patientId
invoice.deletedAn invoice was deletedinvoiceId; optional patientId
invoice.lineItems.addedOne or more line items were addedinvoiceId
invoice.lineItems.removedOne or more line items were removedinvoiceId
invoice.paidAn invoice was fully paidinvoiceId; optional patientId
invoice.partiallyPaidA payment reduced but did not clear the outstanding balanceinvoiceId; optional patientId
invoice.refundedAn invoice was refundedinvoiceId
invoice.sharedAn invoice was shared with a patientinvoiceId; optional patientId
invoice.integrations.healthcode.statusUpdatedHealthcode integration status changed on an invoiceinvoiceId
invoice.integrations.xero.syncedInvoice was synced to XeroinvoiceId