Time Off

The TimeOff object is used to represent a Time Off Request filed by an employee.

The TimeOff object

Properties


idString
Optional

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

employeeString
Optional
The employee requesting time off.

approverString
Optional
The employee approving the time off request.

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

employee_noteString
Optional
The employee note for this time off request.

unitsEnum
Optional
The unit of time requested. Possible values include: HOURS, DAYS, or - in cases where there is no clear mapping - the original value passed through.

amountNumber
Optional
The number of time off units requested.

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

start_timeString
Optional
The day and time of the start of the time requested off.

end_timeString
Optional
The day and time of the end of the time requested off.

remote_dataRemoteData[]
Optional

The TimeOff object

{
  "id": "91b2b905-e866-40c8-8be2-efe53827a0aa",
  "remote_id": "19202938",
  "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f",
  "status": "APPROVED",
  "employee_note": "Trip to Iowa. Miss those cornfields!",
  "units": "DAYS",
  "amount": 7,
  "request_type": "VACATION",
  "start_time": "2020-11-10T00:00:00Z",
  "end_time": "2020-11-17T00:00:00Z",
  "remote_data": [
    {
      "path": "/leave",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/time-off

Returns a list of TimeOff objects.


Query & Path Parameters


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

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
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.

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

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

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

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')

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

Response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "91b2b905-e866-40c8-8be2-efe53827a0aa",
      "remote_id": "19202938",
      "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
      "approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f",
      "status": "APPROVED",
      "employee_note": "Trip to Iowa. Miss those cornfields!",
      "units": "DAYS",
      "amount": 7,
      "request_type": "VACATION",
      "start_time": "2020-11-10T00:00:00Z",
      "end_time": "2020-11-17T00:00:00Z",
      "remote_data": [
        {
          "path": "/leave",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

approverString

unitsEnum

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

remote_dataRemoteData[]

employeeString

start_timeString

statusEnum

approverString

remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

remote_idString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

approverString

unitsEnum

remote_idString

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

approverString

unitsEnum

remote_idString

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

remote_idString

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

remote_idString
POST

/time-off

BETA

Creates a TimeOff object with the given values.


Query & Path Parameters


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

Body Parameters


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

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

approverString
Optional
The employee approving the time off request. Must pass in a valid Merge ID, which can be obtained from the id field in the Approver table.

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

employee_noteString
Optional
The employee note for this time off request.

unitsEnum
Optional
The unit of time requested. Must pass in one of the following choices: HOURS, DAYS.

amountNumber
Optional
The number of time off units requested.

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

start_timeString
Optional
The day and time of the start of the time requested off.

end_timeString
Optional
The day and time of the end of the time requested off.

Response

{
  "id": "91b2b905-e866-40c8-8be2-efe53827a0aa",
  "remote_id": "19202938",
  "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f",
  "status": "APPROVED",
  "employee_note": "Trip to Iowa. Miss those cornfields!",
  "units": "DAYS",
  "amount": 7,
  "request_type": "VACATION",
  "start_time": "2020-11-10T00:00:00Z",
  "end_time": "2020-11-17T00:00:00Z",
  "remote_data": [
    {
      "path": "/leave",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


end_timeString
Optional

amountNumber
Optional

employeeString
Required

request_typeEnum
Optional

start_timeString
Optional

employee_noteString
Optional

statusEnum
Optional

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


end_timeString
Optional

amountNumber
Optional

employeeString
Required

request_typeEnum
Required

start_timeString
Optional

employee_noteString
Optional

unitsEnum
Optional

remote_idString
Optional

Sapling

Sapling

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


end_timeString
Required

amountNumber
Required

employeeString
Optional

request_typeEnum
Required

start_timeString
Required

employee_noteString
Required

statusEnum
Required

unitsEnum
Optional

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


end_timeString
Optional

amountNumber
Optional

employeeString
Optional

request_typeEnum
Optional

start_timeString
Optional

employee_noteString
Optional

statusEnum
Optional

unitsEnum
Optional

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


end_timeString
Required

amountNumber
Optional

employeeString
Optional

request_typeEnum
Required

start_timeString
Required

employee_noteString
Required

statusEnum
Optional

approverString
Optional

unitsEnum
Optional

remote_idString
Optional

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


end_timeString
Required

amountNumber
Optional

employeeString
Required

request_typeEnum
Required

start_timeString
Required

employee_noteString
Optional

statusEnum
Optional

approverString
Optional

unitsEnum
Optional

remote_idString
Optional

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


end_timeString
Required

employeeString
Required

request_typeEnum
Required

start_timeString
Required

employee_noteString
Optional

statusEnum
Optional

unitsEnum
Optional

remote_idString
Optional

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


amountNumber
Required

employeeString
Required

request_typeEnum
Required

start_timeString
Required

employee_noteString
Optional

statusEnum
Optional

unitsEnum
Optional

remote_idString
Optional
GET

/time-off/{id}

Returns an 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.

idString
Required

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

Response

{
  "id": "91b2b905-e866-40c8-8be2-efe53827a0aa",
  "remote_id": "19202938",
  "employee": "d2f972d0-2526-434b-9409-4c3b468e08f0",
  "approver": "9efbc633-3387-4306-aa55-e2c635e6bb4f",
  "status": "APPROVED",
  "employee_note": "Trip to Iowa. Miss those cornfields!",
  "units": "DAYS",
  "amount": 7,
  "request_type": "VACATION",
  "start_time": "2020-11-10T00:00:00Z",
  "end_time": "2020-11-17T00:00:00Z",
  "remote_data": [
    {
      "path": "/leave",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

approverString

unitsEnum

remote_idString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

remote_dataRemoteData[]

employeeString

start_timeString

statusEnum

approverString

remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

remote_idString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

approverString

unitsEnum

remote_idString

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

approverString

unitsEnum

remote_idString

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

remote_idString

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

employee_noteString

statusEnum

unitsEnum

remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


end_timeString

amountNumber

remote_dataRemoteData[]

employeeString

request_typeEnum

start_timeString

statusEnum

unitsEnum

remote_idString