---
title: "Get Payment Breakdown Group Summaries"
method: GET
path: "/analytics/dashboards/payment-breakdown/payment-breakdown-group-summaries"
tags: ["provider", "analytics"]
---

# Get Payment Breakdown Group Summaries

`GET /analytics/dashboards/payment-breakdown/payment-breakdown-group-summaries`

## Request

- Base URL: `https://docs.decodahealth.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.decodahealth.com/analytics/dashboards/payment-breakdown/payment-breakdown-group-summaries`
- Auth: none declared. Required headers: `TENANT`, `API-KEY`
- TypeScript: <https://skmtc.dev/decodahealth/apis/decoda-api/docs/analytics/dashboards/payment-breakdown/payment-breakdown-group-summaries/get.ts> (a function with typed inputs; its response is checked against the schema)

Get summary statistics for each group in the payment breakdown.

## Query parameters

- `group_by` 'location' | 'provider' | 'payment_medium' | 'created_date' | 'week' | 'month', required
- `timezone` string, required: Timezone for date grouping (e.g., 'America/New_York', 'UTC')
- `sort_by` string
- `sort_direction` 'asc' | 'desc'
- `start_date` string, nullable
- `end_date` string, nullable
- `location_ids` string[], nullable
- `location_names` string[], nullable
- `payment_mediums` string[], nullable
- `payment_statuses` string[], nullable
- `min_amount` integer, nullable
- `max_amount` integer, nullable
- `comment` string, nullable

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- DecodaAppsApiRoutesAnalyticsDashboardsPaymentBreakdownGroupSummary[]
  - `groupKey` string, required: The group key this summary belongs to
  - `totalPayments` integer, required: Total number of payments in this group
  - `totalAmount` integer, required: Total payment amount (formatted as currency)
  - `totalFee` integer, required: Total fee amount (formatted as currency)
  - `totalNetAmount` integer, required: Total net amount after fees (formatted as currency)
  - `uniquePatients` integer, required: Number of unique patients
  - `uniqueLocations` integer, required: Number of unique locations

## Other responses

- `422`: Validation Error

---

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