Variance Report

Get

/employers/{employerId}/reports/{taxYear}/{payPeriod}/variance

Returns a report comparing two pay periods or two ranges of pay periods.

Deprecation notice: Accept: application/pdf returns a PDF link and is deprecated. Use Accept: application/octet-stream to retrieve PDF bytes through the authenticated API. The end-of-life date for PDF-link responses is 1st February 2027. Legacy PDF-link responses include Deprecation (RFC 9745 date @<unix-seconds>), Sunset, Warning, and optional Link headers.

Store values

Parameters

employerId string

payPeriod string

taxYear string

ordinal integer

(optional)

fromPeriod integer

(optional)

toPeriod integer

(optional)

payPeriodCompare string

(optional)

ordinalCompare integer

(optional)

taxYearCompare string

(optional)

fromPeriodCompare integer

(optional)

toPeriodCompare integer

(optional)

showPercentage

boolean

If true then any variations will be shown as a percentage. (optional)

minChange number

Set a threshold for reporting variance. Ie, provide 0.10 and any variance below 10% will be ignored (optional)

Try it Accept:

Deprecated: application/pdf returns a PDF link. Use application/octet-stream to retrieve PDF bytes through the authenticated API. The end-of-life date for PDF-link responses is 1st February 2027.

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

200	Success	`VarianceReportReportResponse`	application/json