Skip to navigation

The TimeOff object

The TimeOff object is used to represent all employees’ Time Off entries.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
employeestring or nullOptionalformat: "uuid"
The employee requesting time off.
approverstring or nullOptionalformat: "uuid"
The Merge ID of the employee with the ability to approve the time off request.
statusenum or nullOptional

The status of this time off request. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=status to receive the integration's own value instead.

Allowed values:
employee_notestring or nullOptional
The employee note for this time off request.
unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=units to receive the integration's own value instead.

Allowed values:
amountdouble or nullOptional

The time off quantity measured by the prescribed “units”.

request_typeenum or nullOptional

The type of time off request. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=request_type to receive the integration's own value instead.

start_timedatetime or nullOptional
The day and time of the start of the time requested off.
end_timedatetime or nullOptional
The day and time of the end of the time requested off.
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only