Mark an invoice as uncollectible

Write an open invoice off as bad debt, moving it to uncollectible. This is terminal: an uncollectible invoice cannot be paid, voided or credited afterwards.

The invoice's line items are deleted in the same transaction and their ledger journal entries are released back to the uninvoiced pool, so the response always carries an empty line_items array.

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 write off.

Body Params
string

Why the invoice is being written off. Recorded on the invoice's uncollectible event.

Responses

400

The invoice cannot move to uncollectible from its current status. Only an open invoice can be written off.

403

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

404

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

409

The invoice's linked payment has already gone to the bank and can no longer be cancelled, or the invoice was modified by a concurrent writer. Reconcile the payment first.

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