---
title: "Returns the general points ledger report filtered by point event date."
method: GET
path: "/v1/pvt/Reports/ListPointsReport"
tags: ["Reports"]
---

# Returns the general points ledger report filtered by point event date.

`GET /v1/pvt/Reports/ListPointsReport`

## Request

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

Use this endpoint for reporting, BI, reconciliation, audit, customer statement, and historical export
scenarios where the integration needs all point movements in the period.
            
Unlike ListReceivedPoints, this report is not limited to earned/received points. It may include purchases,
signups, birthdays, administrative grants, reward redemptions, refunds, expirations, referrals, social
media objectives, quizzes, custom objectives, participation, fitness objectives and other point types.
            
The response includes structured Customer and Order nodes when available, plus Objective, Reward,
ExpirationDate, Cashback and CashbackPercent fields. Legacy flattened customer fields such as CustomerName,
CustomerEmail, CustomerPhone, CustomerDoc and CustomerBalance are kept for backward compatibility only;
new integrations should read customer data from the Customer node.
            
When includePurchaseDetails is true, the response includes PurchaseDetails only for purchase points
that have persisted purchase calculation details. Pagination is applied before these details are loaded,
so PurchaseDetails is resolved only for purchase points in the current page.
            
For operational flows that only need received points and notification cadence data, use ListReceivedPoints.

## Query parameters

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

## Response `200`

Paginated list of historical point movement report data.

