Request a snapshot (list) of payables to be created.
This endpoint will request a snapshot of payables according to the filters provided.
A key
(UUID) will be returned immediately.
This key
can be used to poll for the status of this request (using the /snapshots/payables/{key}
endpoint).
Once the status
is COMPLETE
, the list of payables is returned under the result.data
element of the response.
Only one snapshot can be requested at a time.
Creating a new snapshot with the same parameters will return an existing snapshot ID while the snapshot exists. Snapshots are kept alive for several hours.
These two endpoints implement the so-called asynchronous request-response pattern. This design decouples long-running backend jobs from the synchronous nature of REST APIs.
For more information about payables, see this guide.