Skip to main content
POST
Write off a vendor bill balance

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Optional idempotency key (UUID). Re-POST with same key returns cached 200 without re-processing.

Path Parameters

id
string<uuid>
required

Body

application/json
reason
string
required

Human-readable reason for the write-off (e.g., "Vendor bankruptcy", "Negotiated settlement").

notes
string

Optional additional context.

idempotency_key
string<uuid>

Optional idempotency key. Identical to Idempotency-Key header; body value takes precedence.

Response

Bill written off

data
object