Appearance

Terminate Employees ​

Endpoint ​

http
POST /unified/hris/employees/terminate
Integrations supported
  • HiBob

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Request Body ​

Refer Writing data using Unified APIs

employee_id
string
The employee id
Required in
  • HiBob
termination_date
string
This represents the termination date
Required in
  • HiBob
termination_type
string
Represents the type of termination. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • voluntary
  • dismissed
  • redundancy
  • end_of_contract
  • retirement
  • mutual
Supported in
  • HiBob
termination_reason
string
Represents the reason for termination
Supported in
  • HiBob
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 employees
Supported in
  • HiBob
employee_number
string
This represents the employee number
Supported in
  • HiBob
company
object
This represents the company
Supported in
  • HiBob
id
string
The unique identifier for companies
first_name
string
This represents the first name of the employee
Supported in
  • HiBob
last_name
string
This represents the last name of the employee
Supported in
  • HiBob
name
string
This represents the name of the employee
Supported in
  • HiBob
username
string
This represents the username
groups
object[]
This represents the groups
Supported in
  • HiBob
id
string
The unique identifier for groups
name
string
Group's name
type
string
Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.
emails
object[]
The emails of the user
Supported in
  • HiBob
email
string
The email address
type
string
The type of email address
is_primary
boolean
Whether the email address is primary
phones
object[]
The phones of the user
number
string
The phone number
type
string
The type of phone number
employments
object[]
Represents a role or employment of the employee in the company
Supported in
  • HiBob
id
string
REQUIRED · The unique identifier for employments
employee
object
Employee associated with this employment
id
string
The unique identifier for employees
job_title
string
Job title of the employee
pay_rate
number
This represents the pay rate
pay_period
string
This represents the pay period
pay_frequency
string
This represents the pay frequency
pay_currency
string
This represents the pay currency
pay_group
string
This represents the pay group
flsa_status
string
This represents the flsa status
effective_date
string · date-time
Represents the effective date of the employment
end_date
string · date-time
Represents the end date of the employment
employment_type
string
This represents the employment type
All possible enum values:
  • full_time
  • part_time
  • contract
  • internship
  • temporary
  • trainee
  • volunteer
  • per_diem
end_reason
string
Represents why the employment ended
created_at
string
This represents the date when the employments was created
updated_at
string
This represents the date when the employments was updated
home_location
object[]
This represents the home location
id
string
The unique identifier for locations
name
string
This represents the name of the location
street_1
string
The first line of home address
street_2
string
The second line of home address
city
string
The city of the home address
state
string
The state/province of the home address
postal_code
string
The postal code of the home address
country
string
The country of the home address
work_location
object
This represents the work location
Supported in
  • HiBob
id
string
The unique identifier for locations
name
string
This represents the name of the location
street_1
string
The first line of work address
street_2
string
The second line of work address
city
string
The city of the work address
state
string
The state/province of the work address
postal_code
string
The postal code of the work address
country
string
The country of the work address
manager
object
Represents the manager of the employee. Is also an employee.
Supported in
  • HiBob
id
string
The unique identifier for employees
name
string
This represents the name of the employee
pay_group
object
This represents the pay group
id
string
The unique identifier for pay groups
ssn
string
This represents the ssn
gender
string
This represents gender
ethnicity
string
This represent ethnicity
marital_status
string
This represents marital status
date_of_birth
string
This represents date of birth
start_date
string
This represents the start date
Supported in
  • HiBob
employment_status
string
This represents the employment status. If no clear mapping is available, then the raw value is returned.
All possible enum values:
  • active
  • inactive
termination_date
string
This represents the termination date
Supported in
  • HiBob
termination_type
string
Represents the type of termination. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • voluntary
  • dismissed
  • redundancy
  • end_of_contract
  • retirement
  • mutual
Supported in
  • HiBob
termination_reason
string
Represents the reason for termination
Supported in
  • HiBob
avatar
string
This represents the avatar
Supported in
  • HiBob
created_at
string
This represents the date when the Employee was created
Supported in
  • HiBob
updated_at
string
This represents the date when the Employee was updated
remote_data
object
Raw data returned from the remote API call.