Generates a qualifying earnings report as an Excel (.xlsx) file. Supports draft and finalised pay runs via the PayRunId parameter.

Request

GET http:///api/v2/business/{businessId}/report/qualifyingearnings/xlsx

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
PayRunId int32
PayScheduleId int32
LocationId int32
EmployingEntityId int32
FromDate date-time
ToDate date-time
EmployeeIds array of int32, multiple occurances

Response

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

Status code Description Resource
200 OK

OK

ByteArrayContent