DEdeputy
Pay Comparison

Submit a Pay Comparison report

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.

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

Request body

namestring

A user-defined name for the report.

creatorEmailstring

The email address of the report creator. This email address will receive an email notification when the report has completed.

startstring

yyyy-mm-dd start date of the report time period.

endstring

yyyy-mm-dd end date of the report time period.

comparisonContractIdinteger

ID of the EmploymentContract to use for comparison. Set this to empty string if using awardOverride.

awardOverridestring

Name of the award to use for comparison, e.g. au/casual-2022-01-01-teachersa-earlychildhood-1

awardBaseRateOverridenumber float

The base hourly rate to use for comparison with an award.

outerLimitOvertimenumber float

Outer limit value for overtime pay, in hours. Optional, default 0.

outerLimitPenaltynumber float

Outer limit value for penalty pay, in hours. Optional, default 0.

includeOuterLimitOvertimeboolean

Whether outer limit should be used for overtime. Optional, default false.

includeOuterLimitPenaltyboolean

Whether outer limit should be used for penalty. Optional, default false.

Response

A successful response.

errorstring

Changes

No recorded changes to this operation across all 1 revision of this API.