The time off entry object

Represents a single change to a time off balance.

🚧

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": "toent_8hPq2Lm4Xk7Vn1Rt",
    "balance": "tob_3kWm9Qz5Ht2Lp8Nv",
    "employee": "emp_sx3svU6K8c5ZkSFlOh5p",
    "enrollment": "toenr_7xBn2Kp9Rt4Wm1Qz",
    "policy": "top_4fKq8Wz1mN2pR7sT",
    "hours": "4.62",
    "source": "payroll",
    "payroll": "pay_KY1Kavi5D5kKyJLsp2uO",
    "date": "2026-03-31",
    "description": null,
    "metadata": {}
}
AttributeDescription
id
string
Unique identifier for the entry.
balance
string
ID of the balance the entry changes.
employee
string
Read only. ID of the balance's employee.
enrollment
string
Read only. ID of the enrollment that produced the entry, or null for manual entries.
policy
string
Read only. ID of the policy that produced the entry, or null for manual entries.
hours
string
The change to the balance, in hours. Positive values are accrued; negative values are spent.
source
string
Read only. How the entry was created. payroll entries come from accrual or hours spent on a payroll. annual_grant entries come from the grant at the start of a policy year. expiration entries remove unused hours above max_rollover on the last day of a policy year. manual entries were created through the API.
payroll
string
Read only. ID of the payroll that created the entry, if source is payroll.
date
date
The date the entry counts for.
description
string
A description of the entry.
metadata
object
Additional loosely structured information to associate with the entry.
📘

Entries can't be edited. Reopening a payroll deletes the entries it wrote, and voiding a payroll writes offsetting entries.