---
title: "Submit a Pay Comparison report"
method: POST
path: "/v2/pay-comparison/submit-report"
tags: ["Pay Comparison"]
---

# Submit a Pay Comparison report

`POST /v2/pay-comparison/submit-report`

## Request

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

Use this endpoint to submit a new pay comparison report. Note that you may specify `comparisonContractId` or `awardOverride` but not both. If specifying `awardOverride`, you must also specify `baseRateOverride`. `baseRateOverride` must not be specified with `comparisonContractId`.

## Request body

- PayComparisonSubmitReportRequest
  - `name` string: A user-defined name for the report.
  - `creatorEmail` string: The email address of the report creator. This email address will receive an email notification when the report has completed.
  - `start` string: `yyyy-mm-dd` start date of the report time period.
  - `end` string: `yyyy-mm-dd` end date of the report time period.
  - `comparisonContractId` integer: ID of the EmploymentContract to use for comparison. Set this to empty string if using awardOverride.
  - `awardOverride` string: Name of the award to use for comparison, e.g. `au/casual-2022-01-01-teachersa-earlychildhood-1`
  - `awardBaseRateOverride` number, float: The base hourly rate to use for comparison with an award.
  - `outerLimitOvertime` number, float: Outer limit value for overtime pay, in hours. Optional, default 0.
  - `outerLimitPenalty` number, float: Outer limit value for penalty pay, in hours. Optional, default 0.
  - `includeOuterLimitOvertime` boolean: Whether outer limit should be used for overtime. Optional, default false.
  - `includeOuterLimitPenalty` boolean: Whether outer limit should be used for penalty. Optional, default false.
  - `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.
  - `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.
  - `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.

## Response `200`

A successful response.

- PayComparisonSubmitReportResponse
  - `report` 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.
  - `error` string

---

[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)