List Reporting Periods - Placewise API

Request

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Store-Id

integer

required

Store id associated with given user role (e.g. Store Owner).

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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;' \
--header 'X-Store-Id;'

Responses

🟢200Success

application/json

Body

periods

array[object (RevenueReportingPeriod) {12}]

required

unit

enum<string>

required

Period unit defined in policy - week, day, moth, quarte

Allowed values:

dayweekmonthquarter

number

integer

required

Period number

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

all report filled at?

current

boolean

required

iso8601_number

string

required

number according to iso, important for week because it is calculated differently than period number

iso8601_year

integer

required

year of week according to ISO 8601

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
        }
    ]
}