Accounts receivableReceivables (invoices, quotes, credit notes)

Search receivables

This is a POST version of the GET /receivables endpoint. Use it to send search and filter parameters in the request body instead of the URL query string in case the query is too long and exceeds the URL length limit of your HTTP client.

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.

Request

This endpoint expects an object.
amountintegerOptional

Return only receivables 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.

amount__gtintegerOptional

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

amount__gteintegerOptional

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

amount__ltintegerOptional

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

amount__lteintegerOptional

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

based_onstringOptionalformat: "uuid"
This parameter accepts a quote ID or an invoice ID. * Specify a quote ID to find invoices created from this quote. * Specify an invoice ID to find credit notes created for this invoice. Valid but nonexistent IDs do not raise errors but produce no results.
counterpart_idstringOptionalformat: "uuid"
Return only receivables created for the counterpart with the specified ID. Counterparts that have been deleted but have associated receivables will still return results here because the receivables contain a frozen copy of the counterpart data. If the specified counterpart ID does not exist and never existed, no results are returned.
counterpart_namestringOptional

Return only receivables created for counterparts with the specified name (exact match, case-sensitive). For counterparts of type = individual, the full name is formatted as first_name last_name.

counterpart_name__containsstringOptional

Return only receivables created for counterparts whose name contains the specified string (case-sensitive).

counterpart_name__icontainsstringOptional

Return only receivables created for counterparts whose name contains the specified string (case-insensitive).

created_at__gtdatetimeOptional

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

created_at__gtedatetimeOptional
Return only receivables created on or after the specified date and time.
created_at__ltdatetimeOptional
Return only receivables created before the specified date and time.
created_at__ltedatetimeOptional
Return only receivables created before or on the specified date and time.
document_idstringOptional

Return a receivable 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 receivables whose document number (document_id) contains the specified string (case-sensitive).

document_id__icontainsstringOptional

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

due_date__gtstringOptionalformat: "date"

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

This filter excludes quotes, credit notes, and draft invoices.

due_date__gtestringOptionalformat: "date"

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

This filter excludes quotes, credit notes, and draft invoices.

due_date__ltstringOptionalformat: "date"

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

This filter excludes quotes, credit notes, and draft invoices.

due_date__ltestringOptionalformat: "date"

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

This filter excludes quotes, credit notes, and draft invoices.

entity_user_idstringOptionalformat: "uuid"
Return only receivables created by the entity user with the specified ID. To query receivables by multiple user IDs at once, use the `entity_user_id__in` parameter instead. If the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users. IDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results.
entity_user_id__inlist of stringsOptional
has_due_datebooleanOptional

Return only receivables that have a due date set. true=only invoices with due_date, false=only invoices without due_date

id__inlist of stringsOptional
issue_date__gtdatetimeOptional

Return only non-draft receivables that were issued after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]. Milliseconds are ignored.

issue_date__gtedatetimeOptional

Return only non-draft receivables that were issued on or after the specified date and time.

issue_date__ltdatetimeOptional

Return only non-draft receivables that were issued before the specified date and time.

issue_date__ltedatetimeOptional

Return only non-draft receivables that were issued before or on the specified date and time.

limitintegerOptional>=1<=250Defaults to 100
orderenumOptional
Allowed values:
pagination_tokenstringOptional
product_idslist of stringsOptional
product_ids__inlist of stringsOptional
project_idstringOptionalformat: "uuid"
Return only receivables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results.
project_id__inlist of stringsOptional
search_textstringOptional

Case-insensitive and partial match search for the specified text in the document_id and counterpart_name fields of the receivables.

sortenumOptional
statusenumOptional
Return only receivables that have the specified status. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle). To query multiple statuses at once, use the `status__in` parameter instead.
status__inlist of stringsOptional
tag_idslist of stringsOptional
tag_ids__inlist of stringsOptional
typeenumOptional
Return only receivables of the specified type. Use this parameter to get only invoices, or only quotes, or only credit notes.
Allowed values:

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