TimeOff
object is used to represent all employees' Time Off entries.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)employee
UUIDapprover
UUIDstatus
EnumREQUESTED
, APPROVED
, DECLINED
, CANCELLED
, DELETED
. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.employee_note
Stringunits
EnumHOURS
, DAYS
. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.start_time
DateTime (ISO 8601)end_time
DateTime (ISO 8601)remote_was_deleted
Booleanfield_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
Stringended_after
DateTime (ISO 8601)ended_before
DateTime (ISO 8601)expand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_shell_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_fields
Stringremote_id
Stringrequest_type
Stringshow_enum_origins
Stringstarted_after
DateTime (ISO 8601)started_before
DateTime (ISO 8601)status
StringSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringremote_data
RemoteData[]path
stringdata
stringunits
EnumSupported Response Fields
amount
Numberemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)request_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported Response Fields
employee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_time
DateTime (ISO 8601)status
EnumSupported 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
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)units
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported Response Fields
approver
UUIDemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)status
EnumSupported Response Fields
amount
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
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
ObjectSupported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)request_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumAdditional POST Parameters
integration_params
Objectcustom_request_type
StringSupported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported POST Model Parameters
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported POST Model Parameters
amount
Numberapprover
UUIDemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)units
EnumSupported POST Model Parameters
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_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
StringSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringremote_data
RemoteData[]path
stringdata
stringunits
EnumSupported Response Fields
amount
Numberemployee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)request_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_id
Stringstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringrequest_type
Enumstart_time
DateTime (ISO 8601)status
Enumunits
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported 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
EnumSupported Response Fields
employee
UUIDend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_time
DateTime (ISO 8601)status
EnumSupported 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
EnumSupported 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
EnumSupported Response Fields
amount
Numberemployee
UUIDemployee_note
Stringend_time
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)units
EnumSupported 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
EnumSupported 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
EnumSupported 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)