Get a time off balance
Remaining balance of one employee for one time off type.
GET https://cotlet.dev/api/v1/personio/employees/{employee_id}/time-off-balance
read
Returns the balance Personio shows on the Time off page of the profile: entitlement, taken and remaining for the time off type. Needs permission to see that employee's time off. Use it before request_time_off to avoid a negative balance.
Parameters
| Name | Type | Description |
|---|---|---|
| employee_id string required | string | Employee ID from list_employees. |
| time_off_type string required | string | Name from list_time_off_types. |
Request
curl "https://cotlet.dev/api/v1/personio/employees/employee_8c41d2/time-off-balance?time_off_type=time+off+type" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("personio", "get_time_off_balance", {"employee_id":"employee_8c41d2","time_off_type":"time off type"})const result = await cotlet.call('personio', 'get_time_off_balance', {"employee_id":"employee_8c41d2","time_off_type":"time off type"});cotlet call personio get_time_off_balance --data '{"employee_id":"employee_8c41d2","time_off_type":"time off type"}'Example response
{
"employee_id": "emp_2041",
"time_off_type": "Vacation",
"entitled": 25,
"taken": 7,
"remaining": 18,
"unit": "days"
}