---
title: "Get receivables analytics"
method: GET
path: "/analytics/receivables"
tags: ["Analytics"]
---

# Get receivables analytics

`GET /analytics/receivables`

## Request

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

Retrieve aggregated statistics for receivables with different breakdowns.

## 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'
- `limit` integer
- `pagination_token` string
- `id__in` string, uuid
- `status__in` 'draft' | 'issuing' | 'issued' | 'failed' | 'accepted' | 'expired' | 'declined' | 'recurring' | 'partially_paid' | 'paid' | 'overdue' | 'uncollectible' | 'canceled'
- `entity_user_id__in` string, uuid
- `sort` '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
- `tag_ids` string, uuid
- `product_ids__in` string, uuid
- `product_ids` string, uuid
- `project_id__in` string, uuid
- `type` '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
- `total_amount` integer
- `total_amount__gt` integer
- `total_amount__lt` integer
- `total_amount__gte` integer
- `total_amount__lte` integer
- `discounted_subtotal` integer
- `discounted_subtotal__gt` integer
- `discounted_subtotal__lt` integer
- `discounted_subtotal__gte` integer
- `discounted_subtotal__lte` integer
- `status` '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
- `search_text` string

## Headers

- `x-monite-version` string, required
- `x-monite-entity-id` string, required

## Response `200`

Successful Response

- ReceivablesAnalyticsResponse
  - `data` ReceivablesAnalyticsDataPoint[], required
    - `dimension_value` string
    - `metric_value` integer, required

## Other responses

- `400`: Bad Request
- `401`: The `Authorization` header is missing or contains an invalid or expired access token. See [Authentication](https://docs.monite.com/api/concepts/authentication) to learn how to authenticate API calls.
- `403`: The specified access token does not have permissions to perform this operation.
- `422`: Validation Error
- `429`: API rate limit has been exceeded. Check the response headers for the rate limit information.

---

[API](https://skmtc.dev/monite/apis/monite-2.md) - [All operations](https://skmtc.dev/monite/apis/monite-2/llms.txt) - [OpenAPI document](https://skmtc.dev/monite/apis/monite-2/revisions/4299ccf95edb?raw)