Get Payable by ID

Allowed Scopes: payable:read

Retrieves a single payable by its ID. Payable data is cached for up to 20 minutes. Changes made through the API are returned by subsequent reads; changes made in Spendesk can take up to 20 minutes to appear.

Pass include=externalIds to embed the IDs this payable has in external systems (ERPs), such as the ERP document number. It is opt-in because it costs an additional lookup. External IDs are cached for up to 24 hours. Changes made through the API are returned by subsequent reads; changes made in Spendesk can take up to 24 hours to appear.

For accounting export use cases, each line item's net amount is available as lineItems[].financial.netAmount. Amounts are expressed in the smallest unit of the payable currency, for example cents for EUR and USD, pence for GBP, and yen for JPY.

Accounting fields, such as the line items' VAT account and amounts, return the values saved on the payable. Values that Spendesk only suggests in Bookkeep > Prepare (from default accounts or automation rules) are not returned until an accountant prepares the payable. So a created or unprepared payable can return vatAmount 0 while Spendesk displays a VAT amount for it. For final accounting data, read payables whose bookkeepingStatus is prepared, exported or exportedManually.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

ID of the payable to retrieve.

Query Params
include
array of strings

Extra data to embed in the response. externalIds costs one additional lookup per request, so it is opt-in.

include
Allowed:
Headers
string

ID of the company the request acts on. Required with an organisation-level token; not needed with a company-level token.

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