Create a claim coverage payment detail record. This also generates the related records
for the Insurance Policy Limit Tracking and Claim Coverage Payment Adjustment records if
applicable.
Resource
{claimId} and {coverageId} are placeholders.
/connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/payment-details
Available Version
65.0
HTTP Methods
POST
Path Parameter for POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| claimId | String | ID of the claim for which the claim coverage payment detail record must be created. | Required | 65.0 |
| coverageId | String | ID of the coverage that applies to the claim. | Required | 65.0 |
Request Body for POST
JSON Example
{
"claimedAmount": 1200.0,
"recipientId": "001xx000003GN2rAAG",
"coveragePaymentType": "Loss",
"benefitName": "DentalCov",
"description": "Dental cleaning and checkup.",
"limitUnitCount": 1,
"adjustedAmount": 1200.0,
"additionalFields": {
"State__c": "CA",
"LOB__c": "Commercial"
}
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| additionalFields | Object | Additional standard or custom fields that are used to create the claim coverage payment detail record. | Optional | 65.0 |
| adjustedAmount | Double | Amount deducted from the Posted Amount based on the respective attribute category. | Required when coveragePaymentType is Loss | 65.0 |
| benefitName | String | Name of the benefit that's associated with the product attribute's mapped scope as a sub-coverage. | Required when coveragePaymentType is Loss | 65.0 |
| claimedAmount | Double | Amount requested by the claimant when submitting the loss. | Required | 65.0 |
| coveragePaymentType | String | Specifies the category of the payment. The value must be either Loss or
Expense.
Loss refers to the payment related to the policyholder's covered damages. Expense refers to costs associated with claim processing, such as vendor fees. |
Required | 65.0 |
| description | String | Description of the claim coverage payment detail record. | Optional | 65.0 |
| limitUnitCount | Integer | Number of units for this claim coverage payment detail, such as the number of days
for a rental car expense.
The default value is 1. |
Optional | 65.0 |
| recipientId | String |
ID of the person or entity who will receive the payment, such as the policyholder, a third-party claimant, or a service vendor. |
Optional | 65.0 |