---
title: "Get Payment Breakdown Groups"
method: GET
path: "/analytics/dashboards/payment-breakdown/payment-breakdown-groups"
tags: ["provider", "analytics", "analytics"]
---

# Get Payment Breakdown Groups

`GET /analytics/dashboards/payment-breakdown/payment-breakdown-groups`

Get payment breakdown groups with totals for the GroupedTableOrchestrator.

Returns distinct group keys with their total counts for efficient grouping.

## 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')
- `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` number, nullable
- `max_amount` number, nullable
- `comment` string, nullable

## Headers

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

## Response `200`

Successful Response

- DecodaAppsApiRoutesAnalyticsDashboardsPaymentBreakdownGroupItem[]
  - `key` string, required
  - `label` string, required
  - `total` integer, required

## 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-service-production.skmtc.workers.dev/v1/apis/decodahealth/decoda-api/revisions/4939a65a89d2/schema)