Super Contribution Report as Excel

Generates a Super Contribution Report as an Excel file.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
request.superContributionsReportExportType string

Possible values are:

  • AccrualsExcel
  • PaymentsExcel
request.filterType string

Possible values are:

  • DateRange
  • PayRun
  • SuperBatch
request.superBatchId int32
request.employeeId int32
request.contributionType string

Possible values are:

  • SuperGuarantee
  • SalarySacrifice
  • MemberVoluntary
  • EmployerContribution
  • NonRescEmployerContribution
request.groupBy string

Possible values are:

  • Employee
  • SuperFund
request.fundPerPage boolean
request.payScheduleId int32
request.includePostTaxDeductions boolean
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