Skip to main content
GET
/
analytics
/
dashboards
/
payment-breakdown
/
payment-breakdown-group-summaries
Get Payment Breakdown Group Summaries
curl --request GET \
  --url https://api.decodahealth.com/analytics/dashboards/payment-breakdown/payment-breakdown-group-summaries \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "groupKey": "<string>",
    "totalPayments": 123,
    "totalAmount": 123,
    "totalFee": 123,
    "totalNetAmount": 123,
    "uniquePatients": 123,
    "uniqueLocations": 123
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
group_by
enum<string>
required
Available options:
location,
provider,
payment_medium,
created_date,
week,
month
​
timezone
string
required

Timezone for date grouping (e.g., 'America/New_York', 'UTC')

​
sort_by
string
default:created_date
​
sort_direction
enum<string>
default:desc
Available options:
asc,
desc
​
start_date
string | null
​
end_date
string | null
​
location_ids
string[] | null
​
location_names
string[] | null
​
payment_mediums
string[] | null
​
payment_statuses
string[] | null
​
min_amount
integer | null
​
max_amount
integer | null
​
comment
string | null

Response

Successful Response

​
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