KiwiSaver Report as Excel

Generates a KiwiSaver Report as an Excel file.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
request.filterType string

Possible values are:

  • DateRange
  • PayRun
  • SuperBatch
request.payScheduleId int32
request.employeeId int32
request.payRunId int32
request.fromDate date-time
request.toDate date-time
request.locationId int32
request.employingEntityId int32

Response

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

Status code Description Resource
200 OK

OK

 ByteArrayContent