BenefitSession

Represents information about an instance of a planned benefit delivery This object is available in API version 57.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. 

Important

Supported Calls

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

Fields

Field Details
BenefitScheduleId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The identifier of the benefit schedule that's associated with the benefit session.
This field is a relationship field.
Relationship Name
BenefitSchedule
Relationship Type
Master-Detail
Refers To
BenefitSchedule
EndDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The end date and time of the benefit session.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when the record was last viewed.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the benefit session.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the benefit session record owner.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
StartDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The start date and time of the benefit session.
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the benefit session.
Possible values are:
  • Cancelled
  • Completed
  • Postponed
  • Scheduled

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.

BenefitSessionFeed
Feed tracking is available for the object.
BenefitSessionHistory
History is available for tracked fields of the object.