Newer Version Available

This content describes an older version of this product. View Latest

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.
Field Details
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.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Name of the benefit assignment.
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
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.
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.
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