Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic APIManagement APIUsers APIOperations API
Messaging APIReporting APIML APIData API
ExplorePublic APIManagement APIUsers APIOperations API
Messaging APIReporting APIML APIData API
  1. Revenue Reporting
  • Introduction
  • Manager API
    • Introduction
    • Settings
      • Introduction
      • Show Operations Settings
      • Update Settings
    • ABM Links
      • List ABM Links
      • Show Unassigned ABM Links Count
      • Import ABM Links
    • Members
      • Show Contact
      • Delete Contact
      • Update Contact
    • Issues
      • Introduction
      • Reopen Issue
      • List Issue Types
      • List Issues
      • Show Issue
      • Accept Issue
      • Resolve Issue
    • Articles
      • Introduction
      • List Articles
      • Show Article
      • Create Article
      • Update Article
      • Destroy Article
    • Articles Categories
      • Introduction
      • List Categories
      • Show Category
      • Create Category
      • Update Category
      • Destroy Category
      • List Categories with Articles
    • Documents
      • Introduction
      • List Documents
      • Show Document
      • List Document Recipients
      • Create Document
      • Update Document
      • Add Recipients to the Document
      • Destroy Document
    • Resource Types
      • Introduction
      • Show Resource Type Schema
      • Update Resource Type Schema
    • Resources
      • Introduction
      • Delete Resource
      • List Resources
      • Show Resource
      • Accept Resource
      • Reject Resource
      • Create a Resource Reminder
    • Revenue Reporting
      • Introduction
      • List Store Tax Categories
      • Bulk Update Store Tax Categories
      • List Aggregated Reports
      • List Aggregated Reports As Csv
      • Show Policy
      • Update Policy
      • List Tax Categories
      • Bulk Update Tax Categories
      • Download revenue reports import template
      • Import revenue reports from file
    • Alerts
      • Introduction
      • Recall Alert
      • Deactivate Alert
      • List Alerts
      • Show Alert
      • List Alert Recipients
      • Create Alert
      • Accept Alert
      • Reject Alert
    • Alert Templates
      • Introduction
      • List Alert Templates
      • Show Alert Template
      • Create Alert Template
      • Update Alert Template
      • Destroy Alert Template
    • Footfall Reporting
      • List Footfall Reports
      • Bulk Update Reports
  • Tenant API
    • Introduction
    • Documents
      • Introduction
      • List Documents
      • Show Document
      • Confirm Document
    • Resource Types
      • Show Resource Type Schema
    • Resources
      • Introduction
      • List Resources
      • List Deleted Resources
      • Show Resource
      • Create Resource
      • Update Resource
      • Destroy Resource
      • Resubmit Resource
      • Restore Resource
    • Alerts
      • Introduction
      • List Alert Types
      • List Alerts
      • Show Alert
      • Create Alert
      • Report to Alert
    • Alert Templates
      • List Alert Templates
    • Push App Tokens
      • Introduction
      • Add App Tokens
    • Revenue Reporting
      • List Reporting Periods
        GET
      • List Reporting Period Reports
        GET
      • Bulk Update Reports
        PUT
      • List Tax Categories
        GET
      • List Store Tax Categories
        GET
      • Bulk Update
        PUT
    • ABM Links
      • Assign ABM Link
      • Send ABM Link
    • Issues
      • Introduction
      • List Issues
      • Show Issue
      • Create Issue
      • Update Issues
      • Destroy Issue
    • Articles
      • Introduction
      • List Articles
      • Show Article
      • List Categories with Articles
  1. Revenue Reporting

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
Returns selected period and reports within the period grouped by tax categories.

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C#
Ruby
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: Bearer ' \
--header 'X-Store-Id: '

Responses

🟢200Success
application/json
Body

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"
                }
            ]
        }
    ]
}
Previous
List Reporting Periods
Next
Bulk Update Reports
Built with