---
title: "Get Revenue Breakdown"
method: GET
path: "/analytics/dashboards/product-sales-breakdown/revenue-breakdown"
tags: ["provider", "analytics"]
---

# Get Revenue Breakdown

`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)
- URL: `https://docs.decodahealth.com/analytics/dashboards/product-sales-breakdown/revenue-breakdown`
- 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)

Get detailed revenue breakdown with filtering.

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

## Query parameters

- `group_by` 'location' | 'provider' | 'item_category' | 'payment_medium' | 'created_date', nullable
- `group_key` string, nullable
- `timezone` string, required: Timezone for date grouping (e.g., 'America/New_York', 'UTC')
- `sort_by` string
- `sort_direction` 'asc' | 'desc'
- `start_date` string, nullable
- `end_date` string, nullable
- `location_ids` string[], nullable
- `location_names` string[], nullable
- `provider_ids` string[], nullable
- `provider_names` string[], nullable
- `patient_ids` string[], nullable
- `patient_names` string[], nullable
- `item_categories` string[], nullable
- `item_types` string[], nullable
- `item_names` string[], nullable
- `payment_mediums` string[], nullable
- `min_net_amount` number, nullable
- `max_net_amount` number, nullable
- `comment` string, nullable
- `item_category` string, nullable
- `location` string, nullable
- `provider` string, nullable
- `payment_medium` string, nullable
- `created_date` string, nullable
- `page` integer, nullable
- `per_page` integer, nullable

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- PageRevenueBreakdownItem
  - `data` RevenueBreakdownItem[], required
    - `createdDate` string, date-time, required: Date when the charge was created
    - `location` string, nullable: Location name where the sale occurred
    - `provider` ProviderTiny
      - `id` string, required
      - `firstName` string, required
      - `lastName` string, nullable
      - `email` string, nullable
      - `createdDate` string, date-time, nullable
    - `patient` PatientTiny, required
      - `id` string, required: The unique identifier for the user.
      - `firstName` string, nullable: The user's first name.
      - `lastName` string, nullable: The user's last name.
      - `phoneNumber` string, nullable: The user's phone number.
      - `email` string, nullable: The user's email address.
      - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT'
      - `locationId` string, nullable: The location of the user.
      - `dateOfBirth` string, date, nullable: The date of birth of the patient.
      - `onSchedulingBlacklist` boolean, nullable: Whether the patient is on the scheduling blacklist.
    - `item` string, required: Item or service name
    - `itemType` string, required: Type of the item (PRODUCT, SERVICE, PACKAGE, etc.)
    - `itemCategory` string, required: Category of the item
    - `quantity` number, required: Quantity sold
    - `price` integer, required: Unit price in cents
    - `grossAmount` integer, required: Gross amount before discounts/taxes in cents
    - `itemDiscountAmount` integer, required: Item-level discount amount in cents
    - `chargeDiscountAmount` integer, required: Proportional charge-level discount amount in cents
    - `taxAmount` integer, required: Tax amount in cents
    - `netAmount` integer, required: Net amount after discounts and taxes in cents
    - `paymentMediums` string[], nullable: Payment methods used
    - `chargeId` string, required: Charge ID for reference
    - `comment` string, nullable: Charge comment
  - `total` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/decodahealth/apis/decoda-api.md) - [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) - [OpenAPI document](https://skmtc.dev/decodahealth/apis/decoda-api/revisions/4ab18c80f9e9?raw)