Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Time off balance

Get the balance for a given employee

Retrieve the balance for a given employee, for a given policy type, as of a given date.<br /> <br /> Permissions required: Please refer to the main <a href="https://apidocs.hibob.com/reference/time-off#required-permissions">Time off API Required Permissions</a> page.

get/timeoff/employees/{id}/balance

Path parameters

idstring required

The Employee ID as pulled from the database, or from the URL In Bob when viewing the employee. For example, if the URL in Bob is "https://app.hibob.com/employee-profile/3332883884017713238" you should copy the "3332883884017713238".

Query parameters

policyTypestring required

Policy type name.

datestring date required

Point in time.

Response

Balance result.

employeeIdstring

Employee ID.

totalBalanceAsOfDatenumber

The retrieved balance as of this date.

totalRoundedBalanceAsOfDatenumber

The retrieved rounded balance as of this date.

pointInTimestring date

The balance date.

startingBalancenumber

The balance as of the cycle start date.

startingBalanceAsOfstring date

The cycle start date.

totalTakennumber

Total number of days/hours taken.

totalAdminAdjustmentsnumber

Total number of days/hours manually adjusted.

totalSystemAdjustmentsnumber

Total number of days/hours adjusted.

annualAllowancenumber

Annual allowance.

policystring

Policy name.

currentAssignment'Assigned' | 'Unassigned'

This field indicates whether the employee is actively assigned to the policy type on the date the balance is requested. Unassigned means the employee is not actively assigned to the policy type on the requested date. Balance values may still reflect amounts accrued while the employee was previously assigned.