# List revenue

`GET /revenue`

Base URL: `https://api.viewcy.com/2025_06`

## Parameters

- `currency` (query, string, optional) (example: `usd`)
- `dimension` (query, string, optional) (example: `month`)
- `page` (query, integer, optional) (example: `1`)
- `perPage` (query, integer, optional) (example: `1`)
- `since` (query, string, optional) (example: `2025-04-01`)
- `sort` (query, string, optional) (example: `-grossSales`)
- `until` (query, string, optional) (example: `2025-04-30`)

## Responses

### 200 — Returns total revenue when dimension is omitted

- `data` (array)
  Items:
    - `object` (string)
    - `dimension` (string)
    - `dimensionId` (string)
    - `grossSales` (number)
    - `netSales` (number)
    - `onlineSales` (number)
    - `terminalSales` (number)
    - `cashSales` (number)
    - `refunds` (number)
    - `stripeFees` (number)
    - `viewcyFees` (number)
- `object` (string)
- `page` (integer)
- `totalPages` (integer)
- `perPage` (integer)
- `totalCount` (integer)
- `hasNextPage` (boolean)

### 401 — Returns 401

- `object` (string)
- `status` (integer)
- `message` (string)

---
Full OpenAPI spec: https://developer.viewcy.com/openapi/2025_06_viewcy_api.yaml

Interactive docs: https://developer.viewcy.com/api/list-revenue