# List Reporting Periods

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/users/me/operations/revenue_reporting/periods:
    get:
      summary: List Reporting Periods
      deprecated: false
      description: >
        Returns list of reporting periods in units defined on current user and
        store
      tags:
        - API Reference/Operations API/Tenant API/Revenue Reporting
      parameters:
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: Authorization
          in: header
          description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
          required: false
          example: Bearer {{_OAUTH_TOKEN}}
          schema:
            type: string
            default: Bearer {{_OAUTH_TOKEN}}
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
        - name: X-Store-Id
          in: header
          description: 'Store id associated with given user role (e.g. Store Owner). '
          required: false
          example: '{{STORE_ID}}'
          schema:
            type: integer
            default: '{{STORE_ID}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  periods:
                    type: array
                    items:
                      properties:
                        unit:
                          type: string
                          enum:
                            - day
                            - week
                            - month
                            - quarter
                          x-apidog-enum:
                            - value: day
                              name: ''
                              description: ''
                            - value: week
                              name: ''
                              description: ''
                            - value: month
                              name: ''
                              description: ''
                            - value: quarter
                              name: ''
                              description: ''
                          description: >-
                            Period unit defined in policy - week, day, moth,
                            quarte
                        number:
                          type: integer
                          description: Period number
                        year:
                          type: integer
                        name:
                          type: string
                        policy_id:
                          type: integer
                        starts_at:
                          type: string
                          x-apidog-mock: '{{$date.isoTimestamp}}'
                        ends_at:
                          type: string
                          x-apidog-mock: '{{$date.isoTimestamp}}'
                        deadline_at:
                          type: string
                          x-apidog-mock: '{{$date.isoTimestamp}}'
                        completed:
                          type: boolean
                          description: all report filled at?
                        current:
                          type: boolean
                        iso8601_number:
                          type: string
                          x-apidog-mock: '{{$string.numeric}}'
                          description: number according to iso (weeks)
                      x-apidog-orders:
                        - unit
                        - number
                        - year
                        - name
                        - policy_id
                        - starts_at
                        - ends_at
                        - deadline_at
                        - completed
                        - current
                        - iso8601_number
                      required:
                        - unit
                        - number
                        - year
                        - name
                        - policy_id
                        - starts_at
                        - deadline_at
                        - ends_at
                        - completed
                        - current
                        - iso8601_number
                      $ref: '#/components/schemas/RevenueReportingPeriod'
                x-apidog-orders:
                  - periods
                required:
                  - periods
                x-apidog-ignore-properties: []
              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
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Operations API/Tenant API/Revenue Reporting
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511340-run
components:
  schemas:
    RevenueReportingPeriod:
      type: object
      properties:
        unit:
          type: string
          enum:
            - day
            - week
            - month
            - quarter
          x-apidog-enum:
            - value: day
              name: ''
              description: ''
            - value: week
              name: ''
              description: ''
            - value: month
              name: ''
              description: ''
            - value: quarter
              name: ''
              description: ''
          description: Period unit defined in policy - week, day, moth, quarte
        number:
          type: integer
          description: Period number
        year:
          type: integer
        name:
          type: string
        policy_id:
          type: integer
        starts_at:
          type: string
          x-apidog-mock: '{{$date.isoTimestamp}}'
        ends_at:
          type: string
          x-apidog-mock: '{{$date.isoTimestamp}}'
        deadline_at:
          type: string
          x-apidog-mock: '{{$date.isoTimestamp}}'
        completed:
          type: boolean
          description: all report filled at?
        current:
          type: boolean
        iso8601_number:
          type: string
          x-apidog-mock: '{{$string.numeric}}'
          description: >-
            number according to iso, important for week because it is calculated
            differently than period number
        iso8601_year:
          type: integer
          description: year of week according to ISO 8601
      x-apidog-orders:
        - unit
        - number
        - year
        - name
        - policy_id
        - starts_at
        - ends_at
        - deadline_at
        - completed
        - current
        - iso8601_number
        - iso8601_year
      required:
        - unit
        - number
        - year
        - name
        - policy_id
        - starts_at
        - ends_at
        - deadline_at
        - completed
        - current
        - iso8601_number
        - iso8601_year
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```