Get receivables

GET

Returns a list of accounts receivable documents - invoices, quotes, and credit notes - of the specified entity.

Results can be filtered by amount, counterpart, due date, and other criteria. Multiple filters are combined using logical AND unless specified otherwise. If no documents matching the search criteria are found, the endpoint returns a successful response with an empty data array.

This endpoint supports pagination and sorting. By default, results are sorted by the creation date in ascending order (from oldest to newest).

Examples

Invoices

  • Get all overdue invoices:

    GET /receivables?type=invoice&status=overdue

  • Get all invoices created for the counterpart named “Solarwind” (case-insensitive):

    GET /receivables?type=invoice?counterpart_name__icontains=Solarwind

  • Get invoices whose total amount starts from 500 EUR:

    GET /receivables?type=invoice&total_amount__gte=50000

  • Get invoices that are due for payment in September 2024:

    GET /receivables?type=invoice&due_date__gte=2024-09-01T00:00:00Z&due_date__lt=2024-10-01T00:00:00Z

  • Get invoices created on or after September 1, 2024:

    GET /receivables?type=invoice&created_at__gte=2024-09-01T00:00:00Z

  • Find an invoice created from a specific quote:

    GET /receivables?type=invoice?based_on=QUOTE_ID
Quotes

  • Get the latest created quote:

    GET /receivables?type=quote&sort=created_at&order=desc&limit=1

  • Get the latest issued quote:

    GET /receivables?type=quote&sort=issue_date&order=desc&limit=1
Credit notes

  • Find all credit notes created for a specific invoice:

    GET /receivables?type=credit_note?based_on=INVOICE_ID

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

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

Allowed values: ascdesc
limitintegerOptional

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.

When using pagination with a non-default limit, you must provide the limit value alongside pagination_token in all subsequent pagination requests. Unlike other query parameters, limit is not inferred from pagination_token.

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 except limit are ignored and inferred from the initial query.

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

id__instringOptional

Return only receivables 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: id__in=<id1>&id__in=<id2>

status__inenumOptional

Return only receivables that have the specified statuses. See the applicable invoice statuses, quote statuses, and credit note statuses.

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

entity_user_id__instringOptional

Return only receivables created by the entity users with the specified IDs.To specify multiple user IDs, repeat this parameter for each ID: entity_user_id__in=<user1>&entity_user_id__in=<user2>

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.

sortenumOptional

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

tag_ids__instringOptional

Return only receivables whose tags include at least one of the tags with the specified IDs.

For example, given receivables with the following tags:

  1. tagA
  2. tagB
  3. tagA, tagB
  4. tagC
  5. tagB, tagC

tag_ids__in=<tagA>&tag_ids__in=<tagB> will return receivables 1, 2, 3, and 5.

Valid but nonexistent tag IDs do not raise errors but produce no results.

typeenumOptional
Allowed values: quoteinvoicecredit_note
document_idstringOptional
document_id__containsstringOptional
document_id__icontainsstringOptional
issue_date__gtdatetimeOptional
issue_date__ltdatetimeOptional
issue_date__gtedatetimeOptional
issue_date__ltedatetimeOptional
created_at__gtdatetimeOptional
created_at__ltdatetimeOptional
created_at__gtedatetimeOptional
created_at__ltedatetimeOptional
counterpart_idstringOptional
counterpart_namestringOptional
counterpart_name__containsstringOptional
counterpart_name__icontainsstringOptional
total_amountintegerOptional
total_amount__gtintegerOptional
total_amount__ltintegerOptional
total_amount__gteintegerOptional
total_amount__lteintegerOptional
statusenumOptional
entity_user_idstringOptional
based_onstringOptional
due_date__gtstringOptional
due_date__ltstringOptional
due_date__gtestringOptional
due_date__ltestringOptional
project_idstringOptional

Response

This endpoint returns an object.
datalist of objects
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

Create a receivable