BenefitSession

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

Supported Calls

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

Special Access Rules

This object is available if Program and Benefit Management is enabled in your org.

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
Lookup
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 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
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
ID of the owner of this object.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PractitionerFacilityId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The practitioner facility associated with the benefit session record.
Available in API version 59.0 and later.
This field is a relationship field.
Relationship Name
PractitionerFacility
Relationship Type
Lookup
Refers To
HealthcarePractitionerFacility
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.