Benefit

Represents information about benefits associated with a program. This object is available with Program Management 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

BenefitManagerId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The person in charge of the benefit.

This field is a relationship field.
Relationship Name: BenefitManager
Relationship Type: Lookup
Refers To: User

BenefitStatus

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Specifies the status of the benefit.
Default value: Active
Possible values:
- Active
- Cancelled
- Completed
- Planned

BenefitTypeId

Type: reference
Properties: Create, Filter, Group, Sort
Description: Specifies the type of the benefit.

This field is a relationship field.
Relationship Name: BenefitType
Relationship Type: Master-Detail
Refers To: BenefitType

BnftDisbFieldSetApiName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The API name of the field set that groups benefit specific fields for the benefit disbursement object.

CurrentMonthDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the current month. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

CurrentYearAssignedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits assigned in the current year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

CurrentYearDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the current year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

Description

Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: The description of the benefit.

EndDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date until when the benefit is valid.

EnrollmentCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of times the benefit is applicable to an individual.

GoalDefinitionId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The goal definition associated with the benefit.

This field is a relationship field.
Relationship Name: GoalDefinition
Relationship Type: Lookup
Refers To: GoalDefinition

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates if the benefit is active.
Default value: false

MaximumBenefitAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The maximum amount that can be disbursed for a period.

MinimumBenefitAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The minimum amount that can be disbursed for a period.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the benefit.

PreviousMonthDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the previous month. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

PreviousYearAssignedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits assigned in the previous year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

PreviousYearDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the previous year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

ProgramId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The identifier of the program that’s associated with the benefit.

This field is a relationship field.
Relationship Name: Program
Relationship Type: Lookup
Refers To: Program

StartDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date when the benefit starts.

UnitId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The identifier of the unit of measure that’s used to calculate the benefit.

This field is a relationship field.
Relationship Name: Unit
Relationship Type: Lookup
Refers To: UnitOfMeasure