v7

latestOpenAPI 3.0.02026-08-08811,0051.1 MB
Reports

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

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.

get/v1/pvt/Reports/ListPointsReport

Query parameters

fromstring date-time

Start date for filtering points by event date.

tostring date-time

End date for filtering points by event date. When omitted or default, DateTime.UtcNow is used.

pageNumberinteger

Page number for pagination (default: 1).

pageSizeinteger

Number of items per page (default: 10, max: 10000).

includePurchaseDetailsboolean

When true, includes purchase point calculation details for purchase points in the returned page when available. Default is false for backward compatibility.

Response

Paginated list of historical point movement report data.

TotalItemCountinteger

Total of rewards Configurations founds.

PageSizeinteger

Pagination size

PageNumberinteger

Actual Page Number

HasNextPageboolean

true if there is another page to be load.

HasErrorboolean

If true the request had an error.

ErrorMessagesstring[]

List with the error messages