Skip to main content
POST
Write Off an Invoice

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-user-id
string | null

Optional external entity identifier that performed the action

Path Parameters

business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

invoice_id
string<inv_string>
required

The id of the invoice

Example:

"inv_WQMDNUHpBThYSNh4AprDBo"

Body

application/json
amount
required

The amount to write off

Example:

500

description
string | null

Optional description for the write-off journal entry

Maximum string length: 512

Response

Successful Response

data
InvoicePublic · object
required