Delete Employee compensations
/unified/hris/employee_compensations/{id}
Path Parameters
The ID of the resource.
23423523Query Parameters
Refer Specifying query parameters in Truto APIs
Employee associated with this compensation
2 supported2 required2 notes
The employee (employees.id, the Omni user id) whose base salary record to delete. Changes the employee's pay: base salary is Omni HR's payroll-module record (Payroll > Base Salary). Omni documents deletes as often soft: the record may be deactivated and still returned by later lists as inactive. Required: Omni HR only exposes this per employee (the user id is part of the path). Exactly one employee: employee_id=, employee[id]=, [eq] or [in] with one id, or a one-element array. Several different ids, any other operator or a non-integer id is refused with a 400 (Omni HR has no multi-employee endpoint).
The employee (employees.id, Paychex workerId) the pay rate belongs to.
The unique identifier for employees
2 supported2 notes
Flat alternative to employee.id (same forms).
Flat alternative to employee.id.
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
The unique identifier for the compensation
Represents the amount of the compensation. Can be a number or percentage.
This represents the date when the compensation was created
Represents the currency of the compensation
The description of the compensation
Employee associated with this compensation
The unique identifier for employees
Represents the end date of the compensation
Represents why the compensation ended
Represents how often the compensation is paid
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
Represents the period of the compensation
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
Raw data returned from the remote API call.
Represents the start date of the compensation
Represents the status of the compensation
activeinactive
The type of compensation
salaryhourlycommissionbonusequity
This represents the date when the compensation was updated
truto unified hris employeecompensations '<resource_id>' \
-m delete \
-a '<integrated_account_id>'import Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.delete(
'hris',
'employeecompensations',
'<resource_id>',
{ 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():
result = await truto_api.unified_api.delete(
"hris",
"employeecompensations",
"<resource_id>",
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X DELETE 'https://api.truto.one/unified/hris/employee_compensations/{id}?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/hris/employee_compensations/{id}?integrated_account_id=${integratedAccountId}`, {
method: 'DELETE',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/hris/employee_compensations/{id}"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.delete(url, headers=headers, params=params)
print(response.json())