The time off enrollment object

Represents a time off balance being governed by a policy over a date range.

🚧

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": "toenr_7xBn2Kp9Rt4Wm1Qz",
    "balance": "tob_3kWm9Qz5Ht2Lp8Nv",
    "employee": "emp_sx3svU6K8c5ZkSFlOh5p",
    "policy": "top_4fKq8Wz1mN2pR7sT",
    "effective_start": "2026-03-12",
    "effective_end": null,
    "metadata": {}
}
AttributeDescription
id
string
Unique identifier for the enrollment.
balance
string
ID of the balance the policy applies to.
employee
string
Read only. ID of the balance's employee.
policy
string
ID of the policy that governs the balance.
effective_start
date
The first date the policy applies to the balance. Can't be changed after the enrollment is created.
effective_end
date
The last date the policy applies to the balance, or null for an open-ended enrollment. This is the only field that can be changed after the enrollment is created. Ending an enrollment retroactively doesn't recalculate past entries.
metadata
object
Additional loosely structured information to associate with the enrollment.
📘

Enrollments on the same balance can't overlap. To change a balance's policy, set effective_end on the current enrollment, then create a new enrollment starting the next day.