Leave balances
list_leave_balancesRetrieve annual leave balances for employees in a leave year, showing allowance, carryover, booked leave, adjustments and end-of-year totals in hours or days.
Instructions
Annual leave summary for every employee for one leave year (GET /leavebookings/summary): allowance, carried over, approved booked leave, non-deductible leave, manual adjustments and end-of-year balance, in the units the account records (hours or days). leave_year is any date in the wanted leave year (the API uses the leave year that date falls in); today when omitted.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| leave_year | No | A date in the leave year, YYYY-MM-DD (defaults to today) | |
| max_results | No | Most employees to return in this call (default 100); the answer says how many were left out | |
| employee_code | No | Only this employee's row (filtered by this server; the endpoint has no employee filter) |