---
title: "Revenue by centre report"
method: GET
path: "/shop/reports/revenue-by-centre-v2"
tags: ["RevenueByCentre"]
---

# Revenue by centre report

`GET /shop/reports/revenue-by-centre-v2`

This endpoint provides a summary of revenue by reporting centre for the given parameters.

## Query parameters

- `site_id` string, uuid, required
- `revenue_date_from` string, date
- `revenue_date_to` string, date
- `labels` string[]

## Response `200`

The revenue by centre summary was successfully retrieved

- object
  - `data` RevenueByCentreSummary, required
    - `by_day` RevenueByCentreByDateStats[], required
      - `date` string, date, required — The revenue date of the item.
      - `items_paid` RevenueByCentreStats, required
        - `by_revenue_centre` SchemasRevenueCentre[], required
          - `revenue_centre_id` string, required — The ID of the revenue centre.
          - `revenue_centre_label` string, required — The name of the revenue centre.
          - `gross_revenue` integer, required — The gross revenue allocated to an individual revenue centre.
          - `net_revenue` integer, required — The net revenue allocated to an individual revenue centre.
          - `num_items` integer, required — The number of items.
        - `num_items` integer, required — The number of items.
        - `total_gross` integer, required — The gross revenue across all submitted orders.
        - `total_net` integer, required — The net revenue across all submitted orders.
        - `item_average_gross` integer, required — The average gross revenue per item.
        - `item_average_net` integer, required — The average net revenue per item.
      - `items_unpaid` RevenueByCentreStats, required
        - `by_revenue_centre` SchemasRevenueCentre[], required
          - `revenue_centre_id` string, required — The ID of the revenue centre.
          - `revenue_centre_label` string, required — The name of the revenue centre.
          - `gross_revenue` integer, required — The gross revenue allocated to an individual revenue centre.
          - `net_revenue` integer, required — The net revenue allocated to an individual revenue centre.
          - `num_items` integer, required — The number of items.
        - `num_items` integer, required — The number of items.
        - `total_gross` integer, required — The gross revenue across all submitted orders.
        - `total_net` integer, required — The net revenue across all submitted orders.
        - `item_average_gross` integer, required — The average gross revenue per item.
        - `item_average_net` integer, required — The average net revenue per item.
      - `totals` RevenueByCentreStats, required
        - `by_revenue_centre` SchemasRevenueCentre[], required
          - `revenue_centre_id` string, required — The ID of the revenue centre.
          - `revenue_centre_label` string, required — The name of the revenue centre.
          - `gross_revenue` integer, required — The gross revenue allocated to an individual revenue centre.
          - `net_revenue` integer, required — The net revenue allocated to an individual revenue centre.
          - `num_items` integer, required — The number of items.
        - `num_items` integer, required — The number of items.
        - `total_gross` integer, required — The gross revenue across all submitted orders.
        - `total_net` integer, required — The net revenue across all submitted orders.
        - `item_average_gross` integer, required — The average gross revenue per item.
        - `item_average_net` integer, required — The average net revenue per item.
    - `totals` RevenueByCentreTotalsStats, required
      - `items_paid` RevenueByCentreStats, required
        - `by_revenue_centre` SchemasRevenueCentre[], required
          - `revenue_centre_id` string, required — The ID of the revenue centre.
          - `revenue_centre_label` string, required — The name of the revenue centre.
          - `gross_revenue` integer, required — The gross revenue allocated to an individual revenue centre.
          - `net_revenue` integer, required — The net revenue allocated to an individual revenue centre.
          - `num_items` integer, required — The number of items.
        - `num_items` integer, required — The number of items.
        - `total_gross` integer, required — The gross revenue across all submitted orders.
        - `total_net` integer, required — The net revenue across all submitted orders.
        - `item_average_gross` integer, required — The average gross revenue per item.
        - `item_average_net` integer, required — The average net revenue per item.
      - `items_unpaid` RevenueByCentreStats, required
        - `by_revenue_centre` SchemasRevenueCentre[], required
          - `revenue_centre_id` string, required — The ID of the revenue centre.
          - `revenue_centre_label` string, required — The name of the revenue centre.
          - `gross_revenue` integer, required — The gross revenue allocated to an individual revenue centre.
          - `net_revenue` integer, required — The net revenue allocated to an individual revenue centre.
          - `num_items` integer, required — The number of items.
        - `num_items` integer, required — The number of items.
        - `total_gross` integer, required — The gross revenue across all submitted orders.
        - `total_net` integer, required — The net revenue across all submitted orders.
        - `item_average_gross` integer, required — The average gross revenue per item.
        - `item_average_net` integer, required — The average net revenue per item.
      - `totals` RevenueByCentreStats, required
        - `by_revenue_centre` SchemasRevenueCentre[], required
          - `revenue_centre_id` string, required — The ID of the revenue centre.
          - `revenue_centre_label` string, required — The name of the revenue centre.
          - `gross_revenue` integer, required — The gross revenue allocated to an individual revenue centre.
          - `net_revenue` integer, required — The net revenue allocated to an individual revenue centre.
          - `num_items` integer, required — The number of items.
        - `num_items` integer, required — The number of items.
        - `total_gross` integer, required — The gross revenue across all submitted orders.
        - `total_net` integer, required — The net revenue across all submitted orders.
        - `item_average_gross` integer, required — The average gross revenue per item.
        - `item_average_net` integer, required — The average net revenue per item.
  - `meta` RevenueByCentreMeta, required
    - `revenue_centres` RevenueCentreSummary[], required
      - `key` string, required — The ID of the revenue centre.
      - `name` string, required — The name of the revenue centre.

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)