Get a user's entitlement balances
get_user_entitlementsRetrieve entitlement balances for one user, covering holiday deductions and sickness accruals, with optional pots and contact details.
Instructions
Entitlement balances for one user. Deducting entitlements (holiday and the like, which count down: annual entitlement, transfers, pending, booked, taken, untaken, remaining, per booking period and element) and summing entitlements (sickness and the like, which count up: year to date, last 6 and 3 months, last 30 days), plus the entitlement pots they belong to. Booking period and time unit numbers are named from the documented lists (Current, MinusOne, PlusOne; Days, Minutes, Hours).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| include_pots | No | Also fetch the user's entitlement pots (one extra call) | |
| partner_user_id | Yes | The user's partner ID | |
| include_contact_details | No | Include the user's login, and stop redacting email addresses, phone numbers and UK postcodes typed into names and other text |