List 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.
2 supported
Flat alternative to company.id.
1 supported
Employee associated with this compensation
18 supported10 required14 notes
The employee (employees.id) whose wages to list. Required: 7shifts only lists wages per user.
Employee associated with this compensation
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.
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).
The employee (employees.id, Paychex workerId) whose pay rates to list. Required: Paychex only lists pay rates per worker.
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.
Employee associated with this compensation
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.
Filter by employee, referencing employees.id (the Deel HRIS profile id).
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.
Filter by employee, referencing employees.id.
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.
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.
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.
The unique identifier for employees
14 supported2 required14 notes
The employee ID you want to get the compensations for
The employee ID you want to get the compensations for
Flat alternative to employee.id.
Flat alternative to employee.id.
Flat alternative to employee.id (same values and forms).
Filter by the employee's unified id. Prefer the nested employee object form; this is a flat fallback.
Flat alternative to employee.id.
Flat alternative to employee.id.
Flat alternative to employee.id (same forms).
Flat alternative to employee.id.
Flat alternative to employee.id (same forms).
Flat alternative to employee.id.
Flat alternative to employee.id.
Flat alternative to employee.id.
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
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
Represents the currency of the compensation
1 supported
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
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
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.
idIgnores the limit query parameter.
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
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.
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.
List of Employee compensations
The unique identifier for the compensation
21 supported
Represents the amount of the compensation. Can be a number or percentage.
21 supported
This represents the date when the compensation was created
9 supported
Represents the currency of the compensation
15 supported
The description of the compensation
14 supported
Employee associated with this compensation
20 supported
1 property
The unique identifier for employees
Represents the end date of the compensation
14 supported
Represents why the compensation ended
2 supported
Represents how often the compensation is paid
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
15 supported
Represents the period of the compensation
hourlydailyweeklybiweeklymonthlyquarterlyannuallyfixedone_time
17 supported
Raw data returned from the remote API call.
Represents the start date of the compensation
21 supported
Represents the status of the compensation
activeinactive
12 supported
The type of compensation
salaryhourlycommissionbonusequity
20 supported
This represents the date when the compensation was updated
9 supported
truto unified hris employeecompensations \
-a '<integrated_account_id>' \
-o jsonimport 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())