Salesforce Docs Portal

Benefit

Represents information about benefits associated with the financial assistance program. Benefits are mapped to the members based on the program rules. This object is available in API version 51.0 and later.

Supported Calls

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

Fields

BenefitTypeId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: ID of the benefit type.

    This field is a relationship field.

  • Relationship Name: BenefitType
  • Relationship Type: Lookup
  • Refers To: BenefitType

BudgetAmountUsed

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The budget amount used by an employee after enrolling in a corresponding program.

EndDateTime

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The end date of the benefit.

EnrolleeAmountLimit

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The amount limit allocated to enrollee for a corresponding program.

EnrolleeLimitFrequency

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The assigned frequency for an enrollee limit for a corresponding program.
  • Possible values:
    • Monthly
    • Monthly, Yearly , Annual, Weekly, Quarterly
    • Yearly

EnrolleeTrxnAmountLimit

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The enrollee transaction amount limit for a corresponding program.

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Required. Indicates whether the program benefit is active.

MaxBenefitAmount

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The maximum amount that can be disbursed for a period.

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the benefit.

PayoutFrequency

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Possible values:
    • Annual
    • BiWeekly - Bi-Weekly
    • Monthly
    • OnDemand - On-Demand
    • Quaterly
    • Weekly

ProgramId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The identifier of the program that's associated with the benefit.

    This field is a relationship field.