Skip to main content
The InvoiceCreate event fires each time a new invoice is saved to a sub-account, whether as a draft or in any other initial status. Use this event to sync invoices to external accounting systems, trigger onboarding workflows, or log invoice activity in your own data store.

​
Payload

FieldTypeDescription
_idstringUnique identifier for the invoice
statusstringCurrent invoice status (e.g., draft, sent, paid)
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, custom values)
businessDetails.namestringBusiness name
businessDetails.addressstringBusiness address
businessDetails.phoneNostringBusiness phone number
businessDetails.websitestringBusiness website URL
businessDetails.logoUrlstringURL of the business logo
businessDetails.customValuesarrayAdditional custom values associated with the business
invoiceNumberstringHuman-readable invoice number
currencystringISO 4217 currency code (e.g., USD)
contactDetailsobjectRecipient contact information (id, phone, email, name, address, company)
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 product ID, price ID, 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": "draft",
  "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",
    "customValues": ["string"]
  },
  "invoiceNumber": "19",
  "currency": "USD",
  "contactDetails": {
    "id": "6578278e879ad2646715ba9c",
    "phoneNo": "+1-214-559-6993",
    "email": "alex@example.com",
    "name": "Alex",
    "address": {
      "countryCode": "US",
      "addressLine1": "9931 Beechwood",
      "city": "St. Houston",
      "state": "TX",
      "postalCode": "559-6993"
    },
    "companyName": "ABC Corp."
  },
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-01",
  "discount": { "type": "percentage", "value": 10 },
  "invoiceItems": [
    {
      "taxes": [],
      "_id": "c6tZZU0rJBf30ZXx9Gli",
      "productId": "c6tZZU0rJBf30ZXx9Gli",
      "priceId": "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 Sent — fires when an invoice is delivered to the contact
  • Invoice Paid — fires when an invoice is fully paid
  • Invoices API — create, retrieve, and manage invoices programmatically
Last modified on March 4, 2026