Skip to main content
GET
Retrieve a vendor bill

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:
lines,
lines.product,
payments,
gl_entries,
vendor,
purchase_order

Response

Vendor bill

A vendor invoice (AP). Posts to AP and inventory/expense on approval.

id
string<uuid>
object
enum<string>
Available options:
vendor_bill
entity_id
string<uuid>
read-only
bill_number
string
read-only

Sequential bill number per entity.

vendor_invoice_number
string | null

Vendor's invoice number.

vendor_id
string<uuid>
po_id
string<uuid> | null
status
enum<string>
read-only
Available options:
draft,
pending_approval,
approved,
rejected,
paid,
partially_paid,
voided
bill_date
string<date>
due_date
string<date> | null
subtotal
number
tax_total
number
shipping_total
number
bill_total
number
amount_paid
number
read-only
balance_due
number
read-only

bill_total minus amount_paid. Unlike the sales-side orders.balance_due, this is NEVER coerced to 0 by document lifecycle: a draft or terminal vendor bill still reports its true remaining payable. There is therefore no separate amount_due field on this resource. SSOT: utils/ap-helpers.mjs::updateAPBalance.

currency
string
default:USD
payment_term_id
string<uuid> | null
notes
string | null
metadata
object | null
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only