BenefitDisbursement

Represents the allocation of an enrollee’s benefit that can be made as monetary or non-monetary with different frequencies. 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

ActualCompletionDate

Type: dateTime
Properties: Create, Filter, Sort, Update
Description: The date when the benefit disbursement was completed.

ApprovalStatus

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the disbursement status of the benefit.
Possible values:
- Approved
- In Review
- Not Applicable
- Pending
- Rejected

BenefitAssignmentId

Type: reference
Properties: Create, Filter, Group, Sort
Description: The benefit assignment that’s associated with the disbursement.

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

BenefitSessionId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The benefit session that’s associated with the benefit disbursement. This field is accessible if you enabled Data Protection and Privacy in Setup.

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

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A description about the benefit that is disbursed. This field is accessible if you enabled Data Protection and Privacy in Setup.

DisbursedQuantity

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The quantity of the benefit that’s disbursed. This field is accessible if you enabled Data Protection and Privacy in Setup.

DisbursementStatus

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Specifies the status of the benefit disbursement.

This field is accessible if you enabled Data Protection and Privacy in Setup.
Default value: Enrolled
Possible values:
- Absent
- Completed
- Enrolled
- Excused

EndDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date of the benefit period in every payment cycle.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: Name of the benefit disbursement.

ProgramEnrollmentId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The program enrollment record that’s associated with the benefit disbursement. This field is accessible if you enabled Data Protection and Privacy in Setup.

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

RecipientCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The count of recipients who received the benefit. This field is accessible if you enabled Data Protection and Privacy in Setup.

RecipientId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The participant who receives a benefit.

This field is a polymorphic relationship field.
Relationship Name: Recipient
Relationship Type: Lookup
Refers To: Account, Contact

RecipientType

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: Specifies the recipient type of the benefit that’s disbursed.

This field is accessible if you enabled Data Protection and Privacy in Setup.
Default value: ProgramEnrollment
Possible values:
- Anonymous
- Program Enrollment
- Walk-in

StartDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The start date of the benefit period in every payment cycle.

UnitOfMeasureId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The identifier of the unit of measure that’s used to calculate the benefit type. This field is accessible if you enabled Data Protection and Privacy in Setup.

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