---
title: "Get Payment Overview"
method: GET
path: "/billing/dashboard/overview"
tags: ["provider", "billing", "dashboard"]
---

# Get Payment Overview

`GET /billing/dashboard/overview`

Get an overview of payments including total revenue from POS, top-selling items, and top customers by spending.

## 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

- PaymentOverview
  - `totalRevenueFromPos` number, required
  - `topSellingItems` TopSellingItemOverview[], required
    - `id` string, required
    - `name` string, required
    - `totalQuantity` integer, required
    - `totalRevenue` number, required
  - `topCustomers` TopCustomerOverview[], required
    - `id` string, required
    - `name` string, required
    - `totalSpend` number, required
    - `transactionCount` integer, required
  - `period` Period, required
    - `startDate` string, required
    - `endDate` string, required
  - `todayChange` 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-service-production.skmtc.workers.dev/v1/apis/decodahealth/decoda-api/revisions/4939a65a89d2/schema)