# List Reporting Period Reports ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/users/me/operations/revenue_reporting/periods/{period_year}/{period_unit}/{period_number}/reports: get: summary: List Reporting Period Reports deprecated: false description: >- Returns selected period and reports within the period grouped by tax categories. tags: - API Reference/Operations API/Tenant API/Revenue Reporting parameters: - name: period_year in: path description: '' required: true example: '' schema: type: string - name: period_unit in: path description: '' required: true example: '' schema: type: string - name: period_number in: path description: '' required: true example: '' schema: type: string - 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: X-Customer in: header description: Customer for API context. [Details](doc-342139) required: false example: '{{CUSTOMER_ID}}' schema: type: string default: '{{CUSTOMER_ID}}' - 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: period: $ref: '#/components/schemas/RevenueReportingPeriod' tax_categories: type: array items: type: object properties: name: type: string reports: type: array items: properties: id: type: integer minimum: 1 nullable: true policy_id: type: integer minimum: 1 tax_category_id: type: integer minimum: 1 period_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: '' period_year: type: integer minimum: 2020 period_number: type: integer minimum: 1 day: type: string x-apidog-mock: '{{$date.anytime|format(''yyyy-MM-dd'')}}' transaction_count: type: integer minimum: 0 nullable: true value_cents: type: integer minimum: 0 value_currency: type: string description: take from settings x-apidog-mock: '{{$finance.currencyCode}}' nullable: true user_id: type: string x-apidog-mock: '{{$string.uuid}}' nullable: true member_id: type: integer minimum: 1 nullable: true deadline_at: type: string x-apidog-mock: '{{$date.isoTimestamp}}' nullable: true filled_at: type: string x-apidog-mock: '{{$date.isoTimestamp}}' nullable: true created_at: type: string x-apidog-mock: '{{$date.isoTimestamp}}' nullable: true updated_at: type: string x-apidog-mock: '{{$date.isoTimestamp}}' nullable: true x-apidog-orders: - id - policy_id - tax_category_id - period_unit - period_year - period_number - day - transaction_count - value_cents - value_currency - user_id - member_id - deadline_at - filled_at - created_at - updated_at required: - id - policy_id - tax_category_id - period_unit - period_year - period_number - day - transaction_count - value_cents - value_currency - user_id - member_id - deadline_at - filled_at - created_at - updated_at $ref: '#/components/schemas/RevenueReportingReport' x-apidog-orders: - name - reports required: - name - reports x-apidog-ignore-properties: [] x-apidog-orders: - period - tax_categories required: - period - tax_categories x-apidog-ignore-properties: [] 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' 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-3511341-run components: schemas: RevenueReportingReport: type: object properties: id: type: integer minimum: 1 nullable: true policy_id: type: integer minimum: 1 tax_category_id: type: integer minimum: 1 period_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: '' period_year: type: integer minimum: 2020 period_number: type: integer minimum: 1 day: type: string x-apidog-mock: '{{$date.anytime|format(''yyyy-MM-dd'')}}' transaction_count: type: integer minimum: 0 nullable: true value_cents: type: integer minimum: 0 value_currency: type: string description: take from settings x-apidog-mock: '{{$finance.currencyCode}}' nullable: true user_id: type: string x-apidog-mock: '{{$string.uuid}}' nullable: true member_id: type: integer minimum: 1 nullable: true deadline_at: type: string x-apidog-mock: '{{$date.isoTimestamp}}' nullable: true filled_at: type: string x-apidog-mock: '{{$date.isoTimestamp}}' nullable: true created_at: type: string x-apidog-mock: '{{$date.isoTimestamp}}' nullable: true updated_at: type: string x-apidog-mock: '{{$date.isoTimestamp}}' nullable: true x-apidog-orders: - id - policy_id - tax_category_id - period_unit - period_year - period_number - day - transaction_count - value_cents - value_currency - user_id - member_id - deadline_at - filled_at - created_at - updated_at required: - id - policy_id - tax_category_id - period_unit - period_year - period_number - day - transaction_count - value_cents - value_currency - user_id - member_id - deadline_at - filled_at - created_at - updated_at x-apidog-ignore-properties: [] x-apidog-folder: '' 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: [] ```