Appearance

List Employee compensations ​

Endpoint ​

http
GET /unified/hris/employee_compensations
Integrations supported
  • AlexisHR
  • Breathe
  • Factorial
  • greytHR
  • HiBob
  • Humaans
  • Kenjo
  • PeopleHR

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

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_limit
boolean

Ignores the limit query parameter.

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
employee
object

Employee associated with this compensation

Required in
  • Breathe
  • PeopleHR
Supported in
  • AlexisHR
  • Kenjo
id
string

The unique identifier for employees

company
string
Supported in
  • Kenjo
id
string
currency
string

Represents the currency of the compensation

Supported in
  • Kenjo
employee_id
string

The employee ID you want to get the compensations for

Required in
  • greytHR
  • HiBob
Supported in
  • Humaans

Response Body ​

result
object[]

List of Employee compensations

id
string
REQUIRED · 

The unique identifier for the compensation

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • greytHR
  • HiBob
  • Humaans
  • Kenjo
  • PeopleHR
type
string

The type of compensation

All possible enum values:
  • salary
  • hourly
  • commission
  • bonus
  • equity
Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • greytHR
  • HiBob
  • Humaans
  • Kenjo
  • PeopleHR
description
string

The description of the compensation

Supported in
  • AlexisHR
  • Factorial
  • greytHR
  • PeopleHR
employee
object

Employee associated with this compensation

Supported in
  • AlexisHR
  • Breathe
  • greytHR
  • HiBob
  • Humaans
  • Kenjo
  • PeopleHR
id
string

The unique identifier for employees

amount
number

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

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • greytHR
  • HiBob
  • Humaans
  • Kenjo
  • PeopleHR
currency
string

Represents the currency of the compensation

Supported in
  • AlexisHR
  • greytHR
  • HiBob
  • Humaans
  • Kenjo
  • PeopleHR
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
  • HiBob
  • Humaans
  • PeopleHR
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
  • Breathe
  • Factorial
  • HiBob
  • Kenjo
  • PeopleHR
status
string

Represents the status of the compensation

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

Represents the start date of the compensation

Supported in
  • AlexisHR
  • Breathe
  • Factorial
  • greytHR
  • HiBob
  • Humaans
  • Kenjo
  • PeopleHR
end_date
string · date-time

Represents the end date of the compensation

Supported in
  • Breathe
  • greytHR
  • HiBob
  • Humaans
  • Kenjo
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
  • Breathe
  • HiBob
  • Humaans
updated_at
string · date-time

This represents the date when the compensation was updated

Supported in
  • AlexisHR
  • Breathe
  • HiBob
  • Humaans
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

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.