---
title: "Returns earned points that can be used to track received-point events and customer notification flows."
method: GET
path: "/v1/pvt/Reports/ListReceivedPoints"
tags: ["Reports"]
---

# Returns earned points that can be used to track received-point events and customer notification flows.

`GET /v1/pvt/Reports/ListReceivedPoints`

Use this endpoint when the integration needs the list of points received by customers in a period,
especially for "points available" communication and notification use cases.
            
This endpoint returns earned/received point entries only and depends on the tenant's points-available
notification configuration. If that notification feature is disabled, the response is an empty list.
            
The result includes the structured Customer node, the associated Order when the point was generated
from a purchase, the associated Objective when available, expiration/cashback information, and the
notification date calculated from the notification cadence.
            
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 a complete historical report of all point movements, including rewards, expirations, refunds and
other non-earned point types, use ListPointsReport instead.

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `PointTypes` integer[], nullable
- `pageNumber` integer
- `pageSize` integer
- `includePurchaseDetails` boolean

## Response `200`

Paginated list of received point entries for customer notification/integration workflows.

- BaseExternalApiListResponseOfReportPointWithOrderResponse — Base List response model methods
  - `Items` object[], nullable — Collection with the found entities on the bonifiq DB.
    - `Id` string — Point unique Id
    - `EventDate` string, date-time — The date the customer earned the points
    - `Points` integer — How many points are going to expire
    - `Cashback` number, nullable — The amount of cashback that will be expired along with the points. It will be null if the cashback is not available.
    - `ExpirationDate` string, date-time, nullable — The date when the points will expire
    - `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
    - `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.
    - `NotificationDate` string, date-time, nullable — Date when the customer will be notified about the points expiration.
    - `CashbackPercent` number, double, nullable
    - `TotalCashbackAvailable` number, nullable
    - `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
        - `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 — 0 = CantMiss 1 = ConstantBuyers 2 = Vips 3 = AtRisk 4 = NeedAttention 5 = Promising 6 = Disconnected 7 = Hibernating 8 = Sleepy 9 = OnTheRise 10 = NewCustomers
        - `RfmGroupName` string, nullable
        - `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
    - `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
    - `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
  - `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.net/bonifiq/apis/bonifiq-private-apis.md) · [All operations](https://skmtc.net/bonifiq/apis/bonifiq-private-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bonifiq/bonifiq-private-apis/revisions/fafbe5673edc/schema)