Pay Run Variance Report

Generates a pay run variance report as an Excel file.

Request

GET https://api.yourpayroll.com.au/api/v2/business/{businessId}/report/payrunvariance/xlxs

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
request.payRunId1 int32
request.payRunId2 int32
request.payPeriodFrom1 date-time
request.payPeriodTo1 date-time
request.payPeriodFrom2 date-time
request.payPeriodTo2 date-time
request.comparisonType string

Possible values are:

  • PayRuns
  • PayPeriods
request.highlightVariancePercentage double
request.onlyShowVariances boolean

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 ByteArrayContent