Create a snapshot of payables

Allowed Scopes: payable:read

Request an extract (snapshot) of expenses to be created.

A request to create a snapshot of expenses according to the filters provided will be queued, where a key (of format UUID) will be returned immediately, it being a reference to your request.

This key can be used to check for the status of this request using the GET Snapshot Payable API call. Once its status is "COMPLETE", the list of payables is returned under the "result.data" element of the response.

Requesting snapshots should be done sequentially and cannot be done simultaneously (in parallel). Requesting a new snapshot with exactly the same parameters will return the same key as long as the snapshot exists. Snapshots are typically cached for 10 hours.

These two APIs (POST and GET) are implemented based on the asynchronous request-response pattern, decoupling long-running backend jobs from the synchronous nature of REST APIs.

For more information about payables, see this guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
bookkeepingStatus
array of objects

A list of statuses to filter payables by.

bookkeepingStatus
Allowed:
date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

ids
array of uuids

A list of payable IDs to filter by.

ids
string
enum
Defaults to payableDate

Determines by which field payables are sorted.

Allowed:
string
enum
Defaults to desc

Determines in which order payables are sorted by.

Allowed:
date
^\d{4}-\d{2}-\d{2}$

Period start date.

date
^\d{4}-\d{2}-\d{2}$

Period end date, no more than 31 days from fromPayableDate

date
^\d{4}-\d{2}-\d{2}$

Period start date for the creation date.

date
^\d{4}-\d{2}-\d{2}$

Period end date for the creation date, that will be defaulted to the end of day (so T23:59:59).

date
^\d{4}-\d{2}-\d{2}$

Returns payables modified after a given date.

date
^\d{4}-\d{2}-\d{2}$

Returns payables with a due date on or after the given date.

date
^\d{4}-\d{2}-\d{2}$

Returns payables with a due date on or before the given date.

type
array of strings

A list of payable types to filter by.

type
supplierIds
array of strings

A list of supplier IDs to filter by.

supplierIds
boolean

When true, returns only overdue payables. When false, returns only non-overdue payables.

boolean

When true, returns only payables with a settlement. When false, returns only payables without a settlement.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json