- BaseExternalApiListResponseOfReportPointResponse: Base List response model methods
  - `Items` object[], nullable: Collection with the found entities on the bonifiq DB.
    - `Id` integer: Point Id
    - `EventDate` string, date-time: Date when the point was generated
    - `CustomerId` integer: Legacy internal customer id. Use Customer.PublicId or Customer.OriginalId instead.
    - `CustomerEmail` string: Legacy customer email. Use Customer.Email instead.
    - `CustomerPhone` string: Legacy customer phone. Use Customer.Phone instead.
    - `CustomerName` string: Legacy customer name. Use Customer.Name instead.
    - `CustomerDoc` string: Legacy customer document (CPF/CNPJ). Use Customer.Document instead.
    - `CustomerBalance` integer: Legacy customer current point balance. Use Customer.BalanceOfPoints instead.
    - `Customer` CreateCustomerResponse
      - `OriginalId` string: This is the Id in the client store.
      - `PublicId` string, nullable: Bonifiq Plubic Id
      - `Name` string: Customer name.
      - `Email` string: Customer email.
      - `Phone` string, nullable: Customer Contact Phone.
      - `BirthdayDate` string, date-time, nullable: Customer Birthdate.
      - `SignupDate` string, date-time, nullable: Date when the customer made the register on client store.
      - `Document` string, nullable: Some document number from the customer, accepts any string.
      - `IsEnrolled` boolean: If true the customer is participating on the points plan from the store.
      - `ReferralURL` string, nullable: Customer`s Referral URL. Will be null if the Referral Objective is not active.
      - `WhatsappReferralUrl` string, nullable: Customer`s Referral URL for sharing in Whatsapp. Will be null if Referral Objective is not active
      - `CurrentTier` CustomerTierResponse
        - `Name` string
        - `Color` string
        - `IconUrl` string
      - `BalanceOfPoints` integer: Customer's current points balance
      - `BalanceCashback` number, nullable: Customer's current cashback balance (calculated from points). Will be null if cashback is not enabled.
      - `Segments` object[]: Active customer segments the customer belongs to (name and tag). Inactive segments are not returned. Empty list when the customer is not in any active segment. Populated by the customer endpoints (get, list, create, update, upsert and set birthday).
        - `Name` string: Segment name, as shown in the store's admin panel.
        - `Tag` string: Segment public identifier (slug, unique per store). Use it to reference the segment in integrations.
    - `Type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19: 0 = Purchase 1 = Signup 2 = Birthday 3 = Ordinary 4 = Reward 5 = Review 6 = Refund 7 = Expire 8 = Referral 9 = SocialMediaFollowFacebook 10 = SocialMediaFollowInstagram 11 = PartialOrderRefund 12 = Quiz 13 = CustomObjective 14 = ReferralAffiliate 15 = SocialMediaFollowLinkedin 16 = SocialMediaFollowTikTok 17 = Campaign 18 = Participation 19 = Fitness
    - `Origin` 0 | 1 | 2 | 3 | 4: 0 = Integration 1 = API 2 = Import 3 = PDV 4 = OfflineIntegration
    - `Salesman` string: Salesman name
    - `Branch` string: Branch name
    - `OrderDate` string, date-time: Order date
    - `OrderOriginalId` string: Original order ID from the e-commerce platform
    - `Order` OrderCreateResponse: This class represents a request with an external Id (such as OrderId) in a third-party system
      - `Id` integer
      - `OriginalId` string: This is the Id in the third party system.
      - `OrderPlacementDate` string, date-time: Date of the customer's purchase.
      - `OrderCompletedDate` string, date-time, nullable: Date the order reached the completed state (usually it's invoiced or delivered).
      - `OrderCancelledDate` string, date-time, nullable: if the order is cancelled, contains the date.
      - `OrderStatus` string: Status at the client's order system.
      - `IsCancelledOrReturned` boolean: if true the order was cancelled or returned.
      - `IsCompleted` boolean: If true it means the order has reached its final status and points can be awarded to the consumer.
      - `OrderTotal` number: Can be used at Loyalty Programs. Important: these values should not include Shipping costs.
      - `Customer` ApiCustomer: This class represents a request with an external Id (such as OrderId) in a third-party system
        - `Id` integer
        - `OriginalId` string: This is the Id in the third party system.
        - `Name` string
        - `Email` string
        - `Locale` string, nullable
        - `Phone` string
        - `BirthdayDate` string, date-time, nullable
        - `SignupDate` string, date-time
        - `Document` string
        - `IsEnrolled` boolean
        - `PointsBalance` integer
        - `BalanceOfPoints` integer
        - `Cashback` number, nullable
        - `BirthdayUpdateDate` string, date-time, nullable
        - `FirstName` string
        - `PublicId` string, guid, nullable
        - `SecondaryId` string, nullable
        - `OrderCount` integer, nullable
        - `ReasonEnrolled` string, nullable
        - `AdminId` integer, nullable
        - `EmailAdmin` string, nullable
        - `EnrolledDate` string, date-time, nullable
        - `TierName` string
        - `Origin` 0 | 1 | 2 | 3 | 4 | 5: 0 = Platform 1 = PDV 2 = API 3 = OfflinePlatform 4 = Admin 5 = Affiliate
        - `RfmGroup` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11: 0 = CantMiss 1 = ConstantBuyers 2 = Vips 3 = AtRisk 4 = NeedAttention 5 = Promising 6 = Disconnected 7 = Hibernating 8 = Sleepy 9 = OnTheRise 10 = NewCustomers 11 = Unclassified
        - `RfmGroupName` string, nullable
        - `SegmentTags` string[], nullable: Tags dos segmentos ativos. Só vem preenchido quando a listagem pede IncludeSegments; fora disso vem vazio.
        - `Affiliate` ApiAffiliate
          - `Id` integer
          - `CustomerId` integer
          - `IsActive` boolean
          - `AffiliateCoupon` string, nullable
          - `LastUpdated` string, date-time, nullable
          - `CouponHistories` object[]
            - `Id` integer
            - `AffiliateId` integer
            - `Coupon` string
            - `AssociatedDate` string, date-time
        - `AffiliateCode` string, nullable
        - `AffiliateCodeAssignedAt` string, date-time, nullable
      - `Products` object[], nullable: Products listed on the order.
        - `OriginalId` string: Id from the client store
        - `Title` string: Product Title/Name
        - `Url` string, nullable: Url from the client store from the product.
        - `ImageUrl` string, nullable: Url from where the Product image is hosted.
        - `IsActive` boolean: If true the product is active.
        - `ProductPrice` number, nullable
      - `UpdatedDate` string, date-time: the date from the last update on this order.
      - `Coupon` string, nullable: Coupon code used on this order.
      - `State` 0 | 1 | 2 | 3 | 4: 0 = Initial 1 = Pending 2 = Completed 3 = Cancelled 4 = Ignored
      - `Origin` 0 | 1 | 2 | 3 | 4: 0 = Integration 1 = API 2 = Import 3 = PDV 4 = OfflineIntegration
      - `Branch` ApiBranch: This class represents a request with an external Id (such as OrderId) in a third-party system
        - `Id` integer
        - `OriginalId` string: This is the Id in the third party system.
        - `Name` string
      - `TenantSalesman` ApiTenantSalesman: This class represents a request with an external Id (such as OrderId) in a third-party system
        - `Id` integer
        - `OriginalId` string: This is the Id in the third party system.
        - `Name` string
        - `Store` string
        - `Branch` ApiBranch: This class represents a request with an external Id (such as OrderId) in a third-party system
          - `Id` integer
          - `OriginalId` string: This is the Id in the third party system.
          - `Name` string
        - `BranchId` integer, nullable
      - `Metadatas` object[], nullable
        - `Id` integer
        - `OrderId` integer
        - `Name` string
        - `Value` string
      - `ExternalCoupon` string, nullable: This is the "official" field for coupons from the ecomm platform - normally used for affiliate Coupon
    - `Points` integer: Number of points
    - `Cashback` number, nullable: The amount of cashback equivalent to the points. It will be null if cashback is not available.
    - `CashbackPercent` number, double, nullable: Cashback percentage configured for the tenant. It will be null if cashback is not available.
    - `ExpirationDate` string, date-time, nullable: The date when the points will expire.
    - `Reason` string: Reason for the point generation
    - `Objective` ReportAssociatedObjectiveResponse
      - `Id` integer
      - `Title` string, nullable
      - `Description` string, nullable
      - `Type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12: 0 = Purchase 1 = Signup 2 = Birthday 3 = Review 4 = Referral 5 = SocialMediaFollowInstagram 6 = SocialMediaFollowFacebook 7 = Quiz 8 = Custom 9 = SocialMediaFollowLinkedin 10 = SocialMediaFollowTikTok 11 = Participation 12 = Fitness
    - `Reward` ReportAssociatedRewardResponse
      - `Id` integer
      - `AmountOfPoints` integer
      - `Title` string, nullable
    - `PurchaseDetails` object[], nullable
      - `Type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15: 0 = Base 1 = Tier 2 = ExtraPointsSchedule 3 = ExtraPointsPerProduct 4 = MaxPointsPerPurchase 5 = GambiarraPointsPerPaymentMethod 6 = ExtraPointsPerPaymentMethod 7 = ExtraPointsPerProductBrand 8 = ExtraPointsProductCategory 9 = ExtraPointsPerTradePolicy 10 = ExtraPointsPerBranch 11 = ForceZeroPoints 12 = ExtraPointsPerPurchaseAmount 13 = IgnoredProductsZeroPoints 14 = MaxCashbackPercentagePerPurchase 15 = AdvancedRule
      - `TypeDescription` string, nullable
      - `SingleMessage` string, nullable
      - `ScheduleIds` integer[], nullable
    - `PointAction` 0 | 1: 0 = Take 1 = Grant
  - `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

