Appearance

Delete Timeoff requests ​

Endpoint ​

http
DELETE /unified/hris/timeoff_requests/{id}
Integrations supported
  • Factorial
  • HiBob
  • PeopleHR
  • Personio

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
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
employee
object

This represents the employee requesting time off.

Required in
  • HiBob
  • PeopleHR
id
string
REQUIRED · 

The unique identifier for employees

name
string

This represents the name of the employee.

start_time
string · date-time

This represents the start time of the time off request.

Required in
  • PeopleHR
end_time
string · date-time

This represents the end time of the time off request.

Required in
  • PeopleHR

Response Body ​

id
string
REQUIRED · 

The unique identifier for timeoffpolicies

Supported in
  • Factorial
  • PeopleHR
description
string

This represents the description of the time off request.

Supported in
  • Factorial
reason
object

This represents the reason of the time off request.

Supported in
  • 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.

Supported in
  • Factorial
  • PeopleHR
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.

status
string

This represents the status of the time off request.

Supported in
  • Factorial
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
amount
number

This represents the amount of the time off request.

Supported in
  • PeopleHR
timeoff_type
string

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

Supported in
  • Factorial
request_policy_type
string

This represents the request type of the time off request.

start_time
string · date-time

This represents the start time of the time off request.

Supported in
  • Factorial
  • PeopleHR
end_time
string · date-time

This represents the end time of the time off request.

Supported in
  • Factorial
  • PeopleHR
session
string

This represents the session of the time off request.

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

This represents the date when the timeoffpolicies was created

Supported in
  • Factorial
updated_at
string · date-time

This represents the date when the timeoffpolicies was updated

Supported in
  • Factorial
remote_data
object

Raw data returned from the remote API call.