Skip to main content
GET
/
analytics
/
receivables
Get receivables analytics
curl --request GET \
  --url https://api.sandbox.monite.com/v1/analytics/receivables \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "metric_value": 123,
      "dimension_value": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Query Parameters

​
dimension
enum<string>
Available options:
created_at,
status,
counterpart_id,
currency,
issue_date,
due_date,
project_id,
product_id
​
metric
enum<string>
required
Available options:
id,
total_amount,
product_amount,
product_quantity
​
aggregation_function
enum<string>
required
Available options:
count,
average,
summary,
min,
max
​
date_dimension_breakdown
enum<string>
Available options:
daily,
weekly,
monthly,
quarterly,
yearly
​
order
enum<string>
default:asc

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

Available options:
asc,
desc
​
limit
integer
default: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.

Required range: 1 <= x <= 250
​
pagination_token
string

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__in
string<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__in
enum<string>[]

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

Available options:
draft,
issuing,
issued,
failed,
accepted,
expired,
declined,
recurring,
partially_paid,
paid,
overdue,
uncollectible,
canceled
​
entity_user_id__in
string<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.

​
sort
enum<string>

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

Available options:
counterpart_name,
counterpart_id,
amount,
total_amount,
discounted_subtotal,
status,
due_date,
issue_date,
document_id,
created_at,
project_id
​
tag_ids__in
string<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_ids
string<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__in
string<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_ids
string<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__in
string<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.

​
type
enum<string>
Available options:
quote,
invoice,
credit_note
​
document_id
string
​
document_id__contains
string
​
document_id__icontains
string
​
issue_date__gt
string<date-time>
​
issue_date__lt
string<date-time>
​
issue_date__gte
string<date-time>
​
issue_date__lte
string<date-time>
​
created_at__gt
string<date-time>
​
created_at__lt
string<date-time>
​
created_at__gte
string<date-time>
​
created_at__lte
string<date-time>
​
counterpart_id
string<uuid>
​
counterpart_name
string
​
counterpart_name__contains
string
​
counterpart_name__icontains
string
​
amount
integer
​
amount__gt
integer
​
amount__lt
integer
​
amount__gte
integer
​
amount__lte
integer
​
status
enum<string>
Available options:
draft,
issuing,
issued,
failed,
accepted,
expired,
declined,
recurring,
partially_paid,
paid,
overdue,
uncollectible,
canceled
​
entity_user_id
string<uuid>
​
based_on
string<uuid>
​
due_date__gt
string<date>
​
due_date__lt
string<date>
​
due_date__gte
string<date>
​
due_date__lte
string<date>
​
has_due_date
boolean
​
project_id
string<uuid>

Response

Successful Response

​
data
object[]
required