Time Off

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

The TimeOff object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

employeeString

Optional

approverString

Optional

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_was_deletedBoolean

Required

The TimeOff object

JSON


{
  "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": "Moving into the new apartment Kendall Roy gave me!",
  "units": "DAYS",
  "amount": 3,
  "request_type": "VACATION",
  "start_time": "2020-11-10T00:00:00Z",
  "end_time": "2020-11-17T00:00:00Z",
  "remote_was_deleted": true
}

GET

/time-off

Returns a list of TimeOff objects.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

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_deleted_dataBoolean

Optional

Whether to include data that was deleted in the third-party service.

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

JSON


{
  "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": "Moving into the new apartment Kendall Roy gave me!",
      "units": "DAYS",
      "amount": 3,
      "request_type": "VACATION",
      "start_time": "2020-11-10T00:00:00Z",
      "end_time": "2020-11-17T00:00:00Z",
      "remote_was_deleted": true
    }
  ]
}

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

remote_idString

end_timeString

employee_noteString

employeeString

statusEnum

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

start_timeString

unitsEnum

remote_idString

employee_noteString

employeeString

statusEnum

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

end_timeString

approverString

remote_idString

start_timeString

employee_noteString

employeeString

statusEnum

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

amountNumber

end_timeString

unitsEnum

remote_idString

employee_noteString

start_timeString

statusEnum

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

amountNumber

unitsEnum

end_timeString

remote_idString

employee_noteString

start_timeString

statusEnum

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

unitsEnum

end_timeString

remote_idString

start_timeString

statusEnum

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

amountNumber

unitsEnum

end_timeString

remote_idString

employee_noteString

start_timeString

statusEnum

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

start_timeString

remote_idString

approverString

unitsEnum

employee_noteString

employeeString

statusEnum

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

end_timeString

approverString

remote_idString

start_timeString

statusEnum

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

approverString

remote_idString

employee_noteString

employeeString

statusEnum

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

unitsEnum

remote_idString

start_timeString

employee_noteString

employeeString

statusEnum

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

amountNumber

end_timeString

unitsEnum

approverString

remote_idString

employee_noteString

start_timeString

statusEnum

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

start_timeString

remote_idString

approverString

unitsEnum

employee_noteString

employeeString

statusEnum

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

end_timeString

employee_noteString

employeeString

statusEnum

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

employeeString

statusEnum

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

end_timeString

unitsEnum

remote_idString

start_timeString

statusEnum

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

amountNumber

unitsEnum

end_timeString

remote_idString

employee_noteString

start_timeString

statusEnum

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

remote_idString

end_timeString

employeeString

statusEnum

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

end_timeString

start_timeString

employee_noteString

employeeString

statusEnum

CharlieHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

start_timeString

remote_idString

approverString

unitsEnum

employee_noteString

employeeString

statusEnum

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

remote_idString

end_timeString

approverString

employeeString

statusEnum

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

end_timeString

remote_idString

start_timeString

employee_noteString

employeeString

statusEnum

Hint: Use the /linked-accounts endpoint to pull platform support information.

POST

/time-off

Creates a TimeOff object with the given values.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

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

remote_idString

Optional

The third-party API ID of the matching object.

employeeString

Optional

Must pass in a valid Merge ID, which can be obtained from the id field in the Employee table.

approverString

Optional

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

JSON


