Get payables

GET

Lists all payables from the connected entity.

If you already have the data of the payable (amount in minor units, currency, vendor information, and other details) stored somewhere as individual attributes, you can create a payable with these attributes by calling POST /payables and providing the base64-encoded contents of the original invoice file in the field base64_encoded_file.

A payable is a financial document given by an entity`s supplier itemizing the purchase of a good or a service and demanding payment.

The file_name field is optional. If omitted, it defaults to “default_file_name”. If the settings are configured to automatically set suggested_payment_term, this object can be omitted from the request body.

The id generated for this payable can be used in other API calls to update the data of this payable or trigger status transitions, for example. essential data fields to move from draft to new

Related guide: Create a payable from data

See also:

Automatic calculation of due date

Suggested payment date

Attach file

Collect payables by email

Manage line items

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Query parameters

order"asc" or "desc"Optional
Order by
Allowed values: ascdesc
limitintegerOptional
Max is 100
pagination_tokenstringOptional
A token, obtained from previous page. Prior over other filters
sort"id" or "created_at"Optional
Allowed sort fields
Allowed values: idcreated_at
created_at__gtdatetimeOptional
created_at__ltdatetimeOptional
created_at__gtedatetimeOptional
created_at__ltedatetimeOptional
statusenumOptional
status__inenumOptional
id__instringOptional
total_amountintegerOptional
total_amount__gtintegerOptional
total_amount__ltintegerOptional
total_amount__gteintegerOptional
total_amount__lteintegerOptional
amountintegerOptional
amount__gtintegerOptional
amount__ltintegerOptional
amount__gteintegerOptional
amount__lteintegerOptional
currencyenumOptional
counterpart_namestringOptional
due_datestringOptional
due_date__gtstringOptional
due_date__ltstringOptional
due_date__gtestringOptional
due_date__ltestringOptional
document_idstringOptional
document_id__containsstringOptional
document_id__icontainsstringOptional
was_created_by_user_idstringOptional
counterpart_idstringOptional
source_of_payable_data"ocr" or "user_specified"Optional
Allowed values: ocruser_specified
ocr_statusenumOptional
Allowed values: processingerrorsuccess
line_item_idstringOptional

Search for a payable by the identifier of the line_item associated with it.

purchase_order_idstringOptional

Search for a payable by the identifier of the purchase_order associated with it.

project_idstringOptional
Search for a payable by the identifier of the project associated with it.
tag_idsstringOptional
Search for a payable by the identifiers of the tags associated with it.

Response

This endpoint returns an object.
datalist of objects
Represents an Accounts Payable document received from a vendor or supplier.
next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors