Leave Liability Report

Generates a leave liability report.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
request.payScheduleId int32
request.employeeIds array of int32, multiple occurances
request.jobId uuid
request.filterType string

Possible values are:

  • DateRange
  • PayRun
  • SuperBatch
request.locationId int32
request.leaveTypeId int32
request.includeApprovedLeave boolean
request.asAtDate date-time
request.employingEntityId int32
request.payRunId int32
request.leaveTypeIds array of int32, multiple occurances
request.groupBy string

Possible values are:

  • AccrualLocation
  • DefaultLocation

Response

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

Status code Description Resource
200 OK

OK

 LeaveLiabilityExportModel