Leave Balances Report

Generates a leave balances report.

Request

GET https://api.yourpayroll.co.uk/api/v2/business/{businessId}/report/leavebalances

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
request.locationId int32
request.leaveTypeId int32
request.groupBy string

Possible values are:

  • AccrualLocation
  • DefaultLocation
request.employingEntityId int32
request.asAtDate date-time

Response

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

Status code Description Resource
200 OK

OK

 UkLeaveBalancesExportModel