API reference · Invoices
POST/api/v1/invoices/{id}/pdf

Generate invoice PDF asset

Generates/refreshes invoice PDF metadata and returns file_id plus optional download_url.

RBAC · invoice

Path parameters

idstring <uuid>Required
Path UUID parameter resolved by ApiBaseController.extractIdFromPath().

Response body

Success response 200 · schema FinancialInvoiceApiSuccess

dataanyOfRequired
anyOf (option 1)object
anyOf (option 2)array of object
itemsobject
metaobject

Response codes

200
PDF generation metadata returned.
400
Invalid invoice id.
401
API key missing/invalid.
403
invoice:pdf permission denied.
404
Invoice not found.
500
Unexpected PDF generation failure.