Leave Balances Report as Excel

Generates a Leave Balances Report as an Excel file.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
FilterType string

Possible values are:

  • DateRange
  • PayRun
  • SuperBatch
AsAtDate date-time
PayRunId int32
GroupBy string

Possible values are:

  • AccrualLocation
  • DefaultLocation
LocationId int32
LeaveTypeIds array of int32, multiple occurances
EmployingEntityId int32
HideLeaveValues boolean

Response

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

Status code Description Resource
200 OK

OK

 ByteArrayContent