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
BenefitFrequency	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the frequency at which the benefit is applied. Possible values are: `Monthly` `Weekly`
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.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record.
MaximumBenefitAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The maximum amount that can be disbursed during an assignment period.
MinimumBenefitAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The minimum amount that can be disbursed during an assignment 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 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 The care plan or Individual Application object or GoalAssignment associated with the benefit assignment. This field is a polymorphic relationship field. Relationship Name ParentRecord Relationship Type Lookup Refers To BusinessLicenseApplication, CarePlan, IndividualApplication
Priority	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Possible values are: `High` `Low` `Medium`
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.
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. Possible values are: `Active` `Inactive`
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`—In Progress `Submitted`
TaskJobStatusMessage	Type textarea Properties Nillable Description The message that describes the status of the task in the queue.

Public Sector Solutions Developer Guide

BenefitAssignment

Supported Calls

Fields