Retrieving the available financial calculations

A caller can retrieve the list of available financial expressions for a given claim by using the following endpoint.

• GET /claim/v1/claims/{claimId}/financial-calculations

This endpoint returns a list of financial expressions that the caller can access on this claim.

• If there are no restrictions placed on the caller, then this is the full set of expressions supported by the given instance of ClaimCenter.

• If there are restrictions placed on the caller, then this will be the subset of expressions that caller can access on that claim. For more information, see Restricting access to financial calculation expressions.

The following is an example of executing this endpoint on a sample data claim as super user su.

Request

GET /claim/v1/claims/demo_sample:1/financial-calculations?fields=name

Response

{
    "count": 16,
    "data": [
        {
          "attributes": {
             "name": "PendingApprovalErodingPayments"
          }
        },
        {
          "attributes": {
             "name": "PendingApprovalNonErodingPayments"
          }
        },
        {
          "attributes": {
             "name": "PendingApprovalPayments"
          }
        },
        ...

You can configure Cloud API to expose additional financial expressions. This includes expressions in the base configuration of ClaimCenter that are not exposed in the base configuration of Cloud API, as well as custom expressions. For more information, see the Cloud API Developer Guide.

There is also a GET /claim/v1/claims/{claimId}/financial-calculations/{expression} endpoint. This endpoint returns only the name of the expression. It must exist for technical reasons, but there is usually no practical reason for a caller application to use it.