Benefit

Represents the benefits provided by public sector agencies that aim to support citizens and their businesses. This object stores whether the benefit is for financial or service-based organizations.

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: Required. Specifies the type of the benefit.

This field is a relationship field.
Relationship Name: BenefitType
Relationship Type: Lookup
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.

CurrentYearAssignedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits assigned in the current year.

CurrentYearDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the current year.

Description

Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: The description of the public program 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: Required. Indicates whether the benefit is active.
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

MaxBenefitAmount

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

MinBenefitAmount

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: Required. The name of the public program benefit.

PaymentMethodType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The method used for payment disbursement.

Available in API version 67.0 and later.

PayoutFrequency

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the frequency of the benefit payment.
Possible values:
- Annual
- BiWeekly—Bi-Weekly
- Monthly
- Quaterly
- Weekly

PreviousMonthDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the previous month.

PreviousYearAssignedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits assigned in the previous year.

PreviousYearDisbursedQty

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total quantity of benefits disbursed in the previous year.

ProgramId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The (public?) program associated with the benefit.

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

RecertificationFrequency

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The frequency in days after which an enrolee must recertify eligibility to receive the benefit.

Available in API version 58.0 and later.

StartDateTime

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

StartRecertificationFrom

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Indicates when a constituent can recertify for the benefit before the recertification due date.

Available in API version 61.0 and later.

UnitId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measure for quantity.

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

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.

BenefitFeed: Feed tracking is available for the object.
BenefitHistory: History is available for tracked fields of the object.