Retrieving multicurrency information

Currency information is part of the default response for the GET /reserves endpoint, whether or not multicurrency has been enabled.

The following is a snippet of the response payload for a GET /reserves for a multicurrency reserve. Currency information appears in bold. Note the following:

• The default currency for this instance of ClaimCenter is US dollars (usd).
  • This is specified in the reportingAmount.currency field.
• The claim's currency is US dollars (usd).
  • This is specified in the claimAmount.currency field.
• The reserving currency is British pounds (gbp).
  • This is specified in the reservingAmount.currency field.
• The reserve transaction is British pounds (gbp).
  • Every reserve transaction consists of one of more line items. Both transactions and line items have currency values, but each is stored in different database tables. These currency values must always be explicitly stated and must always be the same, regardless of whether or not multicurrency is enabled.
  • The currency for the transaction is specified in the parent currency field.
  • The currency for each associated line item is specified in the lineItems.transactionAmount.currency field(s).

GET /claims/cc:SHRyrnPstWtq7HZ3nxLCC/reserves/cc:SojI8VceTmdlXU6k1pqOB

{
    "data": {
        "attributes": {
            "currency": {
                "code": "gbp",
                "name": "GBP"
            },
            "id": "cc:SojI8VceTmdlXU6k1pqOB",
            "lineItems": [
                {
                    "claimAmount": {
                        "amount": "1920.82",
                        "currency": "usd"
                    },
                    "id": "cc:SyLnqtJEkcI4X4WaFXbgP",
                    "reportingAmount": {
                        "amount": "1920.82",
                        "currency": "usd"
                    },
                    "reservingAmount": {
                        "amount": "1000.00",
                        "currency": "gbp"
                    },
                    "transactionAmount": {
                        "amount": "1000.00",
                        "currency": "gbp"
                    }
                }
            ],
            "reserveLine": {
                "costCategory": {
                    "code": "body",
                    "name": "Auto body"
                },
                "costType": {
                    "code": "claimcost",
                    "name": "Claim Cost"
                },
                "exposure": {
                    "displayName": "(1) 1st Party Vehicle - Allen Robertson",
                    "id": "cc:SfXS3Pey0Al29PI13KC5C",
                },
                "reservingCurrency": {
                    "code": "gbp",
                    "name": "GBP"
                }
            }
        }
    }
}

There is also a currency value specified in the reserveLine.reservingCurrency field. This field identifies the currency of the associated reserve line. A reserve line is a category that can be applied to a financial transactions. For a given exposure, each reserve line is uniquely identified by its cost type, cost category, and currency.

Currency information is part of the default response for the GET /checks endpoint, whether or not multicurrency has been enabled.

The following is a snippet of the response payload for a GET /checks for a multicurrency check. Currency information appears in bold. Note the following:

• The default currency for this instance of ClaimCenter is US dollars (usd).
  • This is specified in the reportableAmount.currency field.
• The reserve currency is British pounds (gbp).
  • The reserving currency is British pounds (gbp). This is indicated in the display names of the payments. To see the actual currency code, you would need to GET the individual payment and inspect its reserve line.
• The check currency is Euros (eur).
  • This is specified in the grossAmount.currency field.

GET /claims/cc:SHRyrnPstWtq7HZ3nxLCC/checks/cc:SqK_OuzG48empV3wtydTH

{
    "data": {
        "attributes": {
            "grossAmount": {
                "amount": "20.00",
                "currency": "eur"
            },
            "id": "cc:SqK_OuzG48empV3wtydTH",
            "paymentMethod": {
                "code": "check",
                "name": "Check"
            },
            "payments": [
                {
                    "displayName": "(1) 1st Party Vehicle - Allen Robertson; 
                            Claim Cost/Auto body; GBP; Awaiting submission",
                    "id": "cc:SXGn6K7Zeidw8MAkv2sGx",
                    "type": "Payment",
                }
            ],
            "reportableAmount": {
                "amount": "20.00",
                "currency": "eur"
            }
        }
    }
}