---
title: "Returns a list of cashback transactions filtered by redeem date."
method: GET
path: "/v1/pvt/Reports/ListCashbackReport"
tags: ["Reports"]
---

# Returns a list of cashback transactions filtered by redeem date.

`GET /v1/pvt/Reports/ListCashbackReport`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/Reports/ListCashbackReport`
- Auth: HTTP basic

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Paginated list of cashback report data

- BaseExternalApiListResponseOfReportCashbackResponse: Base List response model methods
  - `Items` object[], nullable: Collection with the found entities on the bonifiq DB.
    - `Id` integer: Cashback Id
    - `Date` string, date-time: Date when the cashback was generated
    - `CustomerId` integer: Customer Id
    - `CustomerName` string: Customer name
    - `CustomerEmail` string: Customer email
    - `Order` integer: Order Id
    - `Value` number: Cashback value in currency
    - `Coupon` string: Coupon code used
    - `OrderOriginalId` string, nullable: Original order ID from the e-commerce platform
    - `CustomerDocument` string: Customer document (CPF/CNPJ)
    - `OrderValue` number: Total value of the order
    - `BranchName` string: Branch name
    - `TenantSalesmanName` string: Salesman name
    - `OrderOrigin` 0 | 1 | 2 | 3 | 4: 0 = Integration 1 = API 2 = Import 3 = PDV 4 = OfflineIntegration
    - `OrderStatus` string: Order status description
    - `State` 0 | 1 | 2 | 3 | 4: 0 = Initial 1 = Pending 2 = Completed 3 = Cancelled 4 = Ignored
  - `TotalItemCount` integer: Total of rewards Configurations founds.
  - `PageSize` integer: Pagination size
  - `PageNumber` integer: Actual Page Number
  - `HasNextPage` boolean: true if there is another page to be load.
  - `HasError` boolean: If true the request had an error.
  - `ErrorMessages` string[]: List with the error messages

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)