Get Payment Breakdown Summary

Get summary statistics for ungrouped payment breakdown (all filtered results).

get/analytics/dashboards/payment-breakdown/payment-breakdown-summary

Request

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

timezonestring required

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

start_datestring nullable

end_datestring nullable

location_idsstring[] nullable

location_namesstring[] nullable

payment_mediumsstring[] nullable

payment_statusesstring[] nullable

min_amountnumber nullable

max_amountnumber nullable

commentstring nullable

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Successful Response

groupKeystring required

The group key this summary belongs to

totalPaymentsinteger required

Total number of payments in this group

totalAmountinteger required

Total payment amount (formatted as currency)

totalFeeinteger required

Total fee amount (formatted as currency)

totalNetAmountinteger required

Total net amount after fees (formatted as currency)

uniquePatientsinteger required

Number of unique patients

uniqueLocationsinteger required

Number of unique locations

No recorded changes to this operation across all 2 revisions of this API.