---
title: TimeOff
slug: timeoff
docTags: 
createdAt: 2021-09-14T20:22:09.000Z
---

An entity type that represents time off taken by an employee.

### Properties

| **Property**      | **Type**                                       | **Description**                                                                                       |
| ----------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `approval`        | [Enum](docId\:UnTq2eAL5RMIpNYczvfw1)           | Approval status, possible values:<br />* Approved
* Pending
* Cancelled
* Rejected
* Superseded       |
| `approvalAt`      | [Timestamp](docId\:j1uFZtC3_yprDI3uCIn3u)      | When the time off was approved                                                                        |
| `approvalUser`    | [User](docId:6hG3wvt0l2N5eByFDU_TC)            | The user who approved the time off                                                                    |
| `createAt`        | [Timestamp](docId\:j1uFZtC3_yprDI3uCIn3u)      | When the time off was created in the system                                                           |
| `createUser`      | [User](docId:6hG3wvt0l2N5eByFDU_TC)            | The user who created the time off                                                                     |
| `days`            | [Number](docId\:ucI5tCTfVBhonEJ6ZQijg)         | The number of days that were requested (typically a whole number, but can be `.5` for half-days)      |
| `endDate`         | [Date](docId\:xTAQdzvLBTAKjxRnpFwe9)           | The last day of the time off                                                                          |
| `externalId`      | [String](docId\:Ujw2AQAktel5uukLuP73S)         | If the time off was imported from an external system, the unique external identifier from that system |
| `hours`           | [Number](docId\:ucI5tCTfVBhonEJ6ZQijg)         | The number of hours that were requested                                                               |
| `id`              | [String](docId\:Ujw2AQAktel5uukLuP73S)         | The unique ChartHop identifier of the time off                                                        |
| `note`            | [String](docId\:Ujw2AQAktel5uukLuP73S)         | The note attached to the time off                                                                     |
| `policy`          | [TimeOffPolicy](docId\:NSPh0ILH9hMeU44mkvQ3J)  | The policy that was used for this time off                                                            |
| `requestAt`       | [Timestamp](docId\:j1uFZtC3_yprDI3uCIn3u)      | When the time off was requested                                                                       |
| `startDate`       | [Date](docId\:xTAQdzvLBTAKjxRnpFwe9)           | The date that the time off starts                                                                     |
| `typeDescription` | [String](docId\:Ujw2AQAktel5uukLuP73S)         | The type of time off that was requested, for example "PTO", "Sick" or "Jury Duty"                     |
| `updateAt`        | [Timestamp](docId\:j1uFZtC3_yprDI3uCIn3u)      | When the time off was last updated                                                                    |
| `updateUser`      | [User](docId:6hG3wvt0l2N5eByFDU_TC)            | The user who updated the time off                                                                     |
|                   |                                                |                                                                                                       |

### See Also

- [nextTimeOff](docId:9_kBHO1LF4ICD6Js6u4Gk)&#x20;
- [prevTimeOff](docId\:NgvMA7vMOmpAty1rmJTrx)&#x20;