{
  "model": {
    "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": "Moving into the new apartment Kendall Roy gave me!",
    "units": "DAYS",
    "amount": 3,
    "request_type": "VACATION",
    "start_time": "2020-11-10T00:00:00Z",
    "end_time": "2020-11-17T00:00:00Z",
    "remote_was_deleted": true
  },
  "warnings": [
    {
      "source": {
        "pointer": "/age"
      },
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD"
    }
  ],
  "errors": [
    {
      "source": {
        "pointer": "/model/custom_fields"
      },
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD"
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "https://harvest.greenhouse.io/v1/candidates/",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

request_typeEnum

Required

amountNumber

Optional

end_timeString

Optional

start_timeString

Optional

unitsEnum

Optional

remote_idString

Optional

employee_noteString

Optional

employeeString

Required

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

request_typeEnum

Optional

amountNumber

Optional

end_timeString

Optional

start_timeString

Optional

unitsEnum

Optional

employee_noteString

Optional

employeeString

Optional

statusEnum

Optional

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

request_typeEnum

Required

amountNumber

Optional

end_timeString

Required

start_timeString

Required

approverString

Optional

unitsEnum

Optional

remote_idString

Optional

employee_noteString

Required

employeeString

Optional

statusEnum

Optional

Personio

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

employeeString

Required

request_typeEnum

Required

end_timeString

Required

unitsEnum

Optional

remote_idString

Optional

employee_noteString

Optional

start_timeString

Required

statusEnum

Optional

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

request_typeEnum

Optional

amountNumber

Optional

end_timeString

Optional

start_timeString

Optional

employee_noteString

Optional

employeeString

Required

statusEnum

Optional

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

employeeString

Required

request_typeEnum

Required

amountNumber

Optional

unitsEnum

Optional

end_timeString

Required

remote_idString

Optional

approverString

Optional

employee_noteString

Optional

start_timeString

Required

statusEnum

Optional

Workday

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

employeeString

Required

request_typeEnum

Required

amountNumber

Required

unitsEnum

Optional

remote_idString

Optional

employee_noteString

Optional

start_timeString

Required

statusEnum

Optional

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/time-off/{id}

Returns a TimeOff object with the given id.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

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

JSON


{
  "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": "Moving into the new apartment Kendall Roy gave me!",
  "units": "DAYS",
  "amount": 3,
  "request_type": "VACATION",
  "start_time": "2020-11-10T00:00:00Z",
  "end_time": "2020-11-17T00:00:00Z",
  "remote_was_deleted": true
}

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

remote_idString

end_timeString

employee_noteString

employeeString

statusEnum

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

start_timeString

unitsEnum

remote_idString

employee_noteString

employeeString

statusEnum

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

end_timeString

approverString

remote_idString

start_timeString

employee_noteString

employeeString

statusEnum

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

amountNumber

end_timeString

unitsEnum

remote_idString

employee_noteString

start_timeString

statusEnum

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

amountNumber

unitsEnum

end_timeString

remote_idString

employee_noteString

start_timeString

statusEnum

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

unitsEnum

end_timeString

remote_idString

start_timeString

statusEnum

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

amountNumber

unitsEnum

end_timeString

remote_idString

employee_noteString

start_timeString

statusEnum

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

start_timeString

remote_idString

approverString

unitsEnum

employee_noteString

employeeString

statusEnum

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

end_timeString

approverString

remote_idString

start_timeString

statusEnum

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

approverString

remote_idString

employee_noteString

employeeString

statusEnum

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

unitsEnum

remote_idString

start_timeString

employee_noteString

employeeString

statusEnum

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

amountNumber

end_timeString

unitsEnum

approverString

remote_idString

employee_noteString

start_timeString

statusEnum

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

start_timeString

remote_idString

approverString

unitsEnum

employee_noteString

employeeString

statusEnum

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

end_timeString

employee_noteString

employeeString

statusEnum

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

employeeString

statusEnum

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

end_timeString

unitsEnum

remote_idString

start_timeString

statusEnum

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

employeeString

request_typeEnum

amountNumber

unitsEnum

end_timeString

remote_idString

employee_noteString

start_timeString

statusEnum

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

remote_idString

end_timeString

employeeString

statusEnum

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

end_timeString

start_timeString

employee_noteString

employeeString

statusEnum

CharlieHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

start_timeString

remote_idString

approverString

unitsEnum

employee_noteString

employeeString

statusEnum

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

remote_idString

end_timeString

approverString

employeeString

statusEnum

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

end_timeString

remote_idString

start_timeString

employee_noteString

employeeString

statusEnum

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/time-off/meta/post

Returns metadata for TimeOff POSTs.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Response

JSON


{
  "request_schema": {},
  "status": {
    "linked_account_status": "string",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

unitsEnum

start_timeString

remote_idString

end_timeString

employee_noteString

employeeString

statusEnum

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

request_typeEnum

amountNumber

end_timeString

start_timeString

unitsEnum

remote_idString

employee_noteString

employeeString