Terminate Employees

POST /unified/hris/employees/terminate

HiBob

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters

integrated_account_idstring · uuid

required·

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

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

truto_response_formatstring

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.
debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified

Possible values:

unifiedrawnormalizedstreamdebug

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

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

remote_queryRecord<string, any>

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_idstring

The employee id

1 supported1 required

HiBob

required

remote_dataRecord<string, any>

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.

termination_datestring · date-time

This represents the termination date

1 supported1 required

HiBob

required

termination_reasonstring

Represents the reason for termination

1 supported

HiBob

supported

termination_typestring

Represents the type of termination. If no clear mapping exists, then raw value is returned.

Possible values:

voluntarydismissedredundancyend_of_contractretirementmutual

1 supported

HiBob

supported

Response Body

idstring

required·

The unique identifier for employees

1 supported

HiBob

supported

avatarstring

This represents the avatar

1 supported

HiBob

supported

companyobject

This represents the company

References: Companies → id

1 supported

HiBob

supported

idstring

The unique identifier for companies

created_atstring · date-time

This represents the date when the Employee was created

1 supported

HiBob

supported

date_of_birthstring

This represents date of birth

emailsobject[]

The emails of the user

1 supported

HiBob

supported

emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

employee_numberstring

This represents the employee number

1 supported

HiBob

supported

employment_statusstring

This represents the employment status. If no clear mapping is available, then the raw value is returned.

Possible values:

activeinactivepending

employmentsobject[]

Represents a role or employment of the employee in the company

References: Employments → id

1 supported

HiBob

supported

idstring

required·

The unique identifier for employments

created_atstring · date-time

This represents the date when the employments was created

effective_datestring · date-time

Represents the effective date of the employment

employeeobject

Employee associated with this employment

1 property

idstring

The unique identifier for employees

employment_typestring

This represents the employment type

Possible values:

full_timepart_timecontractinternshiptemporarytraineevolunteerper_diem

end_datestring · date-time

Represents the end date of the employment

end_reasonstring

Represents why the employment ended

flsa_statusstring

This represents the flsa status

job_titlestring

Job title of the employee

pay_currencystring

This represents the pay currency

pay_frequencystring

This represents the pay frequency

pay_groupstring

This represents the pay group

pay_periodstring

This represents the pay period

pay_ratenumber

This represents the pay rate

updated_atstring · date-time

This represents the date when the employments was updated

etagstring

The unique identifier for the specific version of the resource.

ethnicitystring

This represent ethnicity

first_namestring

This represents the first name of the employee

1 supported

HiBob

supported

genderstring

This represents gender

groupsobject[]

This represents the groups

References: Groups → id

1 supported

HiBob

supported

idstring

The unique identifier for groups

namestring

Group's name

typestring

Type of the group. Some underlying providers use this to differentiate between in-built and user created groups.

home_locationobject[]

This represents the home location

References: Locations → id

citystring

The city of the home address

countrystring

The country of the home address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the home address

statestring

The state/province of the home address

street_1string

The first line of home address

street_2string

The second line of home address

job_titlestring

Job title of the employee

1 supported

HiBob

supported

last_namestring

This represents the last name of the employee

1 supported

HiBob

supported

managerobject

Represents the manager of the employee. Is also an employee.

1 supported

HiBob

supported

idstring

The unique identifier for employees

namestring

This represents the name of the employee

marital_statusstring

This represents marital status

middle_namestring

This represents the middle name of the employee

namestring

This represents the name of the employee

1 supported

HiBob

supported

pay_groupobject

This represents the pay group

References: PayGroups → id

idstring

The unique identifier for pay groups

phonesobject[]

The phones of the user

extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

remote_dataRecord<string, any>

Raw data returned from the remote API call.

ssnstring

This represents the ssn

start_datestring · date-time

This represents the start date

1 supported

HiBob

supported

tagsobject[]

The employee's tags

References: Tags → id

idstring

The tag's unique identifier

namestring

The tag's name

termination_datestring · date-time

This represents the termination date

1 supported

HiBob

supported

termination_reasonstring

Represents the reason for termination

1 supported

HiBob

supported

termination_typestring

Represents the type of termination. If no clear mapping exists, then raw value is returned.

Possible values:

voluntarydismissedredundancyend_of_contractretirementmutual

1 supported

HiBob

supported

updated_atstring · date-time

This represents the date when the Employee was updated

usernamestring

This represents the username

work_locationobject

This represents the work location

References: Locations → id

1 supported

HiBob

supported

citystring

The city of the work address

countrystring

The country of the work address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the work address

statestring

The state/province of the work address

street_1string

The first line of work address

street_2string

The second line of work address

truto unified hris employees \
  -m terminate \
  -a '<integrated_account_id>' \
  -o json

import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

// Custom method: terminate
const result = await truto.unifiedApi.terminate(
  'hris',
  'employees',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);

import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    # Custom method: terminate
    result = await truto_api.unified_api.terminate(
        "hris",
        "employees",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())

curl -X POST 'https://api.truto.one/unified/hris/employees/terminate?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "employee_id": "your_employee_id",
  "termination_date": "your_termination_date",
  "termination_type": "voluntary",
  "termination_reason": "your_termination_reason",
  "remote_data": {}
}'

const integratedAccountId = '<integrated_account_id>';

const body = {
  "employee_id": "your_employee_id",
  "termination_date": "your_termination_date",
  "termination_type": "voluntary",
  "termination_reason": "your_termination_reason",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/hris/employees/terminate?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.truto.one/unified/hris/employees/terminate"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "employee_id": "your_employee_id",
    "termination_date": "your_termination_date",
    "termination_type": "voluntary",
    "termination_reason": "your_termination_reason",
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())