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

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.

employeeUUID
Optional
The employee requesting time off.

approverUUID
Optional
The Merge ID of the employee with the ability to approve the time off request.

statusEnum
Optional
The status of this time off request. Possible values include: REQUESTED, APPROVED, DECLINED, CANCELLED, DELETED. In cases where there is no clear mapping, the original value passed through will be returned.

employee_noteString
Optional
The employee note for this time off request.

unitsEnum
Optional
The measurement that the third-party integration uses to count time requested. Possible values include: HOURS, DAYS. In cases where there is no clear mapping, the original value passed through will be returned.

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

request_typeEnum
Optional
The type of time off request. Possible values include: VACATION, SICK, PERSONAL, JURY_DUTY, VOLUNTEER, BEREAVEMENT. In cases where there is no clear mapping, the original value passed through will be returned.

start_timeDateTime (ISO 8601)
Optional
The day and time of the start of the time requested off.

end_timeDateTime (ISO 8601)
Optional
The day and time of the end of the time requested off.

remote_was_deletedBoolean
Required

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/time-off

https://api.merge.dev/api/hris/v1/time-off

US
EU

Returns a list of TimeOff objects.


Query & Path Parameters

approver_idString
Optional
If provided, will only return time off for this approver.

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

employee_idString
Optional
If provided, will only return time off for this employee.

ended_afterDateTime (ISO 8601)
Optional
If provided, will only return employees that ended after this datetime.

ended_beforeDateTime (ISO 8601)
Optional
If provided, will only return time-offs that ended before this datetime.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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

modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

remote_idString
Optional
The API provider's ID for the given object.

request_typeString
Optional
If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')

show_enum_originsString
Optional
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

started_afterDateTime (ISO 8601)
Optional
If provided, will only return time-offs that started after this datetime.

started_beforeDateTime (ISO 8601)
Optional
If provided, will only return time-offs that started before this datetime.

statusString
Optional
If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
AlexisHR
AlexisHR
BambooHR
BambooHR
Breathe
Breathe
Charlie
Charlie
Dayforce
Dayforce
Factorial
Factorial
Freshteam
Freshteam
Hailey HR
Hailey HR
Hibob
Hibob
HR Partner
HR Partner
Humaans
Humaans
Humi
Humi
Justworks
Justworks
Keka
Keka
Kenjo
Kenjo
Lucca
Lucca
Officient
Officient
Oracle Cloud Human Capital Management (HCM)
Oracle Cloud Human Capital Management (HCM)
OysterHR
OysterHR
Paycor
Paycor
PeopleHR
PeopleHR
Personio
Personio
Remote
Remote
Rippling
Rippling
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
Sesame
Sesame
TriNet HR Platform
TriNet HR Platform
UKG Pro Workforce Management
UKG Pro Workforce Management
UKG Ready
UKG Ready
Workday
Workday
POST
/time-off
Beta

https://api.merge.dev/api/hris/v1/time-off

US
EU

Creates a TimeOff object with the given values.


Query & Path Parameters

is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters

modelObject
Required
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.

employeeUUID
The employee requesting time off. Must pass in a valid Merge ID, which can be obtained from the id field in the Employee object.

approverUUID
The Merge ID of the employee with the ability to approve the time off request. Must pass in a valid Merge ID, which can be obtained from the id field in the Employee object.

statusEnum
The status of this time off request. Must pass in one of the following choices: REQUESTED, APPROVED, DECLINED, CANCELLED, DELETED.

employee_noteString
The employee note for this time off request.

unitsEnum
The measurement that the third-party integration uses to count time requested. Must pass in one of the following choices: HOURS, DAYS.

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

request_typeEnum
The type of time off request. Must pass in one of the following choices: VACATION, SICK, PERSONAL, JURY_DUTY, VOLUNTEER, BEREAVEMENT.

start_timeDateTime (ISO 8601)
The day and time of the start of the time requested off.

end_timeDateTime (ISO 8601)
The day and time of the end of the time requested off.

integration_paramsObject

linked_account_paramsObject

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
BambooHR
BambooHR
Dayforce
Dayforce
Freshteam
Freshteam
Humaans
Humaans
Personio
Personio
Sage HR
Sage HR
Workday
Workday
To include the correct model fields when making POST requests, use the GET /time-off/meta/post endpoint. Learn more in our /meta guide.
GET
/time-off/{id}

https://api.merge.dev/api/hris/v1/time-off/{id}

US
EU

Returns a TimeOff object with the given id.


Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID
Required

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

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
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

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
AlexisHR
AlexisHR
BambooHR
BambooHR
Breathe
Breathe
Charlie
Charlie
Dayforce
Dayforce
Factorial
Factorial
Freshteam
Freshteam
Hailey HR
Hailey HR
Hibob
Hibob
HR Partner
HR Partner
Humaans
Humaans
Humi
Humi
Justworks
Justworks
Keka
Keka
Kenjo
Kenjo
Lucca
Lucca
Officient
Officient
Oracle Cloud Human Capital Management (HCM)
Oracle Cloud Human Capital Management (HCM)
OysterHR
OysterHR
Paycor
Paycor
PeopleHR
PeopleHR
Personio
Personio
Remote
Remote
Rippling
Rippling
Sage HR
Sage HR
SAP SuccessFactors
SAP SuccessFactors
Sesame
Sesame
TriNet HR Platform
TriNet HR Platform
UKG Pro Workforce Management
UKG Pro Workforce Management
UKG Ready
UKG Ready
Workday
Workday
GET
/time-off/meta/post

https://api.merge.dev/api/hris/v1/time-off/meta/post

US
EU

Returns metadata for TimeOff POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ADP Workforce Now
ADP Workforce Now
BambooHR
BambooHR
Dayforce
Dayforce
Freshteam
Freshteam