Leave Balances Report as Excel

Generates a Leave Balances Report as an Excel file.

Request

GET https://api.yourpayroll.co.uk/api/v2/business/{businessId}/report/leavebalances/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.asAtDate date-time
request.payRunId int32
request.groupBy string

Possible values are:

  • AccrualLocation
  • DefaultLocation
request.locationId int32
request.leaveTypeIds array of int32, multiple occurances
request.employingEntityId int32
request.hideLeaveValues boolean

Response

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

Status code Description Resource
200 OK

OK

 ByteArrayContent