Mark an invoice as paid

Manually settle an open invoice, moving it to paid and queueing the receipt document. Use this when payment was collected outside Root; an invoice collected by a Root payment moves to paid on its own when that payment succeeds.

Marking an already-paid invoice as paid is a no-op success, so the call is safe to retry. The line items are left in place, unlike void and mark uncollectible.

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 mark as paid.

Body Params
string
length ≤ 255

An audit note recording where the payment came from, persisted onto the invoice's paid event.

Responses

400

The invoice cannot move to paid from its current status. Only an open invoice can be marked paid.

403

Invoicing is not enabled for the organization, or the caller is missing the invoices:mark_paid 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