PaymentRequestLine

Represents the line item details of the financial compensation request. This object is available in API version 60.0 and later.

Supported Calls

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

Special Access Rules

To access this object on your Public Sector Solutions org, Benefit Disbursement must be enabled and you must have the Benefit Disbursement Access permission set or the Benefit Disbursement permission set license.

Fields

Field Details
AdjustmentAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Adjustment amount for reasons such as copay, deductible, and coinsurance.
AdjustmentReason
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
The reason for adjustment.
Possible values are:
  • Coinsurance
  • Copay
  • Deductible
BenefitName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of benefit associated with the payment request line, such as Physical Therapy or Ambulance Transportation.
ClaimItemId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The claim item associated with the payment request line.
This field is a relationship field.
Relationship Name
ClaimItem
Relationship Type
Lookup
Refers To
ClaimItem
DiagnosticCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The diagnostic code associated with the payment request line.
This field is a polymorphic relationship field.
Relationship Name
DiagnosticCode
Relationship Type
Lookup
Refers To
CodeSet, CodeSetBundle
EndDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The end date of services represented in the payment request line.
FacilityId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The facility associated with the payment request line. 
This field is a polymorphic relationship field.
Relationship Name
Facility
Relationship Type
Lookup
Refers To
Account, HealthcareFacility, Location
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. The name of the payment request line.
PaymentRequestId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. The payment request associated with the payment request line.
This field is a relationship field.
Relationship Name
PaymentRequest
Relationship Type
Lookup
Refers To
PaymentRequest
Quantity
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Number of units the payment request line represents, such as number of days in hospital.
QuantityUnitOfMeasure
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Unit of measure for the quantity field.
Possible values are:
  • Days
  • Nights
  • Visits
RequestedAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Amount that the requestor is seeking for payment, which is the service amount minus the adjustment amount.
ServiceAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Total service amount for the payment request line before adjustments.
ServiceCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The service code associated with the payment request line.
This field is a polymorphic relationship field.
Relationship Name
ServiceCode
Relationship Type
Lookup
Refers To
CodeSet, CodeSetBundle
ServiceProviderId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The service provider associated with the payment request line.
This field is a polymorphic relationship field.
Relationship Name
ServiceProvider
Relationship Type
Lookup
Refers To
Account, Contact, HealthcareProvider
ServiceType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Type of requested service.
Possible values are:
  • Device
  • Medication
  • Procedure
  • Repairs
StartDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The start date of services represented in the payment request line.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The status of the payment request line.
Possible values are:
  • Paid
  • Partially Paid
  • Received
UnitPrice
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Unit Price for the quantity and quantity unit of measure.

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.

PaymentRequestLineFeed
Feed tracking is available for the object.
PaymentRequestLineHistory
History is available for tracked fields of the object.