BenefitDisbursement

Represents the allocation of an enrollee's benefit that can be made as monetary or non-monetary with different 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()

Special Access Rules

This object is available if Program and Benefit Management or Benefit Disbursement is enabled in your org.

Fields

Field Details
ActualCompletionDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
Required. The date when the benefit disbursement was completed.
AdjustmentAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The total amount that's adjusted in the benefit disbursement.
ApprovalStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the disbursement status of the benefit.
Possible values are:
  • Approved
  • In Review
  • Not Applicable
  • Pending
  • Rejected
BenefitAssignmentId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. The benefit assignment that's associated with the disbursement.
This field is a relationship field.
Relationship Name
BenefitAssignment
Relationship Type
Lookup
Refers To
BenefitAssignment
BenefitCategory
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The category of the benefit that's allocated to the enrollee or the recipient.
Possible values are:
  • Goods
  • Monetary
  • Services
BenefitSessionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The benefit session that's associated with the benefit disbursement. This field is accessible if you enabled Data Protection and Privacy in Setup.
This field is a relationship field.
Relationship Name
BenefitSession
Relationship Type
Lookup
Refers To
BenefitSession
CodeSetId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The code set associated with the benefit disbursement record.
This field is a relationship field.
Available in API version 59.0 and later.
Relationship Name
CodeSet
Relationship Type
Lookup
Refers To
CodeSet
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A description about the benefit that is disbursed. This field is accessible if you enabled Data Protection and Privacy in Setup.
DisbursedQuantity
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The quantity of the benefit that's disbursed. This field is accessible if you enabled Data Protection and Privacy in Setup.
DisbursementStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of the benefit disbursement.
Possible values are:
  • Absent
  • Completed
  • Enrolled
  • Excused
The default value is Enrolled.
This field is accessible if you enabled Data Protection and Privacy in Setup.
EndDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The end date of the benefit period in every payment cycle.
EntitlementAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The benefit amount that an enrollee is eligible for.
ExternalPaymentReference
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the payment on an external system.
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
Name of the benefit disbursement.
PaymentStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of the disbursement payment.
Possible values are:
  • Completed
  • Failed
  • Not Applicable
  • Pending
  • Processing
PayoutAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The payout amount after adjustment that's to be paid to the enrollee or the recipient.
PractitionerFacilityId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The practitioner facility associated with the benefit session record.
This field is a relationship field.
Available in API version 59.0 and later.
Relationship Name
PractitionerFacility
Relationship Type
Lookup
Refers To
HealthcarePractitionerFacility
ProgramEnrollmentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The program enrollment record that's associated with the benefit disbursement. This field is accessible if you enabled Data Protection and Privacy in Setup.
This field is a relationship field.
Relationship Name
ProgramEnrollment
Relationship Type
Lookup
Refers To
ProgramEnrollment
ProviderFacilitySpecialtyId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The care specialty to be provided to the enrollee or the recipient at a particular care provider facility.
This field is a relationship field.
Relationship Name
ProviderFacilitySpecialty
Relationship Type
Lookup
Refers To
CareProviderFacilitySpecialty
RecipientCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The count of recipients who received the benefit. This field is accessible if you enabled Data Protection and Privacy in Setup.
RecipientId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Required. The participant who receives a benefit.
This field is a polymorphic relationship field.
Relationship Name
Recipient
Relationship Type
Lookup
Refers To
Account, Contact
RecipientType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Specifies the recipient type of the benefit that's disbursed.
Possible values are:
  • Anonymous
  • ProgramEnrollment
  • Walk-in
The default value is ProgramEnrollment.
This field is accessible if you enabled Data Protection and Privacy in Setup.
StartDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The start date of the benefit period in every payment cycle.
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 accessible if you enabled Data Protection and Privacy in Setup.
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.

BenefitDisbursementFeed
Feed tracking is available for the object.
BenefitDisbursementHistory
History is available for tracked fields of the object.
BenefitDisbursementOwnerSharingRule
Sharing rules are available for the object.
BenefitDisbursementShare
Sharing is available for the object.