provider
analytics
analytics

Get Provider Earnings Group Summaries

Get summary data for each group

get/analytics/dashboards/provider-earnings/provider-earnings-group-summaries

Request

Query parameters

group_by'location' | 'date' required
timezonestring required
start_datestring date nullable
end_datestring date nullable
location_idsstring[] nullable
provider_idsstring[] nullable
provider_namesstring[] nullable
min_earningsinteger nullable
max_earningsinteger 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
totalSoldinteger required
totalDiscountsinteger required
totalTipsinteger required
totalVoidAdjustmentsinteger required
totalTaxesinteger required
totalOutstandingBalancesinteger required
totalRefundsinteger required
totalEarningsinteger required
uniquePatientsinteger required
uniqueLocationsinteger required

Changes

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