Currency Breakdown: Owed by Currency and Amount Type

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  ClientKey	ClientKey	Query-String	The key of the client to which the resource belongs.
  Date	Date	Route

• Response Parameters

  View Response Codes

  Name	Type	Description
  CashFlows	CashFlow []	Cash flow for value date
  Currencies	CurrencyBreakdownWithCashBalance []	Contains total, and value dated cash flows for an owed currency along with associated information.
  Currency	String	The requester's primary currency
  Total	Number	Estimated total owed amount (converted to the requester's primary currency). Note: Amounts must be paid in the owed currency.

  HTTP Code	Description
  200	OK	OK
  400	Bad Request	Error Code Description InvalidRequest Default error code returned when it cannot be determined which part of the request is malformed.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  404	Not Found
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  GET /hist/v1/unsettledamounts/{Date}?ClientKey=AbSTLYSoo499JZpp|ckGFw==

• Response Example

  Response body

  {
    "CashFlows": [
      {
        "Amount": 10,
        "ValueDate": "2021-05-21T00:00:00Z"
      }
    ],
    "Currencies": [
      {
        "AmountTypes": [
          {
            "AmountType": "stringValue",
            "AmountTypeId": "stringValue",
            "AmountTypeSource": "stringValue",
            "CashFlows": [
              {
                "Amount": 10,
                "ValueDate": "2021-05-21T00:00:00Z"
              }
            ],
            "Total": 10
          }
        ],
        "CashFlows": [
          {
            "Amount": 10,
            "ValueDate": "2021-05-21T00:00:00Z"
          }
        ],
        "Currency": "stringValue",
        "Date": "2021-05-21T00:00:00Z",
        "Total": 10,
        "TotalCashBalance": 10
      }
    ],
    "Currency": "stringValue",
    "Total": 10
  }