Create Employee compensations
/unified/hris/employee_compensations
Query Parameters
Refer Specifying query parameters in Truto APIs
The company to use, referencing companies.id. Optional: when omitted the account's company is looked up automatically. The request fails if the account can see more than one company and none is given.
1 supported
Flat alternative to company.id.
1 supported
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
Salary only: gross amount in major units (Sesame grossSalary).
5 supported4 required
Not a unified field. Id of a compensation in Sesame's catalogue (GET /contract/v1/compensations). When set, the compensation is assigned to the employee's active salary instead of creating a salary; Sesame requires an active salary with the same period and currency, and refuses a compensation that is already assigned (409). Sesame answers the assignment with 204 and no body, so Truto reads the employee's assignments back to answer with the new record; if Sesame does not list it (a future-dated assignment, for example — undocumented), the answer carries the values that were sent, no id, and remote_data.truto_not_listed_by_sesame = true. The assignment was still created: read it later with employee_compensations.list.
1 supported
Not a unified field. Salary only, required by Sesame: contribution group id (GET /contract/v1/contribution-groups).
1 supported
Salary only: ISO 4217 currency code, for example EUR.
3 supported1 required
Salary only: comments.
4 supported
The employee (employees.id).
5 supported5 required
The unique identifier for employees
Flat alternative to employee.id.
1 supported
End date; only the date part is used.
3 supported
Represents why the compensation ended
1 supported
Salary only: how often it is paid (Sesame payPeriod, required by Sesame).
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_timedailyweeklybiweeklymonthlyannually+ 2 more
3 supported
dailyweeklybiweeklymonthlyannuallyNot a unified field. Salary only, required by Sesame: number of payments a year (for example 12 or 14).
1 supported
Salary only: the period the amount covers (Sesame grossPeriod): daily, monthly or annually. Defaults to annually, sent explicitly.
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_timehourlyweeklyannuallyhourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_timehourlydailyweeklybiweeklymonthlyannuallydailymonthlyannually+ 18 more
5 supported2 required
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_timehourlyweeklyannuallyhourlydailyweeklybiweeklymonthlyannuallydailymonthlyannuallyNot a unified field. Salary only, required by Sesame: whether the salary is prorated.
1 supported
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.
Start date; only the date part is used. Required for both salaries and assignments. Creating a salary makes Sesame close the employee's previous active salary automatically (its end date becomes the day before this start date); a salary starting on the same date as an existing one is refused (422 salary_same_start_date).
5 supported2 required
salary, or omit. Other types are refused for salaries; for a compensation assignment the type is not stored.
salaryhourlycommissionbonusequityhourlysalaryhourlysalarysalary
5 supported3 required
hourlysalaryhourlysalarysalaryResponse Body
The unique identifier for the compensation
5 supported
Represents the amount of the compensation. Can be a number or percentage.
5 supported
This represents the date when the compensation was created
3 supported
Represents the currency of the compensation
3 supported
The description of the compensation
4 supported
Employee associated with this compensation
5 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
5 supported
Raw data returned from the remote API call.
Represents the start date of the compensation
5 supported
Represents the status of the compensation
activeinactive
5 supported
The type of compensation
salaryhourlycommissionbonusequity
5 supported
This represents the date when the compensation was updated
3 supported
truto unified hris employeecompensations \
-m create \
-a '<integrated_account_id>' \
-b '{
"employee": {},
"amount": 0,
"type": "salary",
"period": "hourly",
"start_date": "your_start_date",
"currency": "your_currency",
"payment_frequency": "hourly",
"description": "your_description",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"employee_id": "your_employee_id",
"compensation_id": "your_compensation_id",
"payments_per_year": 0,
"contribution_group_id": "your_contribution_group_id",
"prorated": true,
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.create(
'hris',
'employeecompensations',
{
"employee": {},
"amount": 0,
"type": "salary",
"period": "hourly",
"start_date": "your_start_date",
"currency": "your_currency",
"payment_frequency": "hourly",
"description": "your_description",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"employee_id": "your_employee_id",
"compensation_id": "your_compensation_id",
"payments_per_year": 0,
"contribution_group_id": "your_contribution_group_id",
"prorated": true,
"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.create(
"hris",
"employeecompensations",
{
"employee": {},
"amount": 0,
"type": "salary",
"period": "hourly",
"start_date": "your_start_date",
"currency": "your_currency",
"payment_frequency": "hourly",
"description": "your_description",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"employee_id": "your_employee_id",
"compensation_id": "your_compensation_id",
"payments_per_year": 0,
"contribution_group_id": "your_contribution_group_id",
"prorated": True,
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X POST 'https://api.truto.one/unified/hris/employee_compensations?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{
"employee": {},
"amount": 0,
"type": "salary",
"period": "hourly",
"start_date": "your_start_date",
"currency": "your_currency",
"payment_frequency": "hourly",
"description": "your_description",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"employee_id": "your_employee_id",
"compensation_id": "your_compensation_id",
"payments_per_year": 0,
"contribution_group_id": "your_contribution_group_id",
"prorated": true,
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"employee": {},
"amount": 0,
"type": "salary",
"period": "hourly",
"start_date": "your_start_date",
"currency": "your_currency",
"payment_frequency": "hourly",
"description": "your_description",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"employee_id": "your_employee_id",
"compensation_id": "your_compensation_id",
"payments_per_year": 0,
"contribution_group_id": "your_contribution_group_id",
"prorated": true,
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/hris/employee_compensations?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/employee_compensations"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"employee": {},
"amount": 0,
"type": "salary",
"period": "hourly",
"start_date": "your_start_date",
"currency": "your_currency",
"payment_frequency": "hourly",
"description": "your_description",
"end_date": "your_end_date",
"end_reason": "your_end_reason",
"employee_id": "your_employee_id",
"compensation_id": "your_compensation_id",
"payments_per_year": 0,
"contribution_group_id": "your_contribution_group_id",
"prorated": True,
"remote_data": {}
}
response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())