BenefitAssignment

Represents the enrollment information of an individual or business that is captured in an application. For example, an individual who is unemployed can raise an application requesting help from the government. If it is approved, the individual is enrolled into the unemployment insurance benefit. This object is available in API version 52.0 and later.

Supported Calls

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

Fields

Field	Details
ApprovalRejectionReason	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason for rejecting the benefit amount requested by the enrollee.
ApprovalStatus	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates whether the benefit assignment has been approved or not. Possible values are: `Approved` `Pending` `Rejected`
AssignmentDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date when the benefit is assigned to the enrollee. Available in API version 66.0 and later.
BenefitAssignmentKeywords	Type textarea Properties Create, Nillable, Update Description The keywords that are associated with the benefit assignment. Available in API version 66.0 and later.
BenefitAssignmentSummary	Type textarea Properties Create, Nillable, Update Description A summary of the benefit assignment. Available in API version 66.0 and later.
BenefitId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. 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
EarningThresholdAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The maximum amount the enrollee can earn for a given period to be eligible for a benefit.
EligibilityDeterminationmethod	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the method used to determine the eligibility of the enrollee for the benefit. Available in API version 66.0 and later.
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, Nillable, Sort, Update Description Name of the individual being enrolled for the benefit. 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.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
MaximumBenefitAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The maximum amount that can be disbursed during an enrollment period.
MinimumBenefitAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The minimum amount that can be disbursed during an enrollment period.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the benefit assignment.
NextPayoutDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The due date for the next scheduled benefit payment.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. 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. Relationship Name ParentRecord Relationship Type Lookup Refers To BusinessLicenseApplication, CarePlan, Claim, GoalAssignment, IndividualApplication, ProgramEnrollment
PayoutFrequency	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the frequency of the benefit payment. Possible values are: `Annual` `BiWeekly` `Monthly` `OnDemand` `Quaterly` `Weekly`
Priority	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the priority of the benefit assignment. Possible values are: `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
Quantity	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The benefit quantity allocated to the enrollee.
RecertificationDueDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date by when the enrolee must recertify eligibility to continue receiving the benefit. Available in API version 58.0 and later.
RecertificationStatus	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the recertification status of the enrollee's eligibility for the benefit assignment. Possible values are: `InProgress`—Available in API version 61.0 and later. `Lapsed`—Available in API version 61.0 and later. `Pending` `Recertified` Available in API version 60.0 and later.
ReferenceNumber	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reference number used to indicate the enrollee's benefit request.
RemainingAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The remainder benefit amount that is to be paid to the enrollee.
StartDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The start date from when the assignment begins.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Specifies the status of the benefit assignment. Possible values are: `Active` `Completed` `Enrolled` `Waitlisted` `Withdrawn` The default value is `Enrolled`.
TaskJobStatus	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the status of the task in the task queue. Possible values are: `Completed` `Failed` `InProgress` `Submitted`
TaskJobStatusMessage	Type textarea Properties Nillable Description The message that describes the status of the task in the queue.
TerminationNotificationDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date the benefit termination notice was delivered. Available in API version 66.0 and later.
TerminationReason	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the reason for terminating the benefit assignment. Available in API version 66.0 and later.
TotalApprovedAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total benefit amount approved for an enrollee.
TotalPaidAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total benefit amount that has already been paid to the enrollee.
UnitOfMeasureId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the unit of measurement of the benefit allocated to the enrollee. This field is a relationship field. Relationship Name UnitOfMeasure 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.

BenefitAssignmentFeed: Feed tracking is available for the object.
BenefitAssignmentHistory: History is available for tracked fields of the object.
BenefitAssignmentOwnerSharingRule: Sharing rules are available for the object.
BenefitAssignmentShare: Sharing is available for the object.

Public Sector Solutions Developer Guide

BenefitAssignment

Supported Calls

Fields

Associated Objects