ClaimCoveragePaymentDetail

Represents the claim coverage amount that must be paid to a recipient for a loss or an expense payment. 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
AdjustedAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount the insurance carrier intends to pay for a loss or benefit after making adjustments for deductibles, copay, or coinsurance.
BenefitName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the benefit associated with the claim coverage payment detail.
ClaimCoverageId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The Claim Coverage associated with the Claim Coverage Payment Detail.
This field is a relationship field.
Relationship Name
ClaimCoverage
Relationship Type
Lookup
Refers To
ClaimCoverage
ClaimCoverageReserveDetailId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Claim Coverage Reserve Detail associated with the Claim Coverage Payment Detail.
This field is a relationship field.
Relationship Name
ClaimCoverageReserveDetail
Relationship Type
Lookup
Refers To
ClaimCoverageReserveDetail
ClaimParticipantRecipientId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Claim Participant Recipient associated with the Claim Coverage Payment Detail.
This field is a relationship field.
Relationship Name
ClaimParticipantRecipient
Relationship Type
Lookup
Refers To
ClaimParticipant
ClaimPaymentSummaryId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Claim Payment Summary issued to the Claim Participant Recipient for the Claim Coverage Payment Detail.
This field is a relationship field.
Relationship Name
ClaimPaymentSummary
Relationship Type
Lookup
Refers To
ClaimPaymentSummary
ClaimPayoutPlanId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Claim Payout Plan associated with the Claim Coverage Payment Detail.
This field is a relationship field.
Relationship Name
ClaimPayoutPlan
Relationship Type
Lookup
Refers To
ClaimPayoutPlan
ClaimedAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount claimed by the claimant or service provider to pay for a loss or benefit.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
If multiple currencies are enabled, this field contains the currency ISO code associated with the record.
Possible values are:
  • AED—UAE Dirham
  • CAD—Canadian Dollar
  • GBP—British Pound
  • JPY—Japanese Yen
  • USD—U.S. Dollar
The default value is USD.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the claim coverage.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view.
LimitUnitCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unit count that the payment detail represents.
LimitUnitOfMeasure
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the unit of measure that the payment detail represents.
Possible values are:
  • Days
  • Visits
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the claim coverage payment detail.
PaymentRequestLineId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Payment Request Line associated with the Claim Coverage Payment Detail.
This field is a relationship field.
Relationship Name
PaymentRequestLine
Relationship Type
Lookup
Refers To
PaymentRequestLine
ScheduledPaymentDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date on which the payment is scheduled.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of claim coverage payment detail.
Possible values are:
  • Authority Approved
  • Authority Denied
  • Cancelled
  • Closed W/O Pay
  • New
  • Open
  • Paid
  • Payment Pending
  • Pending Authority
  • Stopped
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of claim coverage payment detail.
Possible values are:
  • Expense
  • Loss

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.

ClaimCoveragePaymentDetailChangeEvent
Change events are available for the object in API version 63.0 and later.