TimeOff

An entity type that represents time off taken by an employee.
Properties
Property
Type
Description
approval
﻿Enum﻿ 
Approval status, possible values:
Approved
Pending
Cancelled
Rejected
Superseded
approvalAt
﻿Timestamp﻿ 
When the time off was approved
approvalUser
﻿User﻿ 
The user who approved the time off
createAt
﻿Timestamp﻿ 
When the time off was created in the system
createUser
﻿User﻿ 
The user who created the time off
days
﻿Number﻿ 
The number of days that were requested (typically a whole number, but can be .5 for half-days)
endDate
﻿Date﻿ 
The last day of the time off
externalId
﻿String﻿ 
If the time off was imported from an external system, the unique external identifier from that system
hours
﻿Number﻿ 
The number of hours that were requested
id
﻿String﻿ 
The unique ChartHop identifier of the time off
note
﻿String﻿ 
The note attached to the time off
requestAt
﻿Timestamp﻿ 
When the time off was requested
startDate
﻿Date﻿ 
The date that the time off starts
typeDescription
﻿String﻿ 
The type of time off that was requested, for example "PTO", "Sick" or "Jury Duty"
updateAt
﻿Timestamp﻿ 
When the time off was last updated
updateUser
﻿User﻿ 
The user who updated the time off
﻿
﻿
﻿
See Also
﻿nextTimeOff﻿ 
﻿prevTimeOff﻿ 
﻿

Property	Type	Description
approval	Enum	Approval status, possible values: Approved Pending Cancelled Rejected Superseded
approvalAt	Timestamp	When the time off was approved
approvalUser	User	The user who approved the time off
createAt	Timestamp	When the time off was created in the system
createUser	User	The user who created the time off
days	Number	The number of days that were requested (typically a whole number, but can be .5 for half-days)
endDate	Date	The last day of the time off
externalId	String	If the time off was imported from an external system, the unique external identifier from that system
hours	Number	The number of hours that were requested
id	String	The unique ChartHop identifier of the time off
note	String	The note attached to the time off
requestAt	Timestamp	When the time off was requested
startDate	Date	The date that the time off starts
typeDescription	String	The type of time off that was requested, for example "PTO", "Sick" or "Jury Duty"
updateAt	Timestamp	When the time off was last updated
updateUser	User	The user who updated the time off

Updated 30 Jan 2025

Did this page help you?

Task

Timestamp