Get receivables

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

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

orderenumOptional

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

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

The number of items (0 .. 250) to return in a single page of the response. Default is 100. 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__instringOptionalformat: "uuid"

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__instringOptionalformat: "uuid"

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__instringOptionalformat: "uuid"

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.

tag_idsstringOptionalformat: "uuid"

Return only receivables whose tags include all of the tags with the specified IDs and optionally other tags that are not specified.

For example, given receivables with the following tags:

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

tag_ids=<tagA>&tag_ids=<tagB> will return receivables 3 and 5.

product_ids__instringOptionalformat: "uuid"

Return only receivables whose line items include at least one of the product IDs with the specified IDs.

To specify multiple product IDs, repeat this parameter for each ID: product_ids__in=<product1>&product_ids__in=<product2>

For example, given receivables with the following product IDs:

  1. productA
  2. productB
  3. productA, productB
  4. productC
  5. productB, productC

product_ids__in=<productA>&product_ids__in=<productB> will return receivables 1, 2, 3, and 5.Valid but nonexistent product IDs do not raise errors but produce no results.

product_idsstringOptionalformat: "uuid"

Return only receivables whose line items include all of the product IDs with the specified IDs and optionally other products that are not specified.

To specify multiple product IDs, repeat this parameter for each ID: product_ids=<product1>&product_ids=<product2>

For example, given receivables with the following product IDs:

  1. productA
  2. productB
  3. productA, productB
  4. productC
  5. productA, productB, productC

product_ids=<productA>&product_ids=<productB> will return receivables 3 and 5.

project_id__instringOptionalformat: "uuid"

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

typeenumOptional
Return only receivables of the specified type. Use this parameter to get only invoices, or only quotes, or only credit notes.
Allowed values:
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).

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[.ffffff]][Z|±hh:mm].

issue_date__ltdatetimeOptional

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

issue_date__gtedatetimeOptional

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

issue_date__ltedatetimeOptional

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

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[.ffffff]][Z|±hh:mm].

created_at__ltdatetimeOptional
Return only receivables created before the specified date and time.
created_at__gtedatetimeOptional
Return only receivables created on or after the specified date and time.
created_at__ltedatetimeOptional
Return only receivables created before or on the specified date and time.
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).

total_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.”

total_amount__gtintegerOptional

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

total_amount__ltintegerOptional

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

total_amount__gteintegerOptional

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

total_amount__lteintegerOptional

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

discounted_subtotalintegerOptional

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

discounted_subtotal__gtintegerOptional

Return only receivables whose discounted subtotal (in minor units) is greater than the specified value.

discounted_subtotal__ltintegerOptional

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

discounted_subtotal__gteintegerOptional

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

discounted_subtotal__lteintegerOptional

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

statusenumOptional

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

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

entity_user_idstringOptionalformat: "uuid"

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.

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 or find recurring invoices created from a base invoice.

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

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__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__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__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.

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.

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