provider

analytics

Get Revenue Breakdown Group Summaries

Get summary statistics for each group in the revenue breakdown.

get/analytics/dashboards/product-sales-breakdown/revenue-breakdown-group-summaries

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/product-sales-breakdown/revenue-breakdown-group-summaries/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

group_by'location' | 'provider' | 'item_category' | 'payment_medium' | 'created_date' required

timezonestring required

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

sort_bystring

sort_direction'asc' | 'desc'

start_datestring nullable

end_datestring nullable

location_idsstring[] nullable

location_namesstring[] nullable

provider_idsstring[] nullable

provider_namesstring[] nullable

patient_idsstring[] nullable

patient_namesstring[] nullable

item_categoriesstring[] nullable

item_typesstring[] nullable

item_namesstring[] nullable

payment_mediumsstring[] nullable

min_net_amountinteger nullable

max_net_amountinteger nullable

commentstring nullable

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

groupKeystring required

The group key this summary belongs to

totalItemsinteger required

Total number of items in this group

totalQuantityinteger required

Total quantity (formatted)

totalGrossAmountinteger required

Total gross amount (formatted as currency)

totalItemDiscountAmountinteger required

Total item-level discount amount (formatted as currency)

totalChargeDiscountAmountinteger required

Total charge-level discount amount (formatted as currency)

totalTaxAmountinteger required

Total tax amount (formatted as currency)

totalNetAmountinteger required

Total net amount (formatted as currency)

uniquePatientsinteger required

Number of unique patients

uniqueProvidersinteger required

Number of unique providers

uniqueLocationsinteger required

Number of unique locations

Changes

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