/time-off

curl -X POST https://api.merge.dev/api/hris/v1/time-off \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": {}
}'

{
  "model": {
    "id": "91b2b905-e866-40c8-8be2-efe53827a0aa",
    "remote_id": "19202938",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "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,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/leave"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates a TimeOff object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

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

run_asyncbooleanOptional

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

Request

This endpoint expects an object.

modelobjectRequired

Description

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

Usage Example

Fetch from the LIST TimeOffs endpoint and filter by ID to show all time off requests.

Response

modelobject

Description

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

Usage Example

Fetch from the LIST TimeOffs endpoint and filter by ID to show all time off requests.

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

employeestring or nullOptionalformat: "uuid"

The employee requesting time off.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

request_typeenum or nullOptional

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullOptional

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

end_timedatetime or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

request_typeenum or nullOptional

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullOptional

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

end_timedatetime or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

Supported POST model parameters

employee_notestring or nullRequired

The employee note for this time off request.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

employeestring or nullOptionalformat: "uuid"

The employee requesting time off.

approverstring or nullOptionalformat: "uuid"

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

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

approverstring or nullOptionalformat: "uuid"

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

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

start_timedatetime or nullOptional

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

end_timedatetime or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

request_typeenum or nullOptional

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

unitsenum or nullRequired

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullRequired

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

start_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

request_typeenum or nullOptional

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

Supported POST model parameters

employeestring or nullOptionalformat: "uuid"

The employee requesting time off.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

request_typeenum or nullOptional

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullOptional

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

end_timedatetime or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

request_typeenum or nullOptional

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullOptional

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

end_timedatetime or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

Supported POST model parameters

employee_notestring or nullRequired

The employee note for this time off request.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

employeestring or nullOptionalformat: "uuid"

The employee requesting time off.

approverstring or nullOptionalformat: "uuid"

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

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

approverstring or nullOptionalformat: "uuid"

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

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

request_typeenum or nullRequired

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_notestring or nullOptional

The employee note for this time off request.

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

start_timedatetime or nullOptional

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

end_timedatetime or nullOptional

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

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

start_timedatetime or nullRequired

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

end_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

unitsenum or nullOptional

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullOptional

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

request_typeenum or nullOptional

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

Supported POST model parameters

employeestring or nullRequiredformat: "uuid"

The employee requesting time off.

unitsenum or nullRequired

The measurement that the third-party integration uses to count time requested.

HOURS - HOURS
DAYS - DAYS

Allowed values:

amountdouble or nullRequired

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

start_timedatetime or nullRequired

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

remote_idstring or nullOptional

The third-party API ID of the matching object.

statusenum or nullOptional

The status of this time off request.

REQUESTED - REQUESTED
APPROVED - APPROVED
DECLINED - DECLINED
CANCELLED - CANCELLED
DELETED - DELETED

Allowed values:

employee_notestring or nullOptional

The employee note for this time off request.

request_typeenum or nullOptional

The type of time off request.

VACATION - VACATION
SICK - SICK
PERSONAL - PERSONAL
JURY_DUTY - JURY_DUTY
VOLUNTEER - VOLUNTEER
BEREAVEMENT - BEREAVEMENT

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Field support by integration