Appearance

Create Timeoff requests ​

Endpoint ​

http
POST /unified/hris/timeoff_requests
Integrations supported
  • AlexisHR
  • BambooHR
  • Breathe
  • Factorial
  • HiBob
  • Humaans
  • Keka
  • PeopleHR
  • Personio
  • Workable
  • Zoho People

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

employee
object

This represents the employee requesting time off.

References: Employees → id
Required in
  • AlexisHR
  • BambooHR
  • HiBob
  • Humaans
  • Keka
  • PeopleHR
  • Personio
  • Zoho People
Supported in
  • Breathe
  • Factorial
id
string
REQUIRED · 

The unique identifier for employees

name
string

This represents the name of the employee.

reason
object

This represents the reason of the time off request.

Required in
  • Keka
  • PeopleHR
Supported in
  • Breathe
id
string
REQUIRED · 

The unique identifier for timeoff_reason

name
string

This represents the name of the timeoff_reason.

start_time
string · date-time

This represents the start time of the time off request.

Required in
  • AlexisHR
  • BambooHR
  • Breathe
  • Factorial
  • HiBob
  • Humaans
  • Keka
  • PeopleHR
  • Personio
  • Workable
  • Zoho People
end_time
string · date-time

This represents the end time of the time off request.

Required in
  • AlexisHR
  • BambooHR
  • Breathe
  • Factorial
  • HiBob
  • Humaans
  • Keka
  • PeopleHR
  • Personio
  • Workable
  • Zoho People
amount
number

This represents the amount of the time off request.

Required in
  • BambooHR
  • PeopleHR
employee_note
string

This represents the employee note for the time off request.

Required in
  • PeopleHR
session
string

This represents the session of the time off request.

All possible enum values:
  • full
  • morning
  • afternoon
Enum support by integration
  • PeopleHR
    • morning
    • afternoon
  • Factorial
    • full
    • morning
    • afternoon
Required in
  • PeopleHR
Supported in
  • Breathe
  • Factorial
  • Personio
absence_paid_status
string
All possible enum values:
  • paid
  • unpaid
Enum support by integration
  • PeopleHR
    • paid
    • unpaid
Required in
  • PeopleHR
is_emergency_leave
boolean
Required in
  • PeopleHR
timeoff_type
string

This represents the time off type of the time off request.

References: TimeoffTypes → id
Required in
  • AlexisHR
  • Humaans
  • Keka
  • Personio
  • Workable
  • Zoho People
Supported in
  • Factorial
description
string

This represents the description of the time off request.

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • Humaans
  • Keka
  • Personio
request_policy_type
string

This represents the request type of the time off request.

Required in
  • BambooHR
  • HiBob
approver
string

This represents the approver of the time off request.

Supported in
  • HiBob
status
string

This represents the status of the time off request.

Supported in
  • BambooHR
duration
Required in
  • AlexisHR
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The unique identifier for timeoffpolicies

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • HiBob
  • Keka
  • PeopleHR
  • Workable
description
string

This represents the description of the time off request.

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • Keka
reason
object

This represents the reason of the time off request.

Supported in
  • Breathe
  • PeopleHR
id
string
REQUIRED · 

The unique identifier for timeoff_reason

name
string

This represents the name of the timeoff_reason.

employee
object

This represents the employee requesting time off.

References: Employees → id
Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • HiBob
  • Keka
  • PeopleHR
  • Workable
id
string
REQUIRED · 

The unique identifier for employees

name
string

This represents the name of the employee.

approver
string

This represents the approver of the time off request.

Supported in
  • Breathe
status
string

This represents the status of the time off request.

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • HiBob
  • Keka
  • Workable
employee_note
string

This represents the employee note for the time off request.

Supported in
  • PeopleHR
units
string

This represents the units of the time off request.

All possible enum values:
  • hours
  • days
  • weeks
  • months
Supported in
  • AlexisHR
  • Breathe
  • HiBob
  • Workable
amount
number

This represents the amount of the time off request.

Supported in
  • Breathe
  • HiBob
  • PeopleHR
  • Workable
timeoff_type
string

This represents the time off type of the time off request.

References: TimeoffTypes → id
Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • Keka
  • Workable
request_policy_type
string

This represents the request type of the time off request.

Supported in
  • HiBob
start_time
string · date-time

This represents the start time of the time off request.

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • HiBob
  • Keka
  • PeopleHR
  • Workable
end_time
string · date-time

This represents the end time of the time off request.

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • HiBob
  • Keka
  • PeopleHR
  • Workable
session
string

This represents the session of the time off request.

All possible enum values:
  • full
  • morning
  • afternoon
Supported in
  • Breathe
  • Factorial
  • PeopleHR
created_at
string · date-time

This represents the date when the timeoffpolicies was created

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • Keka
updated_at
string · date-time

This represents the date when the timeoffpolicies was updated

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • Workable
remote_data
object

Raw data returned from the remote API call.