BenefitAssignmentAdjustment

Represents a monetary or non-monetary benefit adjustment made to an enrollee that can be disbursed in various frequencies. This object is available in API version 56.0 and later.

Supported Calls

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

Fields

AdjustmentType

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Required. Specifies the type of adjustment made to the benefit assignment.
Possible values:
- Payable
- Recoverable

ApprovalStatus

Type: picklist
Properties: Create, Filter, Group, Sort, Update
Description: Required. Specifies the approval status of the benefit adjustment.
Possible values:
- Approved
- Pending
- Rejected

BenefitAssignmentId

Type: reference
Properties: Create, Filter, Group, Sort
Description: Required. The benefit assignment associated with this benefit adjustment.

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

Comment

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The description about the benefit adjustment.

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.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the benefit assignment adjustment.

ProcessingStatus

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: Required. Specifies the processing status of the benefit adjustment.
Possible values:
- Active
- Cancelled
- Complete
- On_Hold
- Pending
- Processing

Reason

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: Required. The reason for making an adjustment to a benefit assignment.

RecurringAmount

Type: currency
Properties: Create, Filter, Sort, Update
Description: Required. The benefit adjustment amount that must be paid to the enrollee or the recipient at regular intervals.

ReferenceRecordId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The case or participant associated with the benefit assignment.

This field is a polymorphic relationship field.
Relationship Name: ReferenceRecord
Relationship Type: Lookup
Refers To: Case, CaseParticipant

StartDate

Type: dateTime
Properties: Create, Filter, Sort, Update
Description: Required. The start date and time of the benefit adjustment period.

TotalAdjustmentAmount

Type: currency
Properties: Create, Filter, Sort, Update
Description: Required. The total benefit adjustment amount that must be paid to the enrollee or the recipient.

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.

BenefitAssignmentAdjustmentFeed: Feed tracking is available for the object.
BenefitAssignmentAdjustmentHistory: History is available for tracked fields of the object.
BenefitAssignmentAdjustmentOwnerSharingRule: Sharing rules are available for the object.
BenefitAssignmentAdjustmentShare: Sharing is available for the object.