---
title: "Get Collections Summary By Customer Endpoint"
method: GET
path: "/v2/analytics/collections/summary-by-customer"
tags: ["analytics"]
---

# Get Collections Summary By Customer Endpoint

`GET /v2/analytics/collections/summary-by-customer`

## Request

- Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.stuut.ai/v2/analytics/collections/summary-by-customer`
- Auth: HTTP bearer

Get collections summary metrics grouped by customer.

## Query parameters

- `interval` 'weekly' | 'monthly' | 'all': Time interval for grouping data.
- `business_unit_id__in` string[], nullable: Filter by business unit IDs
- `partner_id` string, nullable: Scope to one customer instead of every customer in the org.

## Response `200`

Successful Response

- CollectionsSummaryByCustomerResponse
  - `data` CollectionsSummaryByCustomerLineSchema[], required
    - `partner_id` string, required: The customer/partner ID.
    - `partner_name` string, required: The customer/partner name.
    - `partner_account_number` string, nullable, required: The customer/partner account number.
    - `period_start` string, date, required: The period start date.
    - `period_end` string, date, required: The period end date.
    - `balance` integer, required: Total open balance in cents.
    - `amount_overdue` integer, required: Total remaining overdue for the period in cents.
    - `amount_collected` integer, required: Total amount collected in cents.
    - `amount_collected_stuut_touched` integer, required: Total amount collected with Stuut in cents.
    - `amount_collected_automated` integer, required: Total amount collected through Stuut automation in cents.
    - `amount_collected_other` integer, required: Total amount collected outside of Stuut in cents.
    - `amount_issued` integer, required: Total amount issued in cents.
    - `amount_issued_stuut_touched` integer, required: Total amount issued for invoices touched by Stuut in cents.
    - `total_invoice_amount` integer, nullable, required: Total invoice amount for invoices issued in the period in cents.
    - `amount_overdue_stuut_touched` integer, required: Total remaining overdue (Stuut touched) in cents.
    - `amount_receivables` integer, required: Total accounts receivable in cents.
    - `amount_receivables_stuut_touched` integer, required: Total accounts receivable (Stuut touched) in cents.
    - `balance_stuut_touched` integer, required: Total open balance of invoices touched by Stuut in cents.
    - `balance_for_period` integer, required: Total open balance for the period in cents.
    - `balance_for_period_stuut_touched` integer, required: Total open balance for the period (Stuut touched) in cents.
    - `balance_period_start` integer, required: Total open balance at period start in cents.
    - `balance_period_start_stuut_touched` integer, required: Total open balance at period start (Stuut touched) in cents.
    - `dso` number, nullable, required: Days sales outstanding.
    - `dso_stuut_touched` number, nullable, required: Days sales outstanding (Stuut touched).
    - `invoices_collected` integer, required: Total number of invoices collected.
    - `invoices_collected_stuut_touched` integer, required: Total number of invoices collected (Stuut touched).
    - `invoices_issued` integer, required: Total number of invoices issued.
    - `invoices_open` integer, required: Total number of open invoices.
    - `invoices_overdue` integer, required: Total number of overdue invoices.
    - `invoices_paid` integer, required: Total number of paid invoices.
    - `invoices_touched` integer, required: Total number of invoices touched by Stuut.
    - `invoices_touched_and_collected` integer, required: Total number of invoices touched and collected by Stuut.
    - `invoices_touched_and_collected_ratio` number, required: Ratio of invoices touched and collected by Stuut.
    - `avg_days_to_pay_from_due` number, required: Average days to payment from due date.
    - `avg_days_to_pay_from_issued` number, required: Average days to payment from issued date.

## Other responses

- `422`: Validation Error

---

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