Skip to content

Benefits Object ​



id
string
REQUIRED · 

The unique identifier for benefits

name
string

The name of the benefit

employee
object

Employee associated with this benefit

References: Employees → id
id
string

The unique identifier for employees

name
string

This represents the name of the employee

provider_name
string

This represents the provider name

company_benefit
object
References: CompanyBenefits → id
id
string

The unique identifier for company benefits

name
string

This represents the name of the company benefit

description
string

This represents the description of the company benefit

employee_contribution
string

This represents the employee contribution

company_contribution
string

This represents the company contribution

currency
string

This represents the currency in which the contribution is made

start_date
string · date-time

This represents the start date of the benefit

end_date
string · date-time

This represents the end date of the benefit

status
string

This represents the status of the benefit

created_at
string · date-time

This represents the date when the benefits was created

updated_at
string · date-time

This represents the date when the benefits was updated

remote_data
object

Raw data returned from the remote API call.