InsBnftEligDefinition

Represents employee eligibility information for a benefit that's offered by an employer. This object is available in API version 61 and later.

Supported Calls

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

Fields

AccountId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The client account that's associated with the rule

    This field is a relationship field.

  • Relationship Name: Account
  • Relationship Type: Master-detail
  • Refers To: Account (the master object)

CurrencyIsoCode

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: If multiple currencies are enabled, this field contains the currency ISO code associated with the record.
  • Default value: USD
  • Possible values:
    • EUR—Euro
    • GBP—British Pound
    • USD—U.S. Dollar

EffectiveFromDate

  • Type: date
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The date from when the eligibility rule is active.

EffectiveToDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date on which the eligibility rule becomes inactive.

EligibilityInitiationType

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Specifies when the benefit coverage of the employee starts.
  • Possible values:
    • Date of Hire
    • First of the Month Following 30 Days
    • First of the Month Following 60 Days
    • First of the Month Following Date of Hire
    • Hire Month + 1 Month
    • Hire Month start
    • Year Start

EligibilityTerminationType

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Specifies when the benefit coverage of the employee ends.
  • Possible values:
    • Date of Termination
    • End of Month following Date of Termination
    • Termination Month + 1 month end
    • Termination Month End
    • Year End

EmployeeType

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Specifies the type of employee the rule applies to.
  • Possible values:
    • Contract Based
    • Full Time
    • Full-Time 30 Hours per Week
    • Full-Time 32 Hours per Week
    • Part Time

IsChildEligible

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the employee's children are eligible for the coverage or not.
  • Default value: false

IsPartnerEligible

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the employee's spouse or domestic partner is eligible for the coverage or not.
  • Default value: false

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The name of the rule.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

InsBnftEligDefinitionChangeEvent
Change events are available for the object in API version 62.0 and later.
InsBnftEligDefinitionHistory
History is available for tracked fields of the object.