Newer Version Available

This content describes an older version of this product. View Latest

EmpBenefitSummary

Represents statistics about benefits provided to employees and the usage of benefits. This object is available in API version 57.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
BenefitUsage
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of the benefit that's used by the employee.
Possible values are:
  • Entitled
  • Returned
  • Used
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the employee benefit statistics.
DisclsReportingPeriodId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique identifier of the reporting period.
This field is a relationship field.
Relationship Name
DisclsReportingPeriod
Relationship Type
Lookup
Refers To
DisclsReportingPeriod
EmployeeBenefitType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of benefit offered by the organization.
Possible values are:
  • Disability and Invalidity Coverage
  • Health Care
  • Life Insurance
  • Other
  • Parental Leave
  • Retirement Provision
  • Stock Ownership
EmployeeCount
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The number of employees receiving the benefit.
EmployeePercentage
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
The percentage of employees receiving the benefit.
EmploymentType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of employment.
Possible values are:
  • All
  • Full-Time
  • Full-Time Equivalent
  • Non-Employee
  • Non-Guaranteed Hours
  • Part-Time
  • Permanent
  • Temporary
IsEmployeeEligible
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the employee is eligible for the benefit (true) or not (false).
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Name of the record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user who owns this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PercentageCalcType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of calculation used to determine the percentage of employees who received the benefit.
Possible values are:
  • Retention
  • Return to Work
PrimaryLocation
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The primary location from where the organization operates.
SubsidiaryAccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account that's identified as a subsidiary company.
This field is a relationship field.
Relationship Name
SubsidiaryAccount
Relationship Type
Lookup
Refers To
Account