Update 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
3 supported3 required3 notes
The employee (employees.id, the Omni user id) whose base salary record to change (Omni PATCH: only the fields sent change). Changes the employee's pay: base salary is Omni HR's payroll-module record (Payroll > Base Salary).. 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.
Required. The employee (employees.id): Sesame keeps salaries and assigned compensations per employee, so a request without it (or with several employees) is refused with a 400. The employee's assigned compensations are read with a second call (ListEmployeeCompensations), which Sesame answers with a 404 for an employee without an active salary. That call is allowed to fail: the salary history is still returned and the answer is marked is_partial_response, which is therefore also true for an employee who simply has no assigned compensation (Sesame gives Truto no way to tell the two apart). Accepts a plain value, a comma-separated list, repeated keys and [eq]/[in]; any other operator is refused (400) rather than dropped.
The unique identifier for employees
3 supported3 notes
Flat alternative to employee.id (same forms).
Flat alternative to employee.id.
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.
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.
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]=barRequest Body
Refer Writing data using Unified APIs
Read-only here. Sesame's salary update cannot change the amount (create a new salary) and an assignment takes its amount from the catalogue; sending a value different from the current one is refused (400) rather than silently ignored.
4 supported
Read-only here, like amount.
3 supported
Salaries only: comments (Sesame's UpdateSalary takes only endDate and comments). On a compensation assignment the description belongs to Sesame's catalogue and cannot be changed here.
4 supported
Employee associated with this compensation
4 supported
The unique identifier for employees
New end date; only the date part is used. The current end date is kept when omitted (it cannot be cleared through this call). This is the only way to close a salary or an assignment: status follows the dates.
3 supported
Represents why the compensation ended
1 supported
Read-only here, like amount.
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
3 supported
Read-only here, like amount.
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_timehourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_timehourlydailyweeklybiweeklymonthlyannually+ 12 more
4 supported
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_timehourlydailyweeklybiweeklymonthlyannuallyAny 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.
Compensation assignments only: new start date (salaries cannot move their start date; create a new salary instead).
4 supported
Read-only here: Sesame has no status field on a salary or an assignment — it follows start_date/end_date, so set end_date instead.
activeinactive
4 supported
Read-only here: a salary stays a salary and an assignment stays its catalogue compensation.
salaryhourlycommissionbonusequityhourlysalary
4 supported
hourlysalaryResponse Body
The unique identifier for the compensation
4 supported
Represents the amount of the compensation. Can be a number or percentage.
4 supported
This represents the date when the compensation was created
2 supported
Represents the currency of the compensation
3 supported
The description of the compensation
4 supported
Employee associated with this compensation
4 supported
The unique identifier for employees
Represents the end date of the compensation
3 supported
Represents why the compensation ended
1 supported
Represents how often the compensation is paid
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
3 supported
Represents the period of the compensation
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
4 supported
Raw data returned from the remote API call.
Represents the start date of the compensation
4 supported
Represents the status of the compensation
activeinactive
4 supported
The type of compensation
salaryhourlycommissionbonusequity
4 supported
This represents the date when the compensation was updated
2 supported
truto unified hris employeecompensations '<resource_id>' \
-m update \
-a '<integrated_account_id>' \
-b '{
"employee": {},
"type": "salary",
"amount": 0,
"currency": "your_currency",
"period": "hourly",
"payment_frequency": "hourly",
"description": "your_description",
"start_date": "your_start_date",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"status": "active",
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.update(
'hris',
'employeecompensations',
'<resource_id>',
{
"employee": {},
"type": "salary",
"amount": 0,
"currency": "your_currency",
"period": "hourly",
"payment_frequency": "hourly",
"description": "your_description",
"start_date": "your_start_date",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"status": "active",
"remote_data": {}
},
{ 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.update(
"hris",
"employeecompensations",
"<resource_id>",
{
"employee": {},
"type": "salary",
"amount": 0,
"currency": "your_currency",
"period": "hourly",
"payment_frequency": "hourly",
"description": "your_description",
"start_date": "your_start_date",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"status": "active",
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X PATCH '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' \
-d '{
"employee": {},
"type": "salary",
"amount": 0,
"currency": "your_currency",
"period": "hourly",
"payment_frequency": "hourly",
"description": "your_description",
"start_date": "your_start_date",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"status": "active",
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"employee": {},
"type": "salary",
"amount": 0,
"currency": "your_currency",
"period": "hourly",
"payment_frequency": "hourly",
"description": "your_description",
"start_date": "your_start_date",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"status": "active",
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/hris/employee_compensations/{id}?integrated_account_id=${integratedAccountId}`, {
method: 'PATCH',
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/employee_compensations/{id}"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"employee": {},
"type": "salary",
"amount": 0,
"currency": "your_currency",
"period": "hourly",
"payment_frequency": "hourly",
"description": "your_description",
"start_date": "your_start_date",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"status": "active",
"remote_data": {}
}
response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())