---
title: "Get payables analytics"
method: GET
path: "/payables/analytics"
tags: ["Payables"]
deprecated: true
---

# Get payables analytics

`GET /payables/analytics`

## Request

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

> **Deprecated.**

Retrieve aggregated statistics for payables, including total amount and count, both overall and by status.

For more flexible configuration and retrieval of other data types, use `GET /analytics/payables`.

## Query parameters

- `created_at__gt` string, date-time
- `created_at__lt` string, date-time
- `created_at__gte` string, date-time
- `created_at__lte` string, date-time
- `status` 'draft' | 'new' | 'approve_in_progress' | 'waiting_to_be_paid' | 'partially_paid' | 'paid' | 'canceled' | 'rejected'
- `status__in` 'draft' | 'new' | 'approve_in_progress' | 'waiting_to_be_paid' | 'partially_paid' | 'paid' | 'canceled' | 'rejected'
- `id__in` string, uuid
- `total_amount` integer
- `total_amount__gt` integer
- `total_amount__lt` integer
- `total_amount__gte` integer
- `total_amount__lte` integer
- `amount` integer
- `amount__gt` integer
- `amount__lt` integer
- `amount__gte` integer
- `amount__lte` integer
- `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW'
- `counterpart_name` string
- `counterpart_name__contains` string
- `counterpart_name__icontains` string
- `search_text` string
- `due_date` string, date
- `due_date__gt` string, date
- `due_date__lt` string, date
- `due_date__gte` string, date
- `due_date__lte` string, date
- `issued_at` string, date
- `issued_at__gt` string, date
- `issued_at__lt` string, date
- `issued_at__gte` string, date
- `issued_at__lte` string, date
- `document_id` string
- `document_id__contains` string
- `document_id__icontains` string
- `was_created_by_user_id` string, uuid
- `counterpart_id` string, uuid
- `source_of_payable_data` 'ocr' | 'user_specified' | 'einvoicing'
- `ocr_status` 'processing' | 'error' | 'success'
- `line_item_id` string, uuid
- `purchase_order_id` string, uuid
- `project_id` string, uuid
- `project_id__in` string, uuid
- `tag_ids` string, uuid
- `tag_ids__not_in` string, uuid
- `has_tags` boolean
- `origin` 'upload' | 'email' | 'einvoicing'
- `has_file` boolean

## Headers

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

## Response `200`

Successful Response

- PayableAggregatedDataResponse
  - `count` integer, required: The total count of payables across all statuses.
  - `data` PayableAggregatedItem[], required: A list of aggregated items, each representing a status with its associated sum of the amount field and count.
    - `count` integer, required: The total count of payables with this specific status.
    - `status` 'draft' | 'new' | 'approve_in_progress' | 'waiting_to_be_paid' | 'partially_paid' | 'paid' | 'canceled' | 'rejected', required
    - `sum_total_amount` integer, required: The total sum of the amount field for all payables with this specific status.
  - `sum_total_amount` integer, required: The total sum of the amount field for all payables across all statuses.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Validation Error
- `500`: Internal Server Error

---

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