Skip to content
GET /unified/hris/employee_compensations

Query Parameters

Refer Specifying query parameters in Truto APIs

companystring

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.

2 supported
7shifts
supported
Kenjo
supported
idstring
company_idstring

Flat alternative to company.id.

1 supported
7shifts
supported
employeeobject

Employee associated with this compensation

References: Employees → id
18 supported10 required14 notes
7shifts
required

The employee (employees.id) whose wages to list. Required: 7shifts only lists wages per user.

Breathe
required

Employee associated with this compensation

Humi by Employment Hero
required

The employee (employees.id) whose salaries to list. Required: Humi only returns salaries per employee, with GET /v1/employees/{id}?include=salaries (the company-wide employee index cannot carry them through this connector). One record per salary linked to the employee; an unknown id fails with Humi's error. Accepted forms: employee[id]=, employee_id=, a repeated parameter or employee[id][]=, employee[id][eq]= and employee[id][in]=; a blank value is ignored. More than one id, or any other form is refused with a 400 instead of being ignored. employee[id][ne] is refused too: Humi reads one employee or the whole company, so excluding an employee would mean reading every employee's data, which this mapping will not do silently.

Omni HR
required

The employee (employees.id, the Omni user id) whose base salary records to list. 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) whose pay rates to list. Required: Paychex only lists pay rates per worker.

PeopleForce
required
PeopleHR
required
Remote
required

The employee (employees.id, a Remote employment id). Required: Remote only exposes this data per employment. Returns one record per contract salary plus one per incentive (bonus, commission); only the first 100 incentives Remote returns for the employment are included, later ones are not read.

Rippling
required

Employee associated with this compensation

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.

Deel
supported

Filter by employee, referencing employees.id (the Deel HRIS profile id).

HR WORKS
supported

Only this employee's wage payments (employees.id, the HR WORKS person uuid). Uses GET /v3/persons/{uuid}/wage-payments instead of the company-wide list. An id HR WORKS does not know returns an empty list. Exactly one id can be requested: HR WORKS has no multi-person wage-payment endpoint, so several ids (repeated, comma-joined or [in]) are refused with a 400 rather than silently reduced to one. Any other filter form is refused as well.

Humaans
supported

Filter by employee, referencing employees.id.

Justworks
supported

Only these employees (employees.id, Justworks member ids). One id is read directly with GET /v1/members/{member_id}, and a member that does not exist returns Justworks' 404. Justworks has no member-id filter on its list, so two or more ids are read by paging through GET /v1/members and keeping exactly the members you asked for; a page can then come back with fewer records than the limit, or none, and still have a next_cursor. Without the filter, every member is read page by page. When both employee[id] and employee_id are given, both must hold (the ids are intersected), and an intersection with nothing in it returns an empty list without calling Justworks. Accepts one value, a comma-separated list, a repeated employee_id[]=… (or employee_id=… twice) and employee_id[eq]= / employee_id[in]=. A form that cannot be read (another operator, a nested value) is refused with a 400 that names the filter: it is never treated as no filter, which would return everything. Vendors and third-party admins (member types vendor and third_party_admin) are not workers and have no records here, with or without this filter; a member whose type is not visible (no member.detail:read or member.employment:read) is included. One record per pay row of the member (pay_history plus current_pay), which needs the member.pay:read scope: without it Justworks omits them and the list is empty. Each row ends where the next row takes effect; the last row ends on the member's termination date.

Paylocity
supported

Only return the compensations of these employees (employees.id, the Paylocity Employee ID): one value, a comma-joined list, repeated values (employee_id[] or employee_id=a&employee_id=b), [eq] or [in]; also as employee_id or employee=. Any other form is refused with a 400 before Paylocity is called. Paylocity's batch employee endpoint has no employee filter, so ONE employee is read directly (GET employee; for an unknown employee Paylocity's error is returned as is, and an empty answer gives an empty list), while several employees are found by reading every employee page by page and leaving the others out: pages can then be empty while next_cursor is still set, so keep paging. Without it every employee is read page by page, terminated employees included (activeOnly=false is sent: Paylocity documents no default). A page whose employees have no pay data is empty while next_cursor is still set: keep paging.

UKG Dimensions
supported

Return only these employees' records (employees.id; at most 100, UKG's own limit for one read). Without it every person is paged through (100 per page) and each page costs one extra call to UKG's Retrieve Persons operation. Accepts one value, several comma-separated, a repeated key (x[]=a&x[]=b) or an eq/in filter; a filter form UKG cannot express is refused with 400 rather than ignored.

AlexisHR
supported
Kenjo
supported
idstring
required·

The unique identifier for employees

employee_idstring
14 supported2 required14 notes
greytHR
required

The employee ID you want to get the compensations for

HiBob
required

The employee ID you want to get the compensations for

7shifts
supported

Flat alternative to employee.id.

Deel
supported

Flat alternative to employee.id.

HR WORKS
supported

Flat alternative to employee.id (same values and forms).

Humaans
supported

