- Overview
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Member
- Offers
- Rewards
- Games
- CMS Content
- Management API
- Introduction
- Core
- Applications
- Branding
- Privacy Policy
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- SMS Sender Identities
- Member Authentication Configuration
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Messages
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Venue Info
- Pages
- Website
- Landing Pages
- Articles
- Events
- Job Postings
- Press Releases
- Tags
- Attachments
- Service Messages
- Mixed Content
- Redirections
- Events
- Games
- Scraper
- Files
- Receipts
- Users API
- Operations API
- Introduction
- Manager API
- Tenant API
- Introduction
- Documents
- Resource Types
- Resources
- Alerts
- Alert Templates
- Push App Tokens
- Revenue Reporting
- ABM Links
- Issues
- Articles
- Messaging API
- Data API
- ML API
- Introduction
- Predict Sending KPI v1
- Explain Sending KPI Prediction v1
- Predict Sending KPI In Date Range v1
- Predict Sending Popularity v2
- Predict Sending Text Popularity v2
- Predict Sending Time Series Popularity v2
- Explain Sending Popularity Prediction v2
- Explain Sending Text Popularity Prediction v2
- Explain Sending Time Series Popularity Prediction v2
- Recommend sending time v2
- Detect Receipt Fraud
- Generate Image
- Generate Text
- Generate Sending Text
- (Draft) Reporting API
- Other
List Reporting Period Reports
GET
https://api.mpc.dev.placewise.com/v1/users/me/operations/revenue_reporting/periods/{period_year}/{period_unit}/{period_number}/reports
API Permit:Operations:Api:Users:RevenueReports:List
API Context:Loyalty Club
Authorizations:User
Request
Path Params
period_year
stringÂ
required
period_unit
stringÂ
required
period_number
stringÂ
required
Header Params
X-Loyalty-Club-Slug
stringÂ
required
Default:
{{LOYALTY_CLUB_SLUG}}
X-Store-Id
integerÂ
required
Default:
{{STORE_ID}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/users/me/operations/revenue_reporting/periods////reports' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Store-Id;'
Responses
🟢200Success
application/json
Body
period
object (RevenuReportingPeriod)Â
required
unit
enum<string>Â
required
Allowed values:
dayweekmonthquarter
number
integerÂ
required
year
integerÂ
required
name
stringÂ
required
policy_id
integerÂ
required
starts_at
stringÂ
required
ends_at
stringÂ
required
deadline_at
stringÂ
required
completed
booleanÂ
required
current
booleanÂ
required
iso8601_number
stringÂ
required
tax_categories
array [object {2}]Â
required
name
stringÂ
required
reports
array[object (RevenuReportingReport) {16}]Â
required
Example
{
"period": {
"unit": "week",
"number": 42,
"year": 2025,
"name": "Harriet Heathcote-Witting",
"policy_id": -55545802,
"starts_at": "2025-06-03T08:47:42.454Z",
"ends_at": "2025-06-03T08:47:42.454Z",
"deadline_at": "2025-06-03T08:47:42.455Z",
"completed": false,
"current": false,
"iso8601_number": "42"
},
"tax_categories": [
{
"name": "22 %",
"reports": [
{
"id": 76918472,
"policy_id": 78107961,
"tax_category_id": 451776,
"period_unit": "month",
"period_year": 22671531,
"period_number": 16752326,
"day": "2025-04-24",
"transaction_count": null,
"value_cents": 69559959,
"value_currency": "AMD",
"user_id": "812aa289-749a-49d9-9f81-53af3698491a",
"member_id": 76244962,
"deadline_at": "2025-06-03T08:47:42.461Z",
"filled_at": "2025-06-03T08:47:42.461Z",
"created_at": "2025-06-03T08:47:42.461Z",
"updated_at": "2025-06-03T08:47:42.461Z"
},
{
"id": 91173669,
"policy_id": 19072081,
"tax_category_id": 97452590,
"period_unit": "quarter",
"period_year": 60663905,
"period_number": 39208474,
"day": "2026-01-04",
"transaction_count": null,
"value_cents": 94623210,
"value_currency": "BHD",
"user_id": "e03ff97b-3a3e-4981-8527-7ae90f398178",
"member_id": 9053454,
"deadline_at": "2025-06-03T08:47:42.463Z",
"filled_at": "2025-06-03T08:47:42.464Z",
"created_at": "2025-06-03T08:47:42.464Z",
"updated_at": "2025-06-03T08:47:42.465Z"
},
{
"id": 82305573,
"policy_id": 72827937,
"tax_category_id": 63530877,
"period_unit": "quarter",
"period_year": 40077396,
"period_number": 6524619,
"day": "2025-10-07",
"transaction_count": null,
"value_cents": 95075817,
"value_currency": "OMR",
"user_id": "b764aece-f9df-47f7-b928-17e04d207662",
"member_id": null,
"deadline_at": "2025-06-03T08:47:42.467Z",
"filled_at": "2025-06-03T08:47:42.467Z",
"created_at": "2025-06-03T08:47:42.467Z",
"updated_at": "2025-06-03T08:47:42.467Z"
}
]
},
{
"name": "5 %",
"reports": [
{
"id": null,
"policy_id": 89127842,
"tax_category_id": 52788641,
"period_unit": "week",
"period_year": 99918251,
"period_number": 89319723,
"day": "2025-08-08",
"transaction_count": null,
"value_cents": 19106752,
"value_currency": "CVE",
"user_id": "4b73637a-3b69-46bb-8437-3287c174398a",
"member_id": null,
"deadline_at": "2025-06-03T08:47:42.469Z",
"filled_at": "2025-06-03T08:47:42.470Z",
"created_at": "2025-06-03T08:47:42.470Z",
"updated_at": "2025-06-03T08:47:42.470Z"
}
]
},
{
"name": "Johnathan Leffler",
"reports": [
{
"id": 62078294,
"policy_id": 24196330,
"tax_category_id": 35212246,
"period_unit": "quarter",
"period_year": 27881744,
"period_number": 60994589,
"day": "2026-05-30",
"transaction_count": 55866970,
"value_cents": 72194003,
"value_currency": "BBD",
"user_id": "eed2dd2f-1403-4178-b8f8-00bf7616784d",
"member_id": 38442212,
"deadline_at": "2025-06-03T08:47:42.473Z",
"filled_at": "2025-06-03T08:47:42.473Z",
"created_at": "2025-06-03T08:47:42.473Z",
"updated_at": "2025-06-03T08:47:42.473Z"
}
]
}
]
}