BenefitSchedule

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

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: Master-Detail
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.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

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.