Skip to main content
GET
/
v1
/
pvt
/
Reports
/
ListExpirePointsNotification
Returns a list of points that will expire soon and can be sent a notification to the customer warning about the expiration. The date range is based on the days before expiration configured in the BonifiQ Admin Panel
curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Reports/ListExpirePointsNotification \
  --header 'Authorization: Basic <encoded-value>'
{
  "Items": [
    {
      "Id": "<string>",
      "EventDate": "2023-11-07T05:31:56Z",
      "Points": 123,
      "Cashback": 123,
      "ExpirationDate": "2023-11-07T05:31:56Z",
      "Type": 0,
      "Customer": {
        "OriginalId": "<string>",
        "PublicId": "<string>",
        "Name": "<string>",
        "Email": "<string>",
        "Phone": "<string>",
        "BirthdayDate": "2023-11-07T05:31:56Z",
        "SignupDate": "2023-11-07T05:31:56Z",
        "Document": "<string>",
        "IsEnrolled": true,
        "ReferralURL": "<string>",
        "WhatsappReferralUrl": "<string>",
        "CurrentTier": {
          "Name": "<string>",
          "Color": "<string>",
          "IconUrl": "<string>"
        }
      },
      "NotificationDate": "2023-11-07T05:31:56Z",
      "CashbackPercent": 123,
      "TotalCashbackAvailable": 123
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true,
  "HasError": true,
  "ErrorMessages": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Query Parameters

from
string<date-time>
to
string<date-time>
pageNumber
integer<int32>
default:1
pageSize
integer<int32>
default:10

Response

200 - application/json

Base List response model methods

Items
object[] | null

Collection with the found entities on the bonifiq DB.

TotalItemCount
integer<int32>

Total of rewards Configurations founds.

PageSize
integer<int32>

Pagination size

PageNumber
integer<int32>

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