Skip to content
GET /unified/hris/employee_compensations/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

employeeobject

Employee associated with this compensation

References: Employees → id
3 supported3 required3 notes
Omni HR
required

The employee (employees.id, the Omni user id) whose base salary record to read. 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).

Paychex
required

The employee (employees.id, Paychex workerId) the pay rate belongs to. Required: Paychex pay rates are addressed per worker.

Sesame
required

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.

idstring
required·

The unique identifier for employees

employee_idstring
3 supported3 notes
Omni HR
supported

Flat alternative to employee.id (same forms).

Paychex
supported

Flat alternative to employee.id.

Sesame
supported

Flat alternative to employee.id.

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). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. 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_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

Response Body

idstring
required·

The unique identifier for the compensation

6 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Omni HR
supported
Paychex
supported
Sesame
supported
amountnumber

Represents the amount of the compensation. Can be a number or percentage.

6 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Omni HR
supported
Paychex
supported
Sesame
supported
created_atstring · date-time

This represents the date when the compensation was created

4 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Sesame
supported
currencystring

Represents the currency of the compensation

5 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Omni HR
supported
Sesame
supported
descriptionstring

The description of the compensation

6 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Omni HR
supported
Paychex
supported
Sesame
supported
employeeobject

Employee associated with this compensation

References: Employees → id
6 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Omni HR
supported
Paychex
supported
Sesame
supported
idstring

The unique identifier for employees

end_datestring · date-time

Represents the end date of the compensation

4 supported
Deel
supported
Humaans
supported
Omni HR
supported
Sesame
supported
end_reasonstring

Represents why the compensation ended

1 supported
Humaans
supported
payment_frequencystring

Represents how often the compensation is paid

Possible values:
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
5 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Paychex
supported
Sesame
supported
periodstring

Represents the period of the compensation

Possible values:
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
6 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Omni HR
supported
Paychex
supported
Sesame
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_datestring · date-time

Represents the start date of the compensation

6 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Omni HR
supported
Paychex
supported
Sesame
supported
statusstring

Represents the status of the compensation

Possible values:
activeinactive
5 supported
Deel
supported
Humaans
supported
Omni HR
supported
Paychex
supported
Sesame
supported
typestring

The type of compensation

Possible values:
salaryhourlycommissionbonusequity
6 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Omni HR
supported
Paychex
supported
Sesame
supported
updated_atstring · date-time

This represents the date when the compensation was updated

4 supported
AlexisHR
supported
Deel
supported
Humaans
supported
Sesame
supported
truto unified hris employeecompensations '<resource_id>' \
  -m get \
  -a '<integrated_account_id>' \
  -o json
import Truto from '@truto/truto-ts-sdk';

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

const result = await truto.unifiedApi.get(
  '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.get(
        "hris",
        "employeecompensations",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X GET '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: 'GET',
  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.get(url, headers=headers, params=params)
print(response.json())