Purpose
Theinvoice.voided webhook is triggered when an Invoice is voided, either in the Salesbricks app or through the public API.
Only voids a person makes send this event, not voids Salesbricks makes on its own, such as when an order is deleted.
Voiding is non-destructive: the invoice keeps its history, and its number until it is un-voided and reissued.
Timing and delivery
- One event per void. If a void is reversed (for example, when a terminated subscription is reinstated) and the invoice is voided again, a new event is sent with the new
voided_at, and the reissued invoice carries a newinvoice_number. - Sent after the void completes. Delivery is queued, not made inside the request that voided the invoice.
- Not sent for invoices migrated from another system before your cutover date, or for invoices on deleted or lost orders.
Payload format
Your configured endpoint will receive an Invoice payload withstatus set to VOIDED and one extra field, voided_at, the time of the void as an ISO 8601 timestamp. Treat the invoice as cancelled: remaining_amount is left as it was before the void, so don’t read it as a balance owed.
JSON