Finalise an invoice

Finalise a draft invoice, moving it to open. Finalising allocates the invoice number, locks the line items and queues the invoice document for rendering.

Invoices created through create an invoice are already finalised, so this endpoint only applies to invoices a product module created with auto_finalise: false.

Invoicing is opt-in per organization: unless the invoicing feature flag is enabled for your organization this endpoint returns 403.

Path Params
string
required

Must be a UUID. The unique identifier of the invoice to finalise.

Body Params
string
length ≥ 1

The invoice number to use. Omit it to have Root allocate the next number in the organization's sequence.

Responses

400

The invoice is not in draft, so it cannot be finalised.

403

Invoicing is not enabled for the organization, or the caller is missing the invoices:create permission.

404

No such invoice, or the caller's user group does not grant access to its policy.

409

The invoice was modified by a concurrent writer before the transition could be applied.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json