{
"data": {
"invoice": {
"currency": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentNumber": "<string>",
"issueDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"subTotal": 123,
"taxAmount": 123,
"totalAmount": 123,
"amountPaid": 123,
"amountCredited": 123,
"outstanding": 123,
"recurringScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recurringOccurrenceNumber": 123,
"memo": "<string>",
"paymentLinkUrl": "<string>",
"ccEmails": [
"<string>"
],
"paymentTermsDays": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentUrl": "<string>",
"customer": {
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"phone": "<string>",
"taxNumber": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"lineItems": [
{
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productName": "<string>",
"taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taxRateSnapshot": {
"code": "<string>",
"name": "<string>",
"source": "<string>",
"rate": 123,
"sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"snapshottedAt": "2023-11-07T05:31:56Z"
},
"quantity": 123,
"unitPrice": 123,
"taxAmount": 123,
"subTotal": 123
}
]
}
},
"id": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actor": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"type": "invoice.credited"
}Webhooks
invoice.credited
An invoice was credited.
Delivered as an HTTP POST to your subscribed URL. The request is HMAC-signed (Dolfin-Signature: t=<unix>,v1=<hex>); verify it before trusting the body. Return any 2xx to acknowledge — non-2xx and timeouts are retried with backoff. Events carry a stable id; de-duplicate on it. data is the full entity snapshot, identical in shape to the corresponding GET endpoint.
WEBHOOK
invoice.credited
{
"data": {
"invoice": {
"currency": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"documentNumber": "<string>",
"issueDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"subTotal": 123,
"taxAmount": 123,
"totalAmount": 123,
"amountPaid": 123,
"amountCredited": 123,
"outstanding": 123,
"recurringScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recurringOccurrenceNumber": 123,
"memo": "<string>",
"paymentLinkUrl": "<string>",
"ccEmails": [
"<string>"
],
"paymentTermsDays": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentUrl": "<string>",
"customer": {
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"phone": "<string>",
"taxNumber": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"lineItems": [
{
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productName": "<string>",
"taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"taxRateSnapshot": {
"code": "<string>",
"name": "<string>",
"source": "<string>",
"rate": 123,
"sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"snapshottedAt": "2023-11-07T05:31:56Z"
},
"quantity": 123,
"unitPrice": 123,
"taxAmount": 123,
"subTotal": 123
}
]
}
},
"id": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actor": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"type": "invoice.credited"
}Body
application/json
Event payload.
Response
200
Return any 2xx to acknowledge receipt.
⌘I