Skip to main content
The InvoiceUpdate event fires whenever a field on an existing invoice is changed — including edits to line items, dates, discounts, or contact details. Use this event to keep external accounting or CRM systems in sync with the latest invoice state without polling the API.

​
Payload

FieldTypeDescription
_idstringUnique identifier for the invoice
statusstringCurrent invoice status after the update (e.g., draft, sent)
liveModebooleantrue when the event originates from a live sub-account; false in test mode
amountPaidnumberTotal amount already paid against this invoice
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 issued (YYYY-MM-DD)
dueDatestringPayment due date (YYYY-MM-DD)
discountobjectDiscount applied to the invoice (type and value)
invoiceItemsarrayUpdated line items on the invoice, each containing name, quantity, amount, currency, and taxes
totalnumberUpdated total invoice value
titlestringDisplay title shown on the invoice document (e.g., "INVOICE")
amountDuenumberUpdated remaining balance owed on the invoice
createdAtstringISO 8601 timestamp when the invoice was originally created
updatedAtstringISO 8601 timestamp of this update
totalSummaryobjectSummary object containing updated subTotal and discount amounts

​
Example payload

{
  "_id": "6578278e879ad2646715ba9c",
  "status": "draft",
  "liveMode": false,
  "amountPaid": 0,
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "invoiceNumber": "19",
  "currency": "USD",
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-01",
  "discount": { "type": "percentage", "value": 10 },
  "invoiceItems": [
    {
      "taxes": [],
      "_id": "c6tZZU0rJBf30ZXx9Gli",
      "currency": "USD",
      "name": "Macbook Pro",
      "qty": 1,
      "amount": 999
    }
  ],
  "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
  • Invoice Sent — fires when an invoice is delivered to the contact
  • Invoices API — create, retrieve, and manage invoices programmatically
Last modified on March 4, 2026