List time off balances
kiwihr_list_time_off_balancesTime off balances of all employees: per employee and time off rule the allowance, accrued, used, requested, planned and available days, carry-over and the accrual/usage periods. Filter by time off type, active state and usage period. The API has no per-employee filter or paging for this query; read the result per user. GraphQL query timeOffBalances.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort_by | No | ||
| is_active | No | true = active balances only. | |
| sort_direction | No | Sort direction (default ASC). | |
| time_off_type_id | No | Only this time off type (from kiwihr_list_time_off_types). | |
| usage_period_end_to | No | Usage period ends on or before this date. | |
| usage_period_start_from | No | Usage period starts on or after this date. |