Guides
Invoice a customer
Create an invoice, send it, and follow it through to payment.
In a single call
If your system already has the final figures, you can create, number and send the invoice in one request by setting send to true. The response has status sent and an invoiceNumber.
sendTo replaces the customer’s email address on file for this send only. sendMessage is added to the body of the email.
Step by step
When someone needs to check the invoice before it goes out, split the work up:
- Create it with
POST /invoicesand leave outfinalizeandsend. It’s saved as a draft. - Make changes with
PATCH /invoices/{id}while it’s still a draft. - Lock it and assign a number with
POST /invoices/{id}/finalize. - Email it with
POST /invoices/{id}/send.
Get the PDF
The PDF uses the workspace’s invoice template and the invoice’s language. Use it to archive a copy or attach it in your own system.
Check payment status
Fetch the invoice with GET /invoices/{id}, or list with status=paid and issuedAfter to pick up recent payments. Once an invoice is paid, paidAt holds the time the payment was recorded.