Creating reserves

When creating reserves from Cloud API, there is no POST endpoint whose root resource is a reserve line or a reserve transaction. Reserve lines and reserve transactions are created within the context of a reserve set.

To create a reserve set, use the following endpoint:

  • POST /claims/{claimId}/reserve-sets

When you create a reserve set, you must specify the reservesToWrite. This is reserve set which consists of an array of reserve transactions. For each member of the array, you must specify:

  • The reserveLine for the reserve. To identify this, you must specify:
    • costCategory (a value from the CostCategory typelist)
    • costType (a value from the CostType typelist)
    • The id of the parent exposure (This can also be explicitly set to null, in which case the reserve line is created at the claim level.)
    • reservingCurrency
  • An array of one or more transaction lineItems, each of which must specify:
    • A transactionAmount (specified as an amount and a currency)
  • The reserve transaction currency

Currencies in the POST reserve-sets payload

Every reserve transaction consists of one of more line items. Reserve transactions and line items are stored in different database tables. However, for a given reserve transaction, the currency of every line item in the reserve transaction must match the currency of the reserve transaction.

This distinction may not be evident when using the user interface. The user chooses a currency for the transaction, and all line items automatically default to that transaction. This hides the fact that they are technically distinct values.

However, this distinction must be taken into consideration when writing a reserve set payload. There is no mechanism for the line items to inherit the reserve transaction's currency. Therefore, the currency of the reserve transaction and each line item must be explicitly stated, and they must be the same.

There is a third field that is set to a currency value, reservingCurrency. In an instance of ClaimCenter that makes use of multicurrency, this can be set to a currency other than the reserve transaction's currency. For more information, see Multicurrency.

Approval status

When a reserve set is submitted, ClaimCenter checks the corresponding user's authority limits.

  • If the amount is at or below the user's authority limit, the reserve set is approved. The appropriate amount is added to the reserve line, and the response object's approvalStatus field is set to approved.
  • If the amount is above the user's authority limit, the reserve set requires approval. An approval activity is created and sent to a user with sufficient approval authority. No amount is added to the reserve line, and the response object's approvalStatus field is set to unapproved.

A given user can have an authority limit for "claim total reserves", "exposure total reserves", or both. For more information on authority limits, see the Application Guide.

When the reserve set is submitted through Cloud API, the user whose authority limits are checked is the session user. For more information on how the session user is determined, see the Cloud API Developer Guide.

Reserves and composite requests

Within a composite request, you cannot create or modify financial objects. This includes reserve sets and reserve transactions. However, within a composite request, you can GET information on financial objects.

Example of creating reserves

The following payload is an example of creating a reserve line.

  • The ID of the claim is cc:61.
  • The ID of the exposure is cc:79.
  • There is only one reserve transaction.
    • The transaction is for a reserve line whose cost type and cost category is Claim Cost / Auto Body (claimcost and body).
    • The transaction's currency is USD.
    • The transaction has a single line item for $1000.
POST /claims/cc:61/reserve-sets

{
  "data": {
    "attributes": {
      "reservesToWrite": [
        {
          "reserveLine": {
            "costCategory": {
              "code": "body"
            },
            "costType": {
              "code": "claimcost"
            },
            "exposure": {
              "id": "cc:79"
            },
            "reservingCurrency": {
              "code": "usd"
            }
          },
          "lineItems": [
            {
              "transactionAmount": {
                "amount": "1000.00",
                "currency": "usd"
              }
            }
          ],
          "currency": {
            "code": "usd"
          }
        }
      ]
    }
  }
}
Java

Example of adding to reserves

The following payload is an example of adding to an existing reserve line. This call is executed after the previous example.

  • The ID of the claim is cc:61.
  • The ID of the exposure is cc:79.
  • There is only one reserve transaction.
    • The transaction is for a reserve line whose cost type and cost category is Claim Cost / Auto Body (claimcost and body).
    • The transaction's currency is USD.
    • The transaction has a single line item for $250.

Note that this payload has no significant differences from the previous payload. When you create a reserve transaction, you only need to identify the cost type, cost category, and currency (and amount). ClaimCenter determines whether this is a new reserve line or part of an existing reserve line on its own.

POST /claims/cc:61/reserve-sets

{
  "data": {
    "attributes": {
      "reservesToWrite": [
        {
          "reserveLine": {
            "costCategory": {
              "code": "body"
            },
            "costType": {
              "code": "claimcost"
            },
            "exposure": {
              "id": "cc:79"
            },
            "reservingCurrency": {
              "code": "usd"
            }
          },
          "lineItems": [
            {
              "transactionAmount": {
                "amount": "250.00",
                "currency": "usd"
              }
            }
          ],
          "currency": {
            "code": "usd"
          }
        }
      ]
    }
  }
}
Java