Skip to main content
GET
Retrieve 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.

Path Parameters

id
string<uuid>
required

Query Parameters

expand[]
enum<string>[]
Available options:
vendor,
source,
applications

Response

Vendor credit

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).

id
string<uuid>
read-only
entity_id
string<uuid>
read-only
vendor_id
string<uuid>
credit_number
string
read-only

Auto-generated, e.g. VC-0000001

amount
string

Total issued amount (numeric, 4 dp)

remaining_amount
string
read-only

Unapplied balance (numeric, 4 dp)

source_type
enum<string>
default:manual

Origin of the credit. Free-form text; common values listed.

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

Linked vendor_return or vendor_bill id when applicable

status
enum<string>
read-only
Available options:
open,
partially_applied,
applied,
voided,
expired
expires_at
string<date-time> | null

Forfeits remaining balance after this date; NULL = never expire

created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only