Skip to main content
The InvoiceDelete event fires when an invoice is permanently removed from a sub-account. Unlike voiding, deletion is irreversible. Use this event to purge invoice records from external systems, reconcile data stores, or audit deletion activity for compliance purposes.

​
Payload

FieldTypeDescription
_idstringUnique identifier of the deleted invoice
statusstringInvoice status at the time of deletion — will be "delete"
liveModebooleantrue when the event originates from a live sub-account; false in test mode
amountPaidnumberTotal amount that had been paid before deletion
altIdstringSub-account (location) ID associated with the invoice
altTypestringResource type for altId — always "location"
namestringInternal name that was assigned to the invoice
invoiceNumberstringHuman-readable invoice number
currencystringISO 4217 currency code (e.g., USD)
issueDatestringDate the invoice was originally issued (YYYY-MM-DD)
dueDatestringOriginal payment due date (YYYY-MM-DD)
totalnumberTotal value of the invoice at the time of deletion
titlestringDisplay title that appeared on the invoice document (e.g., "INVOICE")
amountDuenumberOutstanding balance at the time of deletion
createdAtstringISO 8601 timestamp when the invoice was originally created
updatedAtstringISO 8601 timestamp of the deletion action
totalSummaryobjectSummary object containing subTotal and discount amounts

​
Example payload

{
  "_id": "6578278e879ad2646715ba9c",
  "status": "delete",
  "liveMode": false,
  "amountPaid": 0,
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "invoiceNumber": "19",
  "currency": "USD",
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-01",
  "total": 999,
  "title": "INVOICE",
  "amountDue": 999,
  "createdAt": "2023-12-12T09:27:42.355Z",
  "updatedAt": "2023-12-12T09:27:42.355Z",
  "totalSummary": { "subTotal": 999, "discount": 0 }
}
  • Invoice Create — fires when a new invoice is first created
  • Invoices API — create, retrieve, and manage invoices programmatically
Last modified on March 4, 2026