Submit a Pay Comparison report

post

https://{subdomain}.{region}.deputy.com/api/v2/pay-comparison/submit-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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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

int32

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

float

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

outerLimitOvertime

float

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

outerLimitPenalty

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

object

employeeFilter

object

Deprecated, please use employeeQuery.

employeeQuery

object

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.