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 Periods

GET
https://api.mpc.dev.placewise.com/v1/users/me/operations/revenue_reporting/periods
API Permit:Operations:Api:Users:RevenueReports:List
API Context:Loyalty Club
Authorizations:User
Returns list of reporting periods in units defined on current user and store

Request

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' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'Authorization: Bearer ' \
--header 'X-Store-Id: '

Responses

🟢200Success
application/json
Body

Example
{
    "periods": [
        {
            "unit": "week",
            "number": 9,
            "year": 2024,
            "name": "Week 9",
            "policy_id": 81182,
            "starts_at": "2025-06-03T08:29:09.842Z",
            "ends_at": "2025-06-03T08:29:09.843Z",
            "deadline_at": "2025-06-03T08:29:09.843Z",
            "completed": true,
            "current": true,
            "iso8601_number": "9"
        },
        {
            "unit": "quarter",
            "number": 1,
            "year": 2024,
            "name": "Quarter 1",
            "policy_id": 86807,
            "starts_at": "2025-06-03T08:29:09.848Z",
            "ends_at": "2025-06-03T08:29:09.849Z",
            "deadline_at": "2025-06-03T08:29:09.849Z",
            "completed": false,
            "current": false,
            "iso8601_number": 1
        }
    ]
}
Previous
Add App Tokens
Next
List Reporting Period Reports
Built with