## Changes

- **2026-10-29** `58b5cd54c79b`: 1 warning
  - added the new `11.00` enum value to the `Items/items/oneOf[#/components/schemas/ReportPointResponse]/Order/oneOf[#/components/schemas/OrderCreateResponse]/allOf[subschema #2]/Customer/oneOf[#/components/schemas/ApiCustomer]/allOf[subschema #2]/RfmGroup/oneOf[#/components/schemas/MatrizRFMItem]/` response property for the response status `200`
- **2026-09-22** `92d04295402d`: 1 info
  - added the optional property `Items/items/oneOf[#/components/schemas/ReportPointResponse]/Order/oneOf[#/components/schemas/OrderCreateResponse]/allOf[subschema #2]/Customer/oneOf[#/components/schemas/ApiCustomer]/allOf[subschema #2]/SegmentTags` to the response with the `200` status
- **2026-09-18** `c5e8aa0a8d9b`: 1 info
  - added the optional property `Items/items/oneOf[#/components/schemas/ReportPointResponse]/Order/oneOf[#/components/schemas/OrderCreateResponse]/allOf[subschema #2]/Customer/oneOf[#/components/schemas/ApiCustomer]/allOf[subschema #2]/Locale` to the response with the `200` status
- **2026-09-02** `ab5bc0ffd114`: 1 info
  - added the optional property `Items/items/oneOf[#/components/schemas/ReportPointResponse]/Customer/oneOf[#/components/schemas/CreateCustomerResponse]/Segments` to the response with the `200` status
- **2026-09-01** `4ae776963df8`: 1 info
  - added the optional property `Items/items/oneOf[#/components/schemas/ReportPointResponse]/PointAction` to the response with the `200` status

[Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/Reports/ListPointsReport/get.md)

---

[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)