List Leave Balances
list_leave_balancesRetrieve employee leave balances for entitlement, current balance, carryover, units, and accrual details. Filter by employee or policy to reduce computation time.
Instructions
Get employee leave balances per leave policy: entitlement, current balance, carryover, units and accrual details. Warning: balances are slow to compute, so always filter to the smallest dataset needed (e.g. a single employee or policy).
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_leave_balances"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| employee | No | Employee code to only return records for that particular employee | |
| location | No | One or more location names (separated by commas) to filter by | |
| position | No | One or more position names (comma separated) | |
| is_active | No | Include active employees in the results (default true) (true/false) | |
| department | No | One or more department names (separated by commas) to filter by | |
| max_records | No | Optional client-side limit on the number of records returned. Use to keep responses small when exploring data; the API itself does not paginate. | |
| is_terminated | No | Include terminated employees in the results (default true) (true/false) | |
| absence_reason | No | Leave policy name to isolate balances against that policy | |
| employment_status | No | One or more employment statuses (comma separated) |