List Employee compensations ​
Endpoint ​
http
GET /unified/hris/employee_compensations
Integrations supported
- greytHR
- HiBob
- Humaans
Query parameters ​
integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example:
62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
- greytHR
- HiBob
- Humaans
type
string
The type of compensation
All possible enum values:
salary
hourly
commission
bonus
equity
Supported in
- greytHR
- HiBob
- Humaans
description
string
The description of the compensation
Supported in
- greytHR
employee
string
Unique identifier of the employee
Supported in
- greytHR
- HiBob
- Humaans
amount
number
Represents the amount of the compensation. Can be a number or percentage.
Supported in
- greytHR
- HiBob
- Humaans
currency
string
Represents the currency of the compensation
Supported in
- greytHR
- HiBob
- 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
- HiBob
- 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
- HiBob
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
- greytHR
- HiBob
- Humaans
end_date
string · date-time
Represents the end date of the compensation
Supported in
- greytHR
- HiBob
- Humaans
end_reason
string
Represents why the compensation ended
Supported in
- Humaans
created_at
string
This represents the date when the compensation was created
Supported in
- HiBob
- Humaans
updated_at
string
This represents the date when the compensation was updated
Supported in
- 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.