BenefitAssignment

Represents the enrollment information of an individual to a benefit. This object is available with Program Management in API version 57.0 and later.

Supported Calls

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

Fields

BenefitId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: Name of the benefit that is associated with the assignment.

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

EndDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date up to when the assignment is valid.

EnrolleeId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: Name of the benefit assignee.

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

EnrollmentCount

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

EntitlementAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The benefit amount that an enrollee is eligible for.

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: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: Name of the benefit assignment.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: ID of the owner of this record.

This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

ParentRecordId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: Required. The parent record associated with the benefit assignment.

This field is a polymorphic relationship field. Use CarePlan if the benefit is part of a structured care plan, GoalAssignment if it supports a specific goal, IndividualApplication if assigned during intake, and ProgramEnrollment if the participant is only using program management features.
Relationship Name: ParentRecord
Relationship Type: Lookup
Refers To: CarePlan, GoalAssignment, IndividualApplication, ProgramEnrollment

Priority

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the priority of the benefit assignment.
Possible values:
- High
- Low
- Medium

ProgramEnrollmentId

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

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

StartDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The start date from when the assignment begins.

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies the status of the benefit assignment.
Default value: Enrolled
Possible values:
- Active
- Completed
- Enrolled
- Waitlisted
- Withdrawn

TaskJobStatus

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Specifies the status of the task in the task queue.
Possible values:
- Completed
- Failed
- InProgress - In Progress
- Submitted

TaskJobStatusMessage

Type: textarea
Properties: Nillable
Description: The message that describes the status of the task in the queue.

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 a relationship field.
Relationship Name: UnitofMeasure
Relationship Type: Lookup
Refers To: UnitOfMeasure