Appearance

EmployeeCompensations Object ​


id
string
REQUIRED · The unique identifier for the compensation
type
string
The type of compensation
All possible enum values:
  • salary
  • hourly
  • commission
  • bonus
  • equity
description
string
The description of the compensation
employee
object
Employee associated with this compensation
id
string
The unique identifier for employees
amount
number
Represents the amount of the compensation. Can be a number or percentage.
currency
string
Represents the currency of the compensation
period
string
Represents the period of the compensation
All possible enum values:
  • hourly
  • daily
  • weekly
  • biweekly
  • monthly
  • quarterly
  • annually
  • fixed
  • one_time
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
end_date
string · date-time
Represents the end date of the compensation
end_reason
string
Represents why the compensation ended
created_at
string · date-time
This represents the date when the compensation was created
updated_at
string · date-time
This represents the date when the compensation was updated
remote_data
object
Raw data returned from the remote API call.