Pay Ex Gratia Claim Coverage Payment Detail

Output representation for the details of the ex gratia payment that’s made for the claim coverage payment detail.

JSON Example

1{
2  "claimPaymentSummaryId": "0sDxx0000000001CAA",
3  "consumedLimitCount": 5,
4  "errors": [],
5  "exceededAmount": 1500.00,
6  "exceededCount": 2,
7  "hasFinancialAuthority": true,
8  "insPolicyLimitTrackingIds": [
9    "0qOxx0000004CvQEAU",
10    "0qOxx0000004CvREAU"
11  ],
12  "isFinancialAuthorityConfigured": true,
13  "isSuccess": true,
14  "paidAmount": 5000.00,
15  "remainingReserves": [
16    {
17      "remainingReserveAmount": 2500.00,
18      "reserveLimitRecordId": null,
19      "scope": "ClaimCoverage"
20    },
21    {
22      "remainingReserveAmount": 8000.00,
23      "reserveLimitRecordId": null,
24      "scope": "Claim"
25    }
26  ],
27  "warnings": []
28}

Property Name	Type	Description	Filter Group and Version	Available Version
`claimPaymentSummaryId`	String	ID of the claim payment summary record that’s added or updated. This ID links individual claim coverage payment details to the corresponding summary of payments that are processed for a claim.	Small, 66.0	66.0
`consumedLimitCount`	Integer	Total number of coverage units or limit counts that are utilized by this service or transaction.	Small, 66.0	66.0
`errors`	Error Detail[]	Error details that are shown when the API operation fails.	Small, 66.0	66.0
`exceededAmount`	Double	Excess amount that’s paid above the limits.	Small, 66.0	66.0
`exceededCount`	Integer	Number of coverage units or counts that are paid above the policy limits. This occurs when payments exceed the allowable limits, such as in discretionary ex gratia payments.	Small, 66.0	66.0
`hasFinancialAuthority`	Boolean	Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (`true`) or not (`false`). This property is returned when `shouldCheckFinancialAuthority` is `true` and the claim coverage payment detail is in `Draft` status.	Big, 68.0	68.0
`insPolicyLimitTrackingIds`	String[]	IDs of the insurance policy limit tracking records that are created during the ex gratia payment process.	Small, 66.0	66.0
`isFinancialAuthorityConfigured`	Boolean	Indicates whether a User Financial Authority (UFA) record is configured for the current user (`true`) or not (`false`). This property is returned when `shouldCheckFinancialAuthority` is `true` and the claim coverage payment detail is in `Draft` status.	Big, 68.0	68.0
`isSuccess`	Boolean	Indicates whether the API operation is successful (`true`) or not (`false`).	Small, 66.0	66.0
`paidAmount`	Double	Total amount that’s paid towards ex gratia.	Small, 66.0	66.0
`remainingReserves`	Remaining Reserve[]	List of remaining reserves, including the remaining amount and scope of each reserve after the payment is processed.	Small, 68.0	68.0
`warnings`	String[]	List of warning messages that are generated when the payment exceeds reserve limits, indicating which reserves are exceeded and by how much. The payment is still processed successfully.	Small, 68.0	68.0