Leave Balances Report

Generates a leave balances report.

Request

GET http:///api/v2/business/{businessId}/report/leavebalances

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
PayScheduleId int32
EmployeeIds array of int32, multiple occurances
LocationId int32
LeaveTypeId int32
GroupBy string

Possible values are:

  • AccrualLocation
  • DefaultLocation
EmployingEntityId int32
AsAtDate date-time

Response

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

Status code Description Resource
200 OK

OK

 NzLeaveBalancesExportModel