Skip to main content
POST
Record a vendor prepayment

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<uuid>

Optional idempotency key. Re-POST with same key returns cached 201 without re-processing.

Path Parameters

id
string<uuid>
required

Vendor account UUID (account_type must be 'vendor').

Body

application/json
amount
number<double>
required

Prepayment amount in entity currency. Must be > 0.

Required range: x >= 0.01
payment_method
enum<string>
required

Tender method used for the advance payment.

Available options:
cash,
check,
card,
ach,
external,
wire,
other
payment_date
string<date> | null

Effective date for the journal entry. Defaults to today if omitted.

note
string | null

Optional free-text note (reference number, reason for advance, etc.).

payment_method_id
string<uuid> | null

Optional reference to an account_payment_methods row.

bank_account_id
string<uuid> | null

Optional bank account reference for ACH / wire payments.

idempotency_key
string<uuid> | null

Alternative idempotency key in body (header takes precedence).

Response

Vendor prepayment recorded

data
object