---
title: "/bonus/overview"
method: GET
path: "/bonus/overview"
---

# /bonus/overview

`GET /bonus/overview`

Visão geral dos bônus gerados

## Path parameters

- `generated_between` string, required

## Headers

- `Token` string, required
- `Authorization` string, required

## Response `200`

200

- object
  - `users` object[]
    - `name` string
    - `phone` string
    - `document_number` string
    - `document_type` string
    - `orders` object[]
      - `sequence` integer
      - `is_ecommerce` boolean
      - `bonus_generated_origin` string
      - `generation_store` object
        - `name` string
        - `token` string
        - `internal_code` string
      - `bonus_generated_id` integer
      - `bonus_generated_value` integer
      - `order_value` number
      - `invoice` string
      - `ticket` string
      - `generated_in` string
      - `expiry_date` object
        - `start` string
        - `end` string
      - `redeem` object
        - `date` string
        - `redemption_store` object
          - `name` string
          - `token` string
          - `internal_code` string
        - `redeemed_bonus_origin` unknown
        - `redeemed_value` integer
        - `lost_bonus_value` integer
      - `reactivation` object
        - `date` unknown
        - `reactivated` boolean
      - `final_balance` integer
  - `paginacao` object
    - `total` integer
    - `per_page` integer
    - `currentPage` integer
    - `pages` integer

---

[API](https://skmtc.net/crmbonus/apis/bi-crmb-nus.md) · [All operations](https://skmtc.net/crmbonus/apis/bi-crmb-nus/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crmbonus/bi-crmb-nus/versions/7f3ebb042f1a/schema)