Common ModelsTime off

The TimeOff object

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

idstringOptionalformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptional
The datetime that this object was created by Merge.
modified_atdatetimeOptional
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.

  • REQUESTED - REQUESTED
  • APPROVED - APPROVED
  • DECLINED - DECLINED
  • CANCELLED - CANCELLED
  • DELETED - DELETED
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.

  • HOURS - HOURS
  • DAYS - DAYS
Allowed values:
amountdouble or nullOptional

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

request_typeenum or nullOptional

The type of time off request.

  • VACATION - VACATION
  • SICK - SICK
  • PERSONAL - PERSONAL
  • JURY_DUTY - JURY_DUTY
  • VOLUNTEER - VOLUNTEER
  • BEREAVEMENT - BEREAVEMENT
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_deletedbooleanOptional

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 nullOptional
remote_datalist of objects or nullOptional