Creating a recovery

When creating recoveries from Cloud API, there is no POST endpoint whose root resource is a recovery. Recoveries are created in the context of a recovery set.

When you create a recovery set, you must specify the recoveriesToWrite. At a minimum, it must consist of the following items:

  • The reserveLine that specifies where the money is coming from. To identify this, you must specify:
    • costCategory (a value from the CostCategory typelist)
    • costType (a value from the CostType typelist)
    • The recovery category (a value from the RecoveryCategory typelist)
    • The id of the parent exposure
    • The reservingCurrency
  • An array of one or more transaction lineItems, each of which must specify:
    • The transactionAmount, including the amount and currency
    • Currency (a value from the currency typelist)

If you want your recovery to reference a recovery reserve, and have its transaction amount go toward the total of the expected recovery reserve, you must duplicate the following information from the recovery reserve:

  • costCategory (a value from the CostCategory typelist)
  • costType (a value from the CostType typelist)
  • The recovery category (a value from the RecoveryCategory typelist)
  • The id of the parent exposure
  • The reservingCurrency

The currency in the lineItem object must also be the same.

Note: If you create a recovery with a transaction amount in excess of its referenced recovery reserve, ClaimCenter creates an additional recovery reserve to make up for the difference.

Example of creating a recovery

The following payload is an example of creating a recovery that references the previous example recovery reserve:

  • The reserveLine offsets money coming from a single exposure:
    • The exposure’s ID is cc:SB1
  • The cost type is claimcost.
  • The cost category is Auto Body (body).
  • The recovery category is salvage.
  • The reserving currency is USD.
    • The transactionAmount is for 3000.00.
Note: The transaction accounts for 3000 dollars (USD) of the expected 5000 dollars (USD) in the recovery reserve. The original recovery reserve total is reduced to the difference of 2000 dollars.

POST /claim/v1/claims/{claimId}/recovery-sets

{
  "data": {
    "attributes": {
      "recoveriesToWrite": [
        {
          "reserveLine": {
            "costCategory": {
              "code": "body"
            },
            "costType": {
              "code": "claimCost"
            },
            "exposure": {
                    "id": " cc:SB1"
            },
            "recoveryCategory": {
              "code": "salvage"
            },
            "reservingCurrency": {
              "code": "usd"
            }
          },
          "lineItems": [
            {
              "transactionAmount": {
                "amount": "3000.00",
                "currency": "usd"
              }
            }
          ],
          "currency": {
            "code": "usd"
          }
        }
      ]
    }
  }
}

Creating a deductible recovery

You can use the Cloud API for creating recovery sets to create a deductible recovery. A deductible is the portion of a covered loss that the insured must pay out of pocket before the insurance company's coverage applies. For example, if a claim is $3000 and the policy has a $500 deductible, the insured must pay $500 out of pocket, and the insurer is liable for the remaining $2500. Refer to Deductible Recoveries for more information about how deductible recoveries work in ClaimCenter.

To create a deductible recovery, you must do the following in your request:
  • Within a line item object, include a lineCategory object with the "deductible" code.
  • For the recoveryCategory object, use the "deductible" code.
  • Ensure that the reserve line has the "claimcost" costType.
Note: To create a deductible recovery with multiple line items, you must open the config.xml file and set the AllowMultipleLineItemsOnDeductibleRecovery parameter to true. It is set to false by default.

Here is an example request to create a deductible recovery:

{
    "data": {
        "attributes": {
            "recoveriesToWrite": [
                {
                    "currency": {
                        "code": "USD"
                    },
                    "lineItems": [
                        {
                            "transactionAmount": {
                                "amount": "500.00",
                                "currency": "usd"
                            },
                            "lineCategory": {
                                "code": "deductible"
                            }
                        }
                    ],
                    "reserveLine": {
                        "exposure": {
                            "id": "xc:SsaDdOxOEBCZDD6ivzTiY"
                        },
                        "reservingCurrency": {
                            "code": "USD"
                        },
                        "costType": {
                            "code": "claimcost"
                        },
                        "costCategory": {
                            "code": "property_repair"
                        },
                        "recoveryCategory": {
                            "code": "deductible"
                        }
                    }
                }
            ]
        }
    }
}
Note: You cannot create a deductible recovery for a deductible that has been waived.