Get Revenue Breakdown

Get detailed revenue breakdown with filtering.

Returns comprehensive revenue data including charge items and sold packages with detailed filtering capabilities.

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

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/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' nullable

group_keystring nullable

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_amountnumber nullable

max_net_amountnumber nullable

commentstring nullable

item_categorystring nullable

locationstring nullable

providerstring nullable

payment_mediumstring nullable

created_datestring nullable

pageinteger nullable

per_pageinteger nullable

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

totalinteger required

Changes

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