The Unsettled Amounts Resource provides endpoints to monitor future cash flow, by providing a detailed view of the amounts owed by (or to) the requested entity. Positive amounts indicate amounts to be paid to the requesting entity, negative amounts indicate amounts to be paid by the entity.
It is useful to be familiar with the Owner Hierarchy, before using this resource, as this resource's endpoints include all the aggregate totals due for all children clients and accounts.
The structure, and granularity of each endpoint's response varies, to support various use cases.
|Endpoint Name||Path||Returned Schema|
Currency Breakdown: Owed by Currency and Amount Type
Currency Breakdown: Owed by Instrument
Exchange Breakdown: Owed by Exchange and Currency
Exchange Breakdown: Owed by Currency and Amount Type
With the various granularity option, it is worthwhile to understand the common underlying structures, and which each endpoint can access.
|Schema||Description||Available within the response structures of the endpoint(s)|
|Aggregates in the requesting entity's currency, providing an array of CashFlow to show date specific amounts due. Has a child array, Currencies, consisting of an array of CurrencyBreakdown objects.||/unsettledamounts|
|ExchangeRoot||Aggregates in the requesting entity's currency, providing an array of CashFlow to show date specific amounts due. Has a child array, Exchanges, consisting of an array of ExchangeBreakdown objects.||/unsettledamounts/exchanges|
|ExchangeBreakdown||Contains the requesting entity's currency, providing an ExchangeId, Total, and array of CashFlow to show date specific amounts due to the specific Exchange. It also has a child array, Currencies, consisting of an array of CurrencyBreakdown objects.|
|CurrencyBreakdown||Contains the owed currency, a Total aggregate in that currency, and an array of CashFlow to show date specific amounts due for this currency. Can have a child array, AmountTypesBreakdown in select endpoints.|
|AmountTypeBreakdown||AmountType objects, containing an Amount Type, a Total aggregate in the owed currency, and an array of CashFlow to show date specific amounts due for this amount type.|
|InstrumentBreakdown||Instrument object with instrument details, a Total aggregate in the owed currency and an array of CashFlow to show date specific amounts due for this instrument.||/unsettledamounts/instruments|
Diagram showing the above schemas, and their relation to Unsettled Amounts Endpoints
|CashFlow||A simple object containing an Amount and ValueDate attribute. The amount's currency is inherited from the nearest parent currency.|
An enumerator denoting the source of each amount type, also usable in some endpoints as a request filter(as an array of values). Possible values are:
A request query parameter, used to access either currency or amount type granularity levels from the /unsettledamounts endpoint. Possible values are:
Example Scenario and Response
As a White Label Client (WLC) or Introducing Broker (IB) consumer of this endpoint, I have underlying clients for whom I have settlement responsibility. I want to know the value dated amounts that we owe, or are owed to us, with the finest available precision, so that I can acquire the owed amounts in their respective currency in good time.
Request Currency Breakdown by Exchange
Using my WLC Client Key, make a request to see which exchanges money is owed to, and in what currencies:
We receive the response:
Access details on exchange
If you want specific information for the ExchangeId NYSE, you can query the Reference Data Service Group. Note that the "NoExchange" value cannot be looked up, and is provided in order to show amounts that are not related to an exchange.
We recieve the response:
Request Amount Type owed Breakdown for an Exchange
To access a more detailed breakdown of the amounts owed to a specific exchange, I can specify the provided ExchangeId in the path, and make another request:
Making this request for both Exchanges, we receive the response:
The additional endpoints behave similarly–but provide access to different granularity data, sometimes requiring additional query parameters. See the reference docs for more details.