Buk Finance can notify your systems through webhooks. Every event is delivered as a POST with the following envelope:
{
"organization": { "id": "<organizationId>", "name": "<organization name>" },
"data": {}
}Event types
| Event | When it fires | data |
|---|---|---|
invoice_reconciled_to_payments | An issued invoice is reconciled with one or more bank movements. | { invoiceId, reconciledAt, movements: [{ movementId, assignedAmount }] } |
invoice_deconciled_from_payments | A reconciliation is undone. | { invoiceId, deconciledAt, movements: [{ movementId, assignedAmount }] } |
collections_reminder_by_invoice | A collection reminder is sent for a single invoice about to expire. | { event: "about_to_expire", invoice: { number, amountToBePaid, dueBy, totalAmount, referenceNumber }, customer: { name, fiscalId, portalURL, verificationCode, logoURL } } |
collections_reminder_by_account | A collection reminder is sent for a customer account. | { invoices: [{ number, amountToBePaid, conciliatedAmount, dueBy, receiverFiscalId, status }], totalAmount, event: { type }, customer: { ... } } |
Registering an endpoint
Webhook endpoints are managed by our team: contact support with the URL you want to receive events at. There is no public API to subscribe.
The full catalogue, with payload schemas, is also published here:
