API reference · Invoices
POST/api/v1/invoices

Create invoice

Creates an invoice record via ApiBaseController.create() and invoice create schema.

RBAC · invoice

Request body

Content type: application/json · schema InvoiceCreateBody

client_idstring <uuid>Required
invoice_datestringRequired
due_datestringRequired
subtotalintegerRequired
≥ 0
taxintegerRequired
≥ 0
total_amountintegerRequired
≥ 0
statusstringRequired
Enum: draftsentpaidoverduecancelledpendingprepaymentpartially_applied
credit_appliedinteger
≥ 0
is_manualboolean
is_prepaymentboolean
itemsarray of object
itemsobject

Response body

Success response 201 · schema FinancialInvoiceApiSuccess

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

Response codes

201
Invoice created.
400
Invalid invoice payload.
401
API key missing/invalid.
403
invoice:create permission denied.
500
Unexpected invoice creation failure.