Common ModelsTime off

/time-off/{id}

Returns a TimeOff object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Response

idstring or nullRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only
The datetime that this object was created by Merge.
modified_atdatetime or nullRead-only
The datetime that this object was modified by Merge.
employeestring or nullformat: "uuid"
The employee requesting time off.
approverstring or nullformat: "uuid"
The Merge ID of the employee with the ability to approve the time off request.
statusenum or null
The status of this time off request. * `REQUESTED` - REQUESTED * `APPROVED` - APPROVED * `DECLINED` - DECLINED * `CANCELLED` - CANCELLED * `DELETED` - DELETED
Allowed values:
employee_notestring or null
The employee note for this time off request.
unitsenum or null
The measurement that the third-party integration uses to count time requested. * `HOURS` - HOURS * `DAYS` - DAYS
Allowed values:
amountdouble or null

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

request_typeenum or null
The type of time off request. * `VACATION` - VACATION * `SICK` - SICK * `PERSONAL` - PERSONAL * `JURY_DUTY` - JURY_DUTY * `VOLUNTEER` - VOLUNTEER * `BEREAVEMENT` - BEREAVEMENT
start_timedatetime or null
The day and time of the start of the time requested off.
end_timedatetime or null
The day and time of the end of the time requested off.
remote_was_deletedboolean or nullRead-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](https://docs.merge.dev/integrations/hris/supported-features/).
field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+2ba2/iOBSG/0rkT7sVl7ZMt1uk1YqScmmHlIF0drqjUXRwDsGQxKnjlMJo/vsqFyi9jdSOaaGbbyTYb8zjN8fHF74TChIdLmakSkaChaRAPG6jS6rEZB6eD4ekQCBgBniYFbGu90mBhFEQcCHRbjB07bAlcEiqpOyhcLAY+WzI0C7HxcvMl+gIkIz7YXlZrThM6pECcZk/QbtGKY98+TOhtGAR0pL3LuOvQ0kKJIAwlCPBI2fUw6sIw59qxu1x0UNfglu0QUJ5pX5RpAKP3YtbbqOLEm0dJOgokcY/MXvWSMogrJbLI3SDUvLcko3XZfTLICSjLoblg8rR/uHRQTFTSZ7+t+W4f+3tjK8GfHC4YznUtSDa6Zj0xjDbU2PsfDDqH26M+cWBMZ/MjfFkd8dyYKdjdg7OzcvKuV7bO3+kgNX/48vR52P9+NTYofOTijG+nBom3euYdDKYtyunTTo9bX26MeaX+x39omKYJwenTb53Xu+FnXqPd2qlEimQ1Z4k1a/fV29kBqnpXU0/qbf19kXnbo22Bw6ukEk7AwJWDKKBy2gprJTAgzn3YRqWKPfKHtoMyjW9a+lImc0iz+pfRSCwFPjOAj/j/pI9qZITo1Uz6if6XSPUroG5MHCRVKWI8IF7SfUrgSAQ/BoFKRD0ApfPEFc+Wj6XybVvW5J58UeBHpdoxd1298oKQI5ubzE7fl0kCLmoGUqQUWygyGcyJN/iolcRE2h3QYCHEkXcpG8/Ck8hNvBGak301SGOFa0m+mtF7MVv6noAZ6+lJWcBquf9DxeTIRcUNYNP1UFfyloGn+bk75M/Bm/AeaunBvhCLeNsfeQOL42DHHYGWyDIESpinYqtorYal0f/OmNvvcjXG8XXR78+AuEyRfQzsXtWX2tc2VbuOsySAKwGfNcFOeTCW6i+21h+FcUV0JdxKi1eDB/RVQwe0X230J8PuAFUcsFAEeWl3OvFle3Czd1JqKnKVxaeTlSt8P0lhy9kHInkKSr8nGi9R7S/6GOB4UgieIowL+ReZYazrZlIE30UjGr9htlVw91JFa1wKIPM5JZ3WrnZbV9sZhe8QQrSAubiTHnMTmWtVu/1osqzDL0uE7fYgA8Uo4wlNxTja8SFVk/rgpB+4nEFXFu9TC5fB3mCd7wqFyo2cSqa5xi3mCMPwFeEORN7PUdva5LRijymBvko8lgxz5zv8T2NQjlVFz6WcnmsfhT3GU5ADekJTiCfCD7k64+52pEwkdw80qo3aT9GlCqyZiL1JsPZxvnxfDhklGHSZgVkl3Kv7cdNwSmAuqjVXR7ZWpxD+VodAibB1Trgg5Oci9F+a9U7vysCnjxw897+N++IWShRqFqESNXeMeVn0u3CjHJFs+fFMBYkmu+Y8Qud3EUeuKhsOS1Ts2qUYhjmJ2Qe4hYh95mqHC1TW8w2GvwzNA/NnPctbxd8G2ZqY0kmuhbML0znFETdXqKqhlTawmy5wc0PszyBvA8OKtvKiMWslSNElcH0w2EnjwV3aacjlELiqeCCOr3pt+nZeOuo//o+f7/W1fpRMuynx04ULand1bxzQPGYfuFOYzdfX7vtBAzBU+TuxWiXav6PN/T6IwhQlZsTLUsXCJ4Zn7DItvmvoTGU9vEGxY11Q2VpCxRN85Zy2zrlUIjWFMxAqcX70NkrrIaxKZiP0trbOrbrc/HFWVPrCr7yd5PbdTg10C/OmosYYcPRp92DTYoRm4C/h2Armt+tsHYQWn9edfNpy2PYY7crn1Rnom/mbmWHsJ59zu3bj/8AeyyIxtY7AAA=" />