Newer Version Available

This content describes an older version of this product. View Latest

BenefitSchedule

Represents information about the plan for delivering the benefit. This object is available in API version 57.0 and later.

Supported Calls

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

Fields

Field Details
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, 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.
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.