Accounts payablePayables

Get payables

Lists all payables from the connected entity. If you already have the data of the payable (amount in [minor units]( https://docs.monite.com/references/currencies#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](https://docs.monite.com/api/payables/post-payables) and providing the [base64-encoded]( https://en.wikipedia.org/wiki/Base64) 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](https://docs.monite.com/accounts-payable/approvals/manual-transition), for example. essential data fields to move from `draft` to `new` Related guide: [Create a payable from data](https://docs.monite.com/accounts-payable/payables/collect#create-a-payable-from-data) See also: [Automatic calculation of due date](https://docs.monite.com/accounts-payable/payables/collect#automatic-calculation-of-due-date) [Suggested payment date](https://docs.monite.com/accounts-payable/payables/collect#suggested-payment-date) [Attach file](https://docs.monite.com/accounts-payable/payables/collect#attach-file) [Collect payables by email](https://docs.monite.com/accounts-payable/payables/collect#send-payables-by-email) [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Query parameters

orderenumOptional

Sort order (ascending by default). Typically used together with the sort parameter.

Allowed values:
limitintegerOptional>=1<=100Defaults to 100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstringOptional

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

sortenumOptional

The field to sort the results by. Typically used together with the order parameter.

Allowed values:
created_at__gtdatetimeOptional

Return only payables created in Monite after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm].

created_at__ltdatetimeOptional
Return only payables created in Monite before the specified date and time.
created_at__gtedatetimeOptional
Return only payables created in Monite on or after the specified date and time.
created_at__ltedatetimeOptional
Return only payables created in Monite before or on the specified date and time.
statusenumOptional

Return only payables that have the specified status.

To query multiple statuses at once, use the status__in parameter instead.

status__inenumOptional

Return only payables that have the specified statuses.

To specify multiple statuses, repeat this parameter for each value: status__in=draft&status__in=new

id__instringOptionalformat: "uuid"

Return only payables with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results.

To specify multiple IDs, repeat this parameter for each value: id__in=<id1>&id__in=<id2>

total_amountintegerOptional

Return only payables with the exact specified total amount. The amount must be specified in the minor units of currency. For example, $12.5 is represented as 1250.

total_amount__gtintegerOptional

Return only payables whose total amount (in minor units) exceeds the specified value.

total_amount__ltintegerOptional

Return only payables whose total amount (in minor units) is less than the specified value.

total_amount__gteintegerOptional

Return only payables whose total amount (in minor units) is greater than or equal to the specified value.

total_amount__lteintegerOptional

Return only payables whose total amount (in minor units) is less than or equal to the specified value.

amountintegerOptional
Return only payables with the specified amount.
amount__gtintegerOptional

Return only payables whose amount (in minor units) exceeds the specified value.

amount__ltintegerOptional

Return only payables whose amount (in minor units) is less than the specified value.

amount__gteintegerOptional

Return only payables whose amount (in minor units) is greater than or equal to the specified value.

amount__lteintegerOptional

Return only payables whose amount (in minor units) is less than or equal to the specified value.

currencyenumOptional
Return only payables that use the specified currency.
counterpart_namestringOptional

Return only payables received from counterparts with the specified name (exact match, case-sensitive).

For counterparts of type = individual, the full name is formatted as first_name last_name.

due_datedatetimeOptional

Return payables that are due on the specified date (YYYY-MM-DD)

due_date__gtdatetimeOptional

Return payables that are due after the specified date (exclusive, YYYY-MM-DD).

due_date__ltdatetimeOptional

Return payables that are due before the specified date (exclusive, YYYY-MM-DD).

due_date__gtedatetimeOptional

Return payables that are due on or after the specified date (YYYY-MM-DD).

due_date__ltedatetimeOptional

Return payables that are due before or on the specified date (YYYY-MM-DD).

issued_atstringOptionalformat: "date"

Return payables that are issued at the specified date (YYYY-MM-DD)

issued_at__gtstringOptionalformat: "date"

Return payables that are issued after the specified date (exclusive, YYYY-MM-DD).

issued_at__ltstringOptionalformat: "date"

Return payables that are issued before the specified date (exclusive, YYYY-MM-DD).

issued_at__gtestringOptionalformat: "date"

Return payables that are issued on or after the specified date (YYYY-MM-DD).

issued_at__ltestringOptionalformat: "date"

Return payables that are issued before or on the specified date (YYYY-MM-DD).

document_idstringOptional

Return a payable with the exact specified document number (case-sensitive).

The document_id is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (id).

document_id__containsstringOptional

Return only payables whose document number (document_id) contains the specified string (case-sensitive).

document_id__icontainsstringOptional

Return only payables whose document number (document_id) contains the specified string (case-insensitive).

was_created_by_user_idstringOptionalformat: "uuid"
Return only payables created in Monite by the entity user with the specified ID.
counterpart_idstringOptionalformat: "uuid"
Return only payables received from the counterpart with the specified ID. Counterparts that have been deleted but have associated payables will still return results here because the payables contain a frozen copy of the counterpart data. If the specified counterpart ID does not exist and never existed, no results are returned.
source_of_payable_dataenumOptional
Return only payables coming from the specified source.
Allowed values:
ocr_statusenumOptional
Return only payables with specific OCR statuses.
Allowed values:
line_item_idstringOptionalformat: "uuid"
Search for a payable by the identifier of the line item associated with it.
purchase_order_idstringOptionalformat: "uuid"
Search for a payable by the identifier of the purchase order associated with it.
project_idstringOptionalformat: "uuid"
Return only payables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results.

Response

Successful Response
datalist of objects
next_pagination_tokenstring or null

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_tokenstring or null

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