Skip to main content
GET
List the entity's vendor prepayments

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.

Query Parameters

vendor_id
string<uuid>
po_id
string<uuid>
status
enum<string>
default:open
Available options:
open,
all,
active,
partially_applied,
fully_applied,
refunded,
voided
page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100
sort
enum<string>
Available options:
prepayment_number,
payment_date,
payment_method,
amount,
applied_amount,
balance,
status,
vendor_name,
po_number
dir
enum<string>
Available options:
asc,
desc

Response

The prepayments, the counts and the open total.

data
object[]
meta
object
pagination
object
segment_counts
object