---
title: "GET /api/tenants/{tenantId}/payrolls/{payrollId}/reports"
method: GET
path: "/api/tenants/{tenantId}/payrolls/{payrollId}/reports"
tags: ["Payrolls"]
---

# GET /api/tenants/{tenantId}/payrolls/{payrollId}/reports

`GET /api/tenants/{tenantId}/payrolls/{payrollId}/reports`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/docs/api/tenants/:tenantId/payrolls/:payrollId/reports/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantId` integer, required
- `payrollId` integer, required

## Query parameters

- `clusterSetName` string
- `evaluationDate` string, date-time
- `overrideType` 'Active' | 'Inactive'
- `regulationDate` string, date-time
- `reportNames` string[]
- `userType` 'Employee' | 'User' | 'TenantAdministrator' | 'SystemAdministrator'

## Response `200`

OK

- ReportSet[]
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `name` string, required
  - `nameLocalizations` object, nullable
  - `description` string, nullable
  - `descriptionLocalizations` object, nullable
  - `category` string, nullable
  - `attributeMode` 'Json' | 'Table'
  - `userType` 'Employee' | 'User' | 'TenantAdministrator' | 'SystemAdministrator'
  - `reportIsolation` 'None' | 'Global' | 'Company' | 'Division' | 'Employee'
  - `queries` object, nullable
  - `relations` DataRelation[], nullable
    - `name` string, nullable
    - `parentTable` string, nullable
    - `parentColumn` string, nullable
    - `childTable` string, nullable
    - `childColumn` string, nullable
  - `buildExpression` string, nullable
  - `startExpression` string, nullable
  - `endExpression` string, nullable
  - `overrideType` 'Active' | 'Inactive'
  - `attributes` object, nullable
  - `clusters` string[], nullable
  - `regulationId` integer
  - `parameters` ReportParameter[], nullable
    - `id` integer
    - `status` 'Active' | 'Inactive'
    - `created` string, date-time
    - `updated` string, date-time
    - `name` string, required
    - `nameLocalizations` object, nullable
    - `description` string, nullable
    - `descriptionLocalizations` object, nullable
    - `mandatory` boolean
    - `hidden` boolean
    - `value` string, nullable
    - `valueType` 'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource'
    - `parameterType` 'Value' | 'Now' | 'Today' | 'TenantId' | 'UserId' | 'EmployeeId' | 'RegulationId' | 'PayrollId' | 'PayrunId' | 'ReportId' | 'WebhookId'
    - `overrideType` 'Active' | 'Inactive'
    - `attributes` object, nullable
  - `templates` ReportTemplate[], nullable
    - `id` integer
    - `status` 'Active' | 'Inactive'
    - `created` string, date-time
    - `updated` string, date-time
    - `name` string, required
    - `culture` string, required
    - `content` string, required
    - `contentType` string, nullable
    - `schema` string, nullable
    - `resource` string, nullable
    - `overrideType` 'Active' | 'Inactive'
    - `attributes` object, nullable

## Other responses

- `404`: Not Found

## Changes

- **2026-04-01** `34e260deaa2c`: 1 info
  - added the optional property `items/reportIsolation` to the response with the `200` status
- **2025-03-12** `8f09691a3e2e`: 2 info
  - added the new optional `query` request parameter `userType`
  - added the optional property `items/userType` to the response with the `200` status
- **2023-07-23** `fd1b5146be4a`: 3 warning
  - deleted the `query` request parameter `userType`
  - removed the optional property `items/reportIsolation` from the response with the `200` status
  - removed the optional property `items/userType` from the response with the `200` status

[Operation history](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/changes/api/tenants/:tenantId/payrolls/:payrollId/reports/get.md)

---

[API](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1.md) - [All operations](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/revisions/7e8994a2c5bb?raw)