TimeOff
object is used to represent all employees' Time Off entries.id
UUIDremote_id
Stringemployee
UUIDapprover
UUIDstatus
EnumREQUESTED
, APPROVED
, DECLINED
, CANCELLED
, DELETED
. In cases where there is no clear mapping, the original value passed through will be returned.employee_note
Stringunits
EnumHOURS
, DAYS
. In cases where there is no clear mapping, the original value passed through will be returned.amount
Numberrequest_type
EnumVACATION
, SICK
, PERSONAL
, JURY_DUTY
, VOLUNTEER
, BEREAVEMENT
. In cases where there is no clear mapping, the original value passed through will be returned.start_time
DateTime (ISO 8601)end_time
DateTime (ISO 8601)remote_was_deleted
Booleancreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)field_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/hris/v1/time-off
Returns a list of TimeOff
objects.
approver_id
Stringcreated_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringemployee_id
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_fields
Stringremote_id
Stringrequest_type
Stringshow_enum_origins
Stringstatus
String
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
employee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)request_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
employee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
approver
UUIDemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)status
Enum
Supported Response Fields
amount
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enumhttps://api.merge.dev/api/hris/v1/time-off
Creates a TimeOff
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectemployee
UUIDid
field in the Employee object.approver
UUIDid
field in the Employee object.status
EnumREQUESTED
, APPROVED
, DECLINED
, CANCELLED
, DELETED
.employee_note
Stringunits
EnumHOURS
, DAYS
.amount
Numberrequest_type
EnumVACATION
, SICK
, PERSONAL
, JURY_DUTY
, VOLUNTEER
, BEREAVEMENT
.start_time
DateTime (ISO 8601)end_time
DateTime (ISO 8601)integration_params
Objectlinked_account_params
Object
Supported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)request_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)request_type
Enumstart_time
DateTime (ISO 8601)status
Enum
Supported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported POST Model Parameters
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported POST Model Parameters
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)units
Enum
Supported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enumhttps://api.merge.dev/api/hris/v1/time-off/{id}
Returns a TimeOff
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
employee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)request_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
employee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
approver
UUIDemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)status
Enum
Supported Response Fields
amount
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enumhttps://api.merge.dev/api/hris/v1/time-off/meta/post
Returns metadata for TimeOff
POSTs.

Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
employee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)request_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
Enum
Supported Response Fields
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time