This reference covers the webhook event names currently available for this record type and an example JSON payload.
X-Event-Type values
InvoiceSentPaymentReceived
Amounts with local in their field name use the workspace currency; other amounts use the invoice currency.
Payloads reflect the record at delivery time and may gain additional fields. Integrations should ignore unknown fields and use the event type plus stable record IDs rather than depending on property order.
Example payload
{
"id": "64ae5aea99f38e74fc78ae46",
"invoiceNumber": 74,
"invoiceNumberFormatted": "E-2023-74",
"accountId": 10016,
"clientId": "6490580de30ecf51c2c22ffa",
"dateCreated": "2023-07-16",
"dateSent": "2023-07-12",
"dateDue": "2023-08-11",
"dateDueCalculated": null,
"datePaid": "2023-07-12",
"clientInfo": {
"id": "6490580de30ecf51c2c22ffa",
"name": "E164",
"initials": null,
"address1": "123 Any Street",
"address2": null,
"city": "Anytown",
"locality": "NY",
"postal": "12020",
"country": "US",
"phone": "+15555551212",
"color": "#8EA3B8",
"taxId": null,
"website": null,
"contact": {
"id": "6490580de30ecf51c2c22ffb",
"accountId": 10016,
"clientId": "6490580de30ecf51c2c22ffa",
"clientPortalUserId": -79,
"firstName": "Geoffrey",
"lastName": "Mina",
"role": null,
"phone": "+12224445234",
"email": "user@email.com",
"mobile": null,
"notes": null,
"defaultContact": true,
"invoiceContact": false,
"portalAccess": true,
"importRecordId": null,
"sampleData": null
},
"roundingIncrement": 1,
"customInfo": false
},
"status": "PARTIAL",
"invoiceType": "STANDARD",
"subTotal": 14950,
"convenienceFee": 0,
"lateFee": 0,
"discountAmount": 0,
"creditApplied": 0,
"tax": 225,
"total": 15175,
"localTotal": 15175,
"paymentTotal": 78.75,
"localPaymentTotal": 78.75,
"amountDue": 15096.25,
"localAmountDue": 15096.25,
"currency": "USD",
"integrationKeys": {
"quickbooksId": null,
"xeroId": null
},
"viewOnlineUrl": "https://clients.domain.com/invoice?token=",
"payments": [
{
"id": "29e34d7b-ef69-4059-bbe9-7b214c38a011",
"amount": 78.75,
"pending": false,
"paidBy": "G. Mina",
"paymentProvider": "CHECK",
"currency": "USD",
"referenceNumber": null,
"memo": null,
"datePaid": "2023-07-12",
"timestamp": "2023-07-12T06:00:00.000Z",
"integratedPayment": false,
"forcePaidInFull": false,
"integrationKeys": {
"quickbooksId": null,
"xeroId": null
},
"isFailedPayment": false,
"localAmount": 78.75
}
]
}
For delivery setup and troubleshooting, see Configure event webhooks. The generated Webhooks & Events documentation is the source of truth for the current event catalog.