Appearance

Get Employee compensations ​

Endpoint ​

http
GET /unified/hris/employee_compensations/{id}
Integrations supported
  • AlexisHR
  • Humaans

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

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). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

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 ​

id
string
REQUIRED · 

The unique identifier for the compensation

Supported in
  • AlexisHR
  • Humaans
type
string

The type of compensation

All possible enum values:
  • salary
  • hourly
  • commission
  • bonus
  • equity
Supported in
  • AlexisHR
  • Humaans
description
string

The description of the compensation

Supported in
  • AlexisHR
employee
object

Employee associated with this compensation

References: Employees → id
Supported in
  • AlexisHR
  • Humaans
id
string

The unique identifier for employees

amount
number

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

Supported in
  • AlexisHR
  • Humaans
currency
string

Represents the currency of the compensation

Supported in
  • AlexisHR
  • Humaans
period
string

Represents the period of the compensation

All possible enum values:
  • hourly
  • daily
  • weekly
  • biweekly
  • monthly
  • quarterly
  • annually
  • fixed
  • one_time
Supported in
  • AlexisHR
  • Humaans
payment_frequency
string

Represents how often the compensation is paid

All possible enum values:
  • hourly
  • daily
  • weekly
  • biweekly
  • monthly
  • quarterly
  • annually
  • fixed
  • one_time
Supported in
  • AlexisHR
status
string

Represents the status of the compensation

All possible enum values:
  • active
  • inactive
start_date
string · date-time

Represents the start date of the compensation

Supported in
  • AlexisHR
  • Humaans
end_date
string · date-time

Represents the end date of the compensation

Supported in
  • Humaans
end_reason
string

Represents why the compensation ended

Supported in
  • Humaans
created_at
string · date-time

This represents the date when the compensation was created

Supported in
  • AlexisHR
  • Humaans
updated_at
string · date-time

This represents the date when the compensation was updated

Supported in
  • AlexisHR
  • Humaans
remote_data
object

Raw data returned from the remote API call.