Skip to main content
POST
Issue a vendor credit

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.

Body

application/json
vendor_id
string<uuid>
required

Vendor account id

amount
number
required

Positive amount being credited

reason
string | null

Free-text reason recorded in activity_log

source_type
enum<string>
default:manual

Origin of the credit; recorded on the ledger row

Available options:
manual,
vendor_return,
price_adjustment,
rebate,
duplicate_payment,
other
source_id
string<uuid> | null

Linked vendor_return or vendor_bill id (used for idempotency)

expires_at
string<date-time> | null

Future date; defaults to entity setting (NULL = never expire)

notes
string | null

Response

Created vendor credit

data
object

A vendor credit -- a ledger entry that reduces what you owe a vendor. Issued from a vendor return, a negotiated discount, or a manual grant. Posts GL: DR vendor_returns_receivable / CR vendor_credits at issuance. Apply to an open vendor bill via POST /v1/ap-payments with vendor_credit_ids[]. Mirrors the canonical public.vendor_credits ledger (NOT the legacy vendor_bills negative-amount pattern).