Skip to main content
The InvoiceSent event fires each time an invoice is dispatched to the recipient contact, moving the invoice status to sent. Use this event to log delivery confirmations, start payment-reminder timers, or update CRM records to reflect that a client has been billed.

​
Payload

FieldTypeDescription
_idstringUnique identifier for the invoice
statusstringInvoice status at time of event — will be "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
businessDetailsobjectSender business information (name, address, phone, website, logo URL)
invoiceNumberstringHuman-readable invoice number
currencystringISO 4217 currency code (e.g., USD)
contactDetailsobjectRecipient contact information (id, email, name, company name)
issueDatestringDate the invoice was issued (YYYY-MM-DD)
dueDatestringPayment due date (YYYY-MM-DD)
discountobjectDiscount applied to the invoice (type and value)
invoiceItemsarrayLine items on the invoice, each containing name, quantity, amount, currency, and taxes
totalnumberTotal invoice value before payments
titlestringDisplay title shown on the invoice document (e.g., "INVOICE")
amountDuenumberRemaining balance owed on the invoice
createdAtstringISO 8601 timestamp when the invoice was created
updatedAtstringISO 8601 timestamp of the most recent update
totalSummaryobjectSummary object containing subTotal and discount amounts

​
Example payload

{
  "_id": "6578278e879ad2646715ba9c",
  "status": "sent",
  "liveMode": false,
  "amountPaid": 0,
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "businessDetails": {
    "name": "ABC Corp.",
    "address": "9931 Beechwood, TX",
    "phoneNo": "+1-214-559-6993",
    "website": "wwww.example.com",
    "logoUrl": "https://example.com/logo.png"
  },
  "invoiceNumber": "19",
  "currency": "USD",
  "contactDetails": {
    "id": "6578278e879ad2646715ba9c",
    "email": "alex@example.com",
    "name": "Alex",
    "companyName": "ABC Corp."
  },
  "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 }
}
Last modified on March 4, 2026