---
title: "Find a list of Pay Comparison reports"
method: POST
path: "/v2/pay-comparison/get-reports"
tags: ["Pay Comparison"]
---

# Find a list of Pay Comparison reports

`POST /v2/pay-comparison/get-reports`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api`
- URL: `https://your-subdomain.deputy.deputy.com/api/v2/pay-comparison/get-reports`
- Auth: API key in header `OAuth`

Find a list of Pay Comparison reports.

## Request body

- PayComparisonReportFilter
  - `limit` integer: The maximum number of results to return.
  - `offset` integer: The first N results will be excluded.
  - `nameContains` string: Filter for reports where the `name` contains a substring. Leave as empty string to match all reports.
  - `createdAfter` string: `yyyy-mm-dd` date to return only reports created on or after.
  - `createdBefore` string: `yyyy-mm-dd` date to return only reports created before.

## Response `200`

A successful response.

- PayComparisonGetReportResponse
  - `reports` PayComparisonReport[]
    - `name` string
    - `reportId` string
    - `creatorEmail` string
    - `status` 'NO_STATUS' | 'PENDING' | 'DONE' | 'FAILED' | 'CANCELLED'
    - `start` string
    - `end` string
    - `employeeFilter` PayComparisonEmployeeFilter
      - `limit` integer: Limit the result set returned after applying filters.
      - `offset` integer: Offset (from the first result) the result set returned after applying filters.
      - `contractIds` integer[]: Filter the employees based on main contract.
    - `expectedResultCount` integer: Count of the results which are required to be in the `DONE` status in order for the report to finish.
    - `employeeIds` integer[]
    - `awardOverride` string
    - `baseRateOverride` number, float
    - `comparisonContractId` integer
    - `created` string
    - `doneResultCount` integer: Count of the results for the report which have the `DONE` status.
    - `outerLimitOvertime` number, float
    - `outerLimitPenalty` number, float
    - `includeOuterLimitOvertime` boolean
    - `includeOuterLimitPenalty` boolean
    - `workPeriodCycle` PayComparisonReportWorkPeriodCycle
      - `cycleStart` string: `yyyy-mm-dd` date to specify the start of the cycle.
      - `daysInCycle` integer: Number of days in each cycle, e.g. Weekly = 7, Fortnightly = 14, 4-Weekly = 28.
    - `employeeQuery` PayComparisonEmployeeQuery
      - `limit` integer: Limit the result set returned after applying filters.
      - `offset` integer: Offset (from the first result) the result set returned after applying filters.
      - `filter` PayComparisonEmployeeQueryFilter
        - `contractIds` integer[]: Used to match employees by their contract linked by the agreement on their main location.
        - `includeEmployeeIds` integer[]: Employees with IDs matching this field will be added to the set of results, if they are not matched already.
        - `includeCompanyIds` integer[]: Employees that are associated with the Company matching any of the IDs will be added to the set of results.
        - `includeTrainingModuleIds` integer[]: Employees that have any of the matching TrainingModule IDs.
        - `includeJobPositions` string[]: Employees based on the given Job Positions. (Will be set to empty if install is not Enterprise).
        - `includeEmployeesWithNameLike` string: Employees will be added to the results if they have Name matching this value. `%` can be used as a wildcard.
  - `totalCount` integer

---

[API](https://skmtc.dev/deputy/apis/deputy-v2-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v2-api/revisions/78f0278f4608?raw)