BenefitSchedule

Represents information about the plan for delivering the benefit. 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()

Fields

Field Details
ApprovalStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the approval status of the benefit schedule. Available in API version 61.0 and later.
Possible values are:
  • Approved
  • In Review
  • Not Applicable
  • Pending
  • Rejected
BenefitId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The identifier of the benefit that's associated with the schedule.
This field is a relationship field.
Relationship Name
Benefit
Relationship Type
Lookup
Refers To
Benefit
DefaultBenefitQuantity
Type
double
Properties
Create, Filter, Sort, Update
Description
The default quantity of benefit that's provided within a session of benefit schedule.
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
The description of the benefit schedule.
FirstSessionEndDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time when the first session ends in the benefit schedule.
FirstSessionStartDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time when the first session begins in the benefit schedule.
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.
MaximumParticipantCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum number of participants in a session.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the benefit schedule.
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

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.

BenefitScheduleFeed
Feed tracking is available for the object.
BenefitScheduleHistory
History is available for tracked fields of the object.