ApiInvoices

Void an invoice

Withdraw it. Its link stops accepting payment and reminders stop.

POST
/api/b/v1/invoices/{invoice_id}/void

Withdraw it. Its link stops accepting payment and reminders stop.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Path Parameters

invoice_id*Invoice Id
Formatuuid
admin_access_token?string|null

Response Body

application/json

application/json

curl -X POST "https://example.com/api/b/v1/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/void"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "number": "string",  "customer_name": "string",  "customer_email": "string",  "currency": "string",  "subtotal_minor": 0,  "tax_minor": 0,  "total_minor": 0,  "paid_minor": 0,  "outstanding_minor": 0,  "state": "draft",  "due_date": "2019-08-24",  "sent_at": "2019-08-24T14:15:22Z",  "paid_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "payment_link_slug": "string",  "lines": []}

Send an invoice POST

Issue it and make it payable — AC 1. Returns the payment link slug, which is what the customer opens.

Set the reminder schedule PUT

Replace the schedule — AC 2. Reminders stop on payment or void without being cancelled here: that is a property of the invoice's state, not a list someone has to remember to clear.