CHcheckhq

Get a time off entry

Changed on

Returns the specified time off entry.

get/time-off/entries/{entry}

Request

Path parameters

entrystring required

ID of the entry.

Response

200

idstring

Unique identifier for the entry.

assignmentstring

ID of the assignment whose balance the entry changes.

policystring

ID of the assignment's policy.

policy_namestring

Name of the assignment's policy.

employeestring

ID of the assignment's employee.

hoursstring decimal

The change to the balance, in hours. Positive values are accrued; negative values are spent.

source'payroll' | 'annual_grant' | 'expiration' | 'manual'

How the entry was created. payroll entries come from accrual or hours spent on a payroll; annual_grant entries from the lump sum granted at the start of a policy year; expiration entries from unused hours above max_rollover expiring at the end of a policy year; and manual entries were created through the API.

payrollstring nullable

ID of the payroll that created the entry, if source is payroll.

created_atstring date-time

When the entry was created.

metadataobject

Additional loosely structured information to associate with the object.

Example response

{
  "id": "toe_8hPq2Lm4Xk7Vn1Rt",
  "assignment": "toa_3kWm9Qz5Ht2Lp8Nv",
  "policy": "top_4fKq8Wz1mN2pR7sT",
  "policy_name": "California Paid Sick Leave",
  "employee": "emp_sx3svU6K8c5ZkSFlOh5p",
  "hours": "5.16",
  "source": "payroll",
  "payroll": "pay_KY1Kavi5D5kKyJLsp2uO",
  "created_at": "2026-03-31T00:00:00Z"
}

Changes