Appearance

Get Employee compensations ​

Endpoint ​

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

Path parameters ​

id
string
REQUIRED · The ID of the resource.
Example: 23423523

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

Response Body ​

id
string
REQUIRED · The unique identifier for the compensation
Supported in
  • Humaans
type
string
The type of compensation
All possible enum values:
  • salary
  • hourly
  • commission
  • bonus
  • equity
Supported in
  • Humaans
description
string
The description of the compensation
employee
string
Unique identifier of the employee
Supported in
  • Humaans
amount
number
Represents the amount of the compensation. Can be a number or percentage.
Supported in
  • Humaans
currency
string
Represents the currency of the compensation
Supported in
  • 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
  • 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
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
  • 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
This represents the date when the compensation was created
Supported in
  • Humaans
updated_at
string
This represents the date when the compensation was updated
Supported in
  • Humaans
remote_data
object
Raw data returned from the remote API call.