---
title: "Get Invoice Analytics"
method: GET
path: "/v2/customer_portal/invoices/analytics"
---

# Get Invoice Analytics

`GET /v2/customer_portal/invoices/analytics`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/v2/customer_portal/invoices/analytics`
- Auth: API key in header `x-api-key`

## Request body

- object
  - `filter` object
    - `invoice_from_date` string
    - `invoice_to_date` string

## Response `200`

200

- object
  - `type` string
  - `data` object
    - `total_invoices` integer
    - `count_by_status` object
      - `AWAIT_PAYMENT` integer
      - `PARTIALLY_PAID` integer
      - `PAID` integer
      - `BAD_DEBT` integer
      - `CLOSED` integer
      - `CANCELED` integer
      - `READY_TO_INVOICE` integer
    - `outstanding_amount` object
      - `amount` integer
      - `count` integer
    - `over_due` object
      - `amount` number
      - `count` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/v2/customer_portal/invoices/analytics/get.md)

---

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