Skip to main content
GET
Retrieve payables (supplier invoices, supplier refunds, or card purchases)

Path Parameters

consumer_id
string<uuid>
required

Query Parameters

cursor
string | null
page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100
payable_type
enum<string>
required

Which kind of payable to retrieve. Exactly one type per call. What kind of payable a record is. Distinct from original_payable_type, which is whatever label the connector's own provider uses (e.g. Spendesk's subType) -- this is the normalized, cross-connector classification.

Available options:
supplier_invoice,
supplier_refund,
card_purchase
date_from
string<date> | null

Retrieve payables with a payable date on or after this date.

date_to
string<date> | null

Retrieve payables with a payable date on or before this date.

updated_after
string<date-time> | null

Retrieve payables created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.

export_status
enum<string> | null

Retrieve only payables with this export status, e.g. to_export to fetch exactly the ones still to be synced to the target accounting system. Shared across every payable-like entity of this vertical (payables, financial movements, ...): whether it still needs to be synced to the target accounting system.

Available options:
unknown,
not_ready,
to_export,
exported

Response

Successful Response

items
PayableItem · object[]
required
total
integer
required
Required range: x >= 0
page
integer
required
Required range: x >= 1
size
integer
required
Required range: x >= 1