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.

{
  "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"
          }
        }
      ]
    }
  }
}