Skip to main content
The InvoiceVoid event fires when an invoice is voided, rendering it uncollectible and removing it from outstanding balance calculations. Use this event to reverse accruals in accounting systems, cancel related automations, or notify contacts that a previously issued invoice has been cancelled.

​
Payload

FieldTypeDescription
_idstringUnique identifier for the invoice
statusstringInvoice status at time of event — will be "void"
liveModebooleantrue when the event originates from a live sub-account; false in test mode
amountPaidnumberTotal amount paid before the invoice was voided
altIdstringSub-account (location) ID associated with the invoice
altTypestringResource type for altId — always "location"
namestringInternal name 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 invoice value at the time of voiding
titlestringDisplay title shown on the invoice document (e.g., "INVOICE")
amountDuenumberBalance that was outstanding when the invoice was voided
createdAtstringISO 8601 timestamp when the invoice was created
updatedAtstringISO 8601 timestamp of the most recent update (the void action)
totalSummaryobjectSummary object containing subTotal and discount amounts

​
Example payload

{
  "_id": "6578278e879ad2646715ba9c",
  "status": "void",
  "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