curl --request GET \
--url https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints \
--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,
"Order": {
"Id": 123,
"OriginalId": "<string>",
"OrderPlacementDate": "2023-11-07T05:31:56Z",
"OrderCompletedDate": "2023-11-07T05:31:56Z",
"OrderCancelledDate": "2023-11-07T05:31:56Z",
"OrderStatus": "<string>",
"IsCancelledOrReturned": true,
"IsCompleted": true,
"OrderTotal": 123,
"Customer": {
"Id": 123,
"OriginalId": "<string>",
"Name": "<string>",
"Email": "<string>",
"Phone": "<string>",
"BirthdayDate": "2023-11-07T05:31:56Z",
"SignupDate": "2023-11-07T05:31:56Z",
"Document": "<string>",
"IsEnrolled": true,
"PointsBalance": 123,
"BalanceOfPoints": 123,
"Cashback": 123,
"BirthdayUpdateDate": "2023-11-07T05:31:56Z",
"FirstName": "<string>",
"PublicId": "<string>",
"SecondaryId": "<string>",
"OrderCount": 123,
"ReasonEnrolled": "<string>",
"AdminId": 123,
"EmailAdmin": "<string>",
"EnrolledDate": "2023-11-07T05:31:56Z",
"TierName": "<string>",
"Origin": 0,
"RfmGroup": 0,
"RfmGroupName": "<string>",
"Affiliate": {
"Id": 123,
"CustomerId": 123,
"IsActive": true,
"AffiliateCoupon": "<string>",
"LastUpdated": "2023-11-07T05:31:56Z",
"CouponHistories": [
{
"Id": 123,
"AffiliateId": 123,
"Coupon": "<string>",
"AssociatedDate": "2023-11-07T05:31:56Z"
}
]
}
},
"Products": [
{
"OriginalId": "<string>",
"Title": "<string>",
"Url": "<string>",
"ImageUrl": "<string>",
"IsActive": true,
"ProductPrice": 123
}
],
"UpdatedDate": "2023-11-07T05:31:56Z",
"Coupon": "<string>",
"State": 0,
"Origin": 0,
"Metadatas": [
{
"Id": 123,
"OrderId": 123,
"Name": "<string>",
"Value": "<string>"
}
]
}
}
],
"TotalItemCount": 123,
"PageSize": 123,
"PageNumber": 123,
"HasNextPage": true,
"HasError": true,
"ErrorMessages": [
"<string>"
]
}curl --request GET \
--url https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints \
--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,
"Order": {
"Id": 123,
"OriginalId": "<string>",
"OrderPlacementDate": "2023-11-07T05:31:56Z",
"OrderCompletedDate": "2023-11-07T05:31:56Z",
"OrderCancelledDate": "2023-11-07T05:31:56Z",
"OrderStatus": "<string>",
"IsCancelledOrReturned": true,
"IsCompleted": true,
"OrderTotal": 123,
"Customer": {
"Id": 123,
"OriginalId": "<string>",
"Name": "<string>",
"Email": "<string>",
"Phone": "<string>",
"BirthdayDate": "2023-11-07T05:31:56Z",
"SignupDate": "2023-11-07T05:31:56Z",
"Document": "<string>",
"IsEnrolled": true,
"PointsBalance": 123,
"BalanceOfPoints": 123,
"Cashback": 123,
"BirthdayUpdateDate": "2023-11-07T05:31:56Z",
"FirstName": "<string>",
"PublicId": "<string>",
"SecondaryId": "<string>",
"OrderCount": 123,
"ReasonEnrolled": "<string>",
"AdminId": 123,
"EmailAdmin": "<string>",
"EnrolledDate": "2023-11-07T05:31:56Z",
"TierName": "<string>",
"Origin": 0,
"RfmGroup": 0,
"RfmGroupName": "<string>",
"Affiliate": {
"Id": 123,
"CustomerId": 123,
"IsActive": true,
"AffiliateCoupon": "<string>",
"LastUpdated": "2023-11-07T05:31:56Z",
"CouponHistories": [
{
"Id": 123,
"AffiliateId": 123,
"Coupon": "<string>",
"AssociatedDate": "2023-11-07T05:31:56Z"
}
]
}
},
"Products": [
{
"OriginalId": "<string>",
"Title": "<string>",
"Url": "<string>",
"ImageUrl": "<string>",
"IsActive": true,
"ProductPrice": 123
}
],
"UpdatedDate": "2023-11-07T05:31:56Z",
"Coupon": "<string>",
"State": 0,
"Origin": 0,
"Metadatas": [
{
"Id": 123,
"OrderId": 123,
"Name": "<string>",
"Value": "<string>"
}
]
}
}
],
"TotalItemCount": 123,
"PageSize": 123,
"PageNumber": 123,
"HasNextPage": true,
"HasError": true,
"ErrorMessages": [
"<string>"
]
}Use API Basic Auth Keys
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
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 Base List response model methods
Collection with the found entities on the bonifiq DB.
Show child attributes
Total of rewards Configurations founds.
Pagination size
Actual Page Number
true if there is another page to be load.
If true the request had an error.
List with the error messages
Was this page helpful?