---
title: "Get Revenue"
method: GET
path: "/dashboard/revenue"
tags: ["provider", "dashboard"]
---

# Get Revenue

`GET /dashboard/revenue`

## 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/dashboard/revenue`
- Auth: none declared. Required headers: `TENANT`, `API-KEY`
- TypeScript: <https://skmtc.dev/decodahealth/apis/decoda-api/docs/dashboard/revenue/get.ts> (a function with typed inputs; its response is checked against the schema)

Get daily revenue from POS transactions over time, filtered by payment method.

## Query parameters

- `page` integer, nullable
- `per_page` integer, nullable
- `sort_by` string, nullable
- `sort_direction` 'asc' | 'desc', nullable
- `location_id` string, nullable
- `start_date` string, required
- `end_date` string, required
- `location_ids` string[], nullable
- `payment_mediums` string[], nullable
- `tz` string, required
- `limit` integer, nullable

## Headers

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

## Response `200`

Successful Response

- Revenue
  - `data` RevenueItem[], required
    - `date` string, required
    - `paymentMedium` string, required
    - `totalAmount` number, required
    - `transactionCount` integer, required
    - `averageTransaction` number, 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)
