Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-1325119255.7 KB
Time Off Requests

Create Time Off Request

Create Time Off Request

post/hris/time-off-requests

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

A unique identifier for an object.

employee_idstring nullable

ID of the employee

policy_idstring nullable

ID of the policy

status'requested' | 'approved' | 'declined' | 'cancelled' | 'deleted' | 'other' nullable

The status of the time off request.

descriptionstring nullable

Description of the time off request.

start_datestring nullable

The start date of the time off request.

end_datestring nullable

The end date of the time off request.

request_datestring nullable

The date the request was made.

request_type'vacation' | 'sick' | 'personal' | 'jury_duty' | 'volunteer' | 'bereavement' | 'other' nullable

The type of request

approval_datestring nullable

The date the request was approved

units'days' | 'hours' | 'other' nullable

The unit of time off requested. Possible values include: hours, days, or other.

amountnumber nullable

The amount of time off requested.

day_partstring nullable

The day part of the time off request.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

policy_typestring

The policy type of the time off request

Example request

{
  "id": "12345",
  "employee_id": "12345",
  "policy_id": "12345",
  "status": "approved",
  "description": "Enjoying some sun.",
  "start_date": "2022-04-01",
  "end_date": "2022-04-01",
  "request_date": "2022-03-21",
  "request_type": "vacation",
  "approval_date": "2022-03-21",
  "units": "hours",
  "amount": 3.5,
  "day_part": "morning",
  "notes": {
    "employee": "Relaxing on the beach for a few hours.",
    "manager": "Enjoy!"
  },
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ],
  "policy_type": "sick"
}

Response

TimeOffRequests

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "bamboohr",
  "resource": "time-off-requests",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}