Appearance
invoices
11 endpoints at a glance
| Method | Path | Summary |
|---|---|---|
GET | /invoices | List Invoices |
POST | /invoices | Create Invoice |
DELETE | /invoices/{invoice_id} | Delete Invoice |
GET | /invoices/{invoice_id} | Get Invoice |
PATCH | /invoices/{invoice_id} | Update Invoice |
POST | /invoices/{invoice_id}/credit | Credit Invoice |
POST | /invoices/{invoice_id}/email | Email Invoice |
POST | /invoices/{invoice_id}/finalize | Finalize Invoice |
POST | /invoices/{invoice_id}/payment | Register Payment |
GET | /invoices/{invoice_id}/pdf | Invoice Pdf |
GET | /invoices/{invoice_id}/preview | Preview Invoice |
invoices
List Invoices
Create Invoice
POST
/invoices
Parameters
Header Parameters
authorization
Request Body
application/json
JSON "customer_ref": { "type": "string", "id": "string", "ref": { "additionalProperties": "string" }, "label": "string" }, "issue_date": "string", "due_date": "string", "reference": "string", "notes": "string", "deal_id": "string", "lines": [ { "description": "", "quantity": 1, "unit_price_cents": 0, "btw_code": "string", "revenue_account_id": "string" } ]
{
}
Responses
Successful Response
application/json
JSON "additionalProperties": "string"
{
}
Get Invoice
Delete Invoice
Update Invoice
PATCH
/invoices/{invoice_id}
Parameters
Header Parameters
authorization
Path Parameters
invoice_id*
Type
Requiredstring
Request Body
application/json
JSON "customer_ref": { "type": "string", "id": "string", "ref": { "additionalProperties": "string" }, "label": "string" }, "issue_date": "string", "due_date": "string", "reference": "string", "notes": "string", "lines": [ { "description": "", "quantity": 1, "unit_price_cents": 0, "btw_code": "string", "revenue_account_id": "string" } ]
{
}
Responses
Successful Response
application/json
JSON "additionalProperties": "string"
{
}
Preview Invoice
GET
/invoices/{invoice_id}/preview
Print-friendly HTML of the invoice (same template as the PDF).
Works on any host (no native deps) — the frontend embeds it and the browser
can print-to-PDF as a fallback. A draft resolves its bill-to on the fly.
Parameters
Header Parameters
authorization
Path Parameters
invoice_id*
Type
Requiredstring
Responses
Successful Response
text/html
JSON
"string"
Invoice Pdf
GET
/invoices/{invoice_id}/pdf
The invoice as a PDF (WeasyPrint). 501 if the host lacks the native libs
(production has them) — use the print-friendly preview in that case.
Parameters
Header Parameters
authorization
Path Parameters
invoice_id*
Type
Requiredstring
Responses
Successful Response
application/json
JSON
[
]
Email Invoice
POST
/invoices/{invoice_id}/email
E-mail the invoice PDF to the customer via the user's own SMTP.
Only finalized invoices (status sent/paid) can be e-mailed — a
draft has no number and no booked journaalpost. Sending stamps
emailed_at/emailed_to (distinct from status sent, which means
finalized) and logs an activity on the customer's timeline. The
Sent-folder copy is best-effort.
Parameters
Header Parameters
authorization
Path Parameters
invoice_id*
Type
Requiredstring
Request Body
application/json
JSON "to": [ "string" ], "cc": [ "string" ], "subject": "string", "body": "", "account_id": "string"
{
}
Responses
Successful Response
application/json
JSON "additionalProperties": "string"
{
}