Create Invoice

View as Markdown

Creates an invoice. items is required. allow_post is optional; when true, the invoice is posted immediately after creation (the project must have allow_create_and_post enabled, otherwise the request is rejected with 400).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active project.

Request

This endpoint expects an object.
customer_idstringRequiredformat: "uuid"
invoice_datedatetimeRequired

Must include exactly 3 fractional-second digits, e.g. 2025-12-29T18:00:00.000Z. Timestamps with no fractional seconds, or with a different digit count (e.g. microseconds), are rejected.

itemslist of objectsRequired
exchange_ratedoubleOptional
debit_account_idstringOptionalformat: "uuid"
sales_personnel_idstringOptionalformat: "uuid"

Sales personnel to credit for this invoice. Accepts either a ProfileSalesPersonnel id or a Contact id; if a Contact id is given and no sales-personnel record is linked to it yet, one is created automatically.

commissionobjectOptional

Per-invoice override of the workspace’s default commission terms.

order_idstringOptional
subjectstringOptional
due_datedatetimeOptional

Must include exactly 3 fractional-second digits, e.g. 2025-12-29T18:00:00.000Z. Timestamps with no fractional seconds, or with a different digit count (e.g. microseconds), are rejected.

reverse_chargebooleanOptional
adjustmentslist of objectsOptional
allow_postbooleanOptional

Response

Created
dataobject
statusboolean
messagestring