Filter by the employee's unified id. Prefer the nested employee object form; this is a flat fallback.

Humi by Employment Hero
supported

Flat alternative to employee.id.

Justworks
supported

Flat alternative to employee.id.

Omni HR
supported

Flat alternative to employee.id (same forms).

Paychex
supported

Flat alternative to employee.id.

Paylocity
supported

Flat alternative to employee.id (same forms).

Remote
supported

Flat alternative to employee.id.

Sesame
supported

Flat alternative to employee.id.

UKG Dimensions
supported

Flat alternative to employee.id.

created_atstring · date-time

Filter by this timestamp. Accepts either a plain ISO date-time string (implies >=), or an object with gt/gte/lt/lte keys for a range.

1 supported
Humaans
supported
updated_atstring · date-time

Filter by this timestamp. Accepts either a plain ISO date-time string (implies >=), or an object with gt/gte/lt/lte keys for a range.

1 supported
Humaans
supported
currencystring

Represents the currency of the compensation

1 supported
Kenjo
supported
include_historicalboolean

true also returns historical (ended) base-salary records (Omni show_historical=true). By default Omni returns only current records. true, false or [eq]; any other value is refused with a 400 rather than read as false.

1 supported
Omni HR
supported
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_key_bystring

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

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

debugobject

Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.

data
isEmptyResultboolean
isLoopingboolean
nextCursorstring
requestOptionsRecord<string, any>
requestUrlstring
responseHeadersRecord<string, any>
resultCountnumber
next_cursorstring

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

resultobject[]

List of Employee compensations

idstring
required·

The unique identifier for the compensation

21 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Deel
supported
Factorial
supported
greytHR
supported
HiBob
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
Justworks
supported
Kenjo
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
amountnumber

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

21 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Deel
supported
Factorial
supported
greytHR
supported
HiBob
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
Justworks
supported
Kenjo
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
created_atstring · date-time

This represents the date when the compensation was created

9 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
HiBob
supported
Humaans
supported
Humi by Employment Hero
supported
PeopleForce
supported
Rippling
supported
Sesame
supported
currencystring

Represents the currency of the compensation

15 supported
AlexisHR
supported
Deel
supported
greytHR
supported
HiBob
supported
HR WORKS
supported
Humaans
supported
Justworks
supported
Kenjo
supported
Omni HR
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
descriptionstring

The description of the compensation

14 supported
AlexisHR
supported
Deel
supported
Factorial
supported
greytHR
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Sesame
supported
employeeobject

Employee associated with this compensation

References: Employees → id
20 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Deel
supported
greytHR
supported
HiBob
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
Justworks
supported
Kenjo
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
1 property
idstring

The unique identifier for employees

end_datestring · date-time

Represents the end date of the compensation

14 supported
Breathe
supported
Deel
supported
greytHR
supported
HiBob
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
Justworks
supported
Kenjo
supported
Omni HR
supported
Paylocity
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
end_reasonstring

Represents why the compensation ended

2 supported
Humaans
supported
Paylocity
supported
payment_frequencystring

Represents how often the compensation is paid

Possible values:
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
15 supported
AlexisHR
supported
Breathe
supported
Factorial
supported
HiBob
supported
HR WORKS
supported
Humaans
supported
Justworks
supported
Kenjo
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Rippling
supported
Sesame
supported
periodstring

Represents the period of the compensation

Possible values:
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
17 supported
7shifts
supported
AlexisHR
supported
Deel
supported
HiBob
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
Justworks
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_datestring · date-time

Represents the start date of the compensation

21 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Deel
supported
Factorial
supported
greytHR
supported
HiBob
supported
HR WORKS
supported
Humaans
supported
Humi by Employment Hero
supported
Justworks
supported
Kenjo
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
statusstring

Represents the status of the compensation

Possible values:
activeinactive
12 supported
7shifts
supported
Deel
supported
HiBob
supported
Humaans
supported
Humi by Employment Hero
supported
Justworks
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
Remote
supported
Sesame
supported
UKG Dimensions
supported
typestring

The type of compensation

Possible values:
salaryhourlycommissionbonusequity
20 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
Deel
supported
Factorial
supported
greytHR
supported
HiBob
supported
Humaans
supported
Humi by Employment Hero
supported
Justworks
supported
Kenjo
supported
Omni HR
supported
Paychex
supported
Paylocity
supported
PeopleForce
supported
PeopleHR
supported
Remote
supported
Rippling
supported
Sesame
supported
UKG Dimensions
supported
updated_atstring · date-time

This represents the date when the compensation was updated

9 supported
7shifts
supported
AlexisHR
supported
Breathe
supported
HiBob
supported
Humaans
supported
Humi by Employment Hero
supported
PeopleForce
supported
Rippling
supported
Sesame
supported
truto unified hris employeecompensations \
  -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.list(
  'hris',
  'employeecompensations',
  { 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():
    async for item in truto_api.unified_api.list(
        "hris",
        "employeecompensations",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())
curl -X GET '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'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/hris/employee_compensations?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"
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())