Skip to content

Benefits Object

Relationships

Schema relationships 
graph LR
    Benefits -->|"employee"| Employees
    Benefits -->|"company_benefit"| CompanyBenefits

Properties

idstring
required·

The unique identifier for benefits

company_benefitobject
References: CompanyBenefits → id
descriptionstring

This represents the description of the company benefit

idstring

The unique identifier for company benefits

namestring

This represents the name of the company benefit

company_contributionstring

This represents the company contribution

created_atstring · date-time

This represents the date when the benefits was created

currencystring

This represents the currency in which the contribution is made

employeeobject

Employee associated with this benefit

References: Employees → id
idstring

The unique identifier for employees

namestring

This represents the name of the employee

employee_contributionstring

This represents the employee contribution

end_datestring · date-time

This represents the end date of the benefit

namestring

The name of the benefit

provider_namestring

This represents the provider name

remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_datestring · date-time

This represents the start date of the benefit

statusstring

This represents the status of the benefit

updated_atstring · date-time

This represents the date when the benefits was updated