Detailed Activity Report

Generates a xlsx file fordetailed activity report.

Request

GET https://api.nzpayroll.co.nz/api/v2/business/{businessId}/report/detailedactivity/xlsx

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
request.fromDate date-time
request.toDate date-time
request.groupBy string

Possible values are:

  • EarningsLocation
  • RollUpLocation
  • DefaultLocation
request.filterType string

Possible values are:

  • DateRange
  • PayRun
  • SuperBatch
request.payRunId int32
request.payScheduleId int32
request.locationsIds array of int32, multiple occurances
request.employeeIds array of int32, multiple occurances
request.includePostTaxDeductions boolean
request.showLocationTotalsOnly boolean
request.includeEmployeePayRunBreakdown boolean

Response

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

Status code Description Resource
200 OK

OK

 ByteArrayContent