The time off balance object

Represents one bucket of an employee's time off hours, such as PTO or sick leave.

🚧

Sandbox beta only

The Time Off API is in beta and is only available in Sandbox. For more details, see Working with Time Off Policies.

{
    "id": "tob_3kWm9Qz5Ht2Lp8Nv",
    "employee": "emp_sx3svU6K8c5ZkSFlOh5p",
    "label": "PTO",
    "hours": "17.16",
    "hours_as_of": "2026-10-20T00:00:00Z",
    "metadata": {}
}
AttributeDescription
id
string
Unique identifier for the balance.
employee
string
ID of the employee the balance belongs to.
label
string
Name of the balance, such as PTO, Sick, or Parental Leave.
hours
string
Read only. The current balance, in hours. This is the sum of the balance's time off entries. New balances start at "0.00".
hours_as_of
datetime
Read only. When hours was last updated.
metadata
object
Additional loosely structured information to associate with the balance. This is the only field that can be changed after the balance is created.
📘

An employee can have any number of balances. A balance keeps its hours and history when it moves between policies, because the policy is set by its enrollments. A balance with no enrollment is a valid manual ledger.