Get payables
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:
Documentation Index
Fetch the complete documentation index at: https://docs.tesouro.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The ID of the entity that owns the requested resource.
"9d2b4c8f-2087-4738-ba91-7359683c49a4"
Query Parameters
Sort order (ascending by default). Typically used together with the sort parameter.
asc, desc 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.
1 <= x <= 100A 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.
The field to sort the results by. Typically used together with the order parameter.
id, created_at, issued_at, due_date 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].
Return only payables created in Monite before the specified date and time.
Return only payables created in Monite on or after the specified date and time.
Return only payables created in Monite before or on the specified date and time.
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>
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.
Return only payables whose total amount (in minor units) exceeds the specified value.
Return only payables whose total amount (in minor units) is less than the specified value.
Return only payables whose total amount (in minor units) is greater than or equal to the specified value.
Return only payables whose total amount (in minor units) is less than or equal to the specified value.
Return only payables with the specified amount.
Return only payables whose amount (in minor units) exceeds the specified value.
Return only payables whose amount (in minor units) is less than the specified value.
Return only payables whose amount (in minor units) is greater than or equal to the specified value.
Return only payables whose amount (in minor units) is less than or equal to the specified value.
Return only payables that use the specified currency.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SOS, SRD, SSP, SVC, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW 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.
Return only payables received from counterparts whose name contains the specified string (case-sensitive).
Return only payables received from counterparts whose name contains the specified string (case-insensitive).
Apply the icontains condition to search for the specified text in the document_id and counterpart_name fields in the payables.
Return payables that are due on the specified date (YYYY-MM-DD)
Return payables that are due after the specified date (exclusive, YYYY-MM-DD).
Return payables that are due before the specified date (exclusive, YYYY-MM-DD).
Return payables that are due on or after the specified date (YYYY-MM-DD).
Return payables that are due before or on the specified date (YYYY-MM-DD).
Return payables that are issued at the specified date (YYYY-MM-DD)
Return payables that are issued after the specified date (exclusive, YYYY-MM-DD).
Return payables that are issued before the specified date (exclusive, YYYY-MM-DD).
Return payables that are issued on or after the specified date (YYYY-MM-DD).
Return payables that are issued before or on the specified date (YYYY-MM-DD).
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).
Return only payables whose document number (document_id) contains the specified string (case-sensitive).
Return only payables whose document number (document_id) contains the specified string (case-insensitive).
Return only payables created in Monite by the entity user with the specified ID.
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.
Return only payables received from the counterparts with the specified IDs. Valid but nonexistent IDs do not raise errors but produce no results.
To specify multiple IDs, repeat this parameter for each value: counterpart_id__in=<id1>&counterpart_id__in=<id2>
Return only payables coming from the specified source.
ocr, user_specified, einvoicing Return only payables with specific OCR statuses.
processing, error, success, canceled Search for a payable by the identifier of the line item associated with it.
Search for a payable by the identifier of the purchase order associated with it.
Return only payables assigned to the project with the specified ID.
Valid but nonexistent project IDs do not raise errors but return no results.
Return only payables whose project_id include at least one of the project_id with the specified IDs. Valid but nonexistent project IDs do not raise errors but produce no results.
Return only payables whose tags include at least one of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce no results.
Return only payables whose tags do not include any of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce the results.
Filter objects based on whether they have tags. If true, only objects with tags are returned. If false, only objects without tags are returned.
Return only payables from a given origin ['einvoice', 'upload', 'email']
upload, email, einvoicing Return only payables with or without attachments (files)
Response
Successful Response
A paginated list of payables.
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).
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).