Analytics

Get receivables analytics

Retrieve aggregated statistics for receivables with different breakdowns.

get/analytics/receivables

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/analytics/receivables
  • Auth: HTTP bearer

Query parameters

dimension'created_at' | 'status' | 'counterpart_id' | 'currency' | 'issue_date' | 'due_date' | 'project_id' | 'product_id'
metric'id' | 'total_amount' | 'product_amount' | 'product_quantity' required
aggregation_function'count' | 'average' | 'summary' | 'min' | 'max' required
date_dimension_breakdown'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly'
order'asc' | 'desc'

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

limitinteger

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_tokenstring

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__instring 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'draft' | 'issuing' | 'issued' | 'failed' | 'accepted' | 'expired' | 'declined' | 'recurring' | 'partially_paid' | 'paid' | 'overdue' | 'uncollectible' | 'canceled'

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__instring 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'counterpart_name' | 'counterpart_id' | 'amount' | 'total_amount' | 'discounted_subtotal' | 'status' | 'due_date' | 'issue_date' | 'document_id' | 'created_at' | 'project_id'

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

tag_ids__instring 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_idsstring 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__instring 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_idsstring 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__instring 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'quote' | 'invoice' | 'credit_note'
document_idstring
document_id__containsstring
document_id__icontainsstring
issue_date__gtstring date-time
issue_date__ltstring date-time
issue_date__gtestring date-time
issue_date__ltestring date-time
created_at__gtstring date-time
created_at__ltstring date-time
created_at__gtestring date-time
created_at__ltestring date-time
counterpart_idstring uuid
counterpart_namestring
counterpart_name__containsstring
counterpart_name__icontainsstring
total_amountinteger
total_amount__gtinteger
total_amount__ltinteger
total_amount__gteinteger
total_amount__lteinteger
discounted_subtotalinteger
discounted_subtotal__gtinteger
discounted_subtotal__ltinteger
discounted_subtotal__gteinteger
discounted_subtotal__lteinteger
status'draft' | 'issuing' | 'issued' | 'failed' | 'accepted' | 'expired' | 'declined' | 'recurring' | 'partially_paid' | 'paid' | 'overdue' | 'uncollectible' | 'canceled'
entity_user_idstring uuid
based_onstring uuid
due_date__gtstring date
due_date__ltstring date
due_date__gtestring date
due_date__ltestring date
has_due_dateboolean
project_idstring uuid
search_textstring

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Response

Successful Response

Changes

No recorded changes to this operation across all 1 revision of this API.