POST
/
v1
/
businesses
/
{business_id}
/
invoices
/
{invoice_id}
/
write-off

Path Parameters

business_id
string
required

ID of the Business the invoice is associated with.

invoice_id
string
required

ID of the Invoice the write-off is applied to.

Body

external_id
string

Unique ID of the write-off in your system for linking and idempotency.

amount
long

The amount written off. This amount counts towards the invoice total and decreases the outstanding balance of the invoice.

The amount is optional if omitted, default to the entire outstanding balance of the invoice.

If specified, the amount must be a positive value and cannot exceed the current outstanding balance of the invoice.

memo
string

User-specifiable memo indicating the reason for the write-off. Recommended but not required.

destination_ledger_account
AccountIdentifier

Expense account where write off amount is recorded. See AccountIdentifier for more details.

This field is optional and defaults to the bad debt expense account.

If the write-off is for a different reason, such as a charitable donation, a different ledger expense account can be specified here.

write_off_at
ISO8601 timestamp
required

Timestamp when the write off should be recognized in the general ledger. This can be the same time as the invoice was created if it is an intentional charitable contribution or it could be months after the invoice is issued when that invoice is deemed uncollectible.

Response

Returns the created Invoice Write-Off