GET api/account/client/{clientID}/outstandingfundobligation
Get unsettled fund obligation of a client
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientID |
TPP Client ID |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of OutstandingFundObligationName | Description | Type | Additional information |
---|---|---|---|
ObligationID |
TPP obligation identifier. |
integer |
None. |
ClientID |
TPP client identifier. |
integer |
None. |
ClientRef |
Account reference from 3rd party front office systems. |
string |
None. |
SourceType |
Obligation source type. |
enObjectType |
None. |
SourceID |
Obligation source identifier. |
integer |
None. |
NetID |
The Netting Reference on the outstanding fund obligation. |
integer |
None. |
Quantity |
Obligation quantity. |
integer |
None. |
Amount |
Value of the amount outstanding. |
decimal number |
None. |
AmountFunded |
Value of amount moved to TPP Trust account to meet the obligation. |
decimal number |
None. |
AmountFilled |
The filled value on the outstanding fund obligation. |
decimal number |
None. |
DueDate |
Due date. |
date |
None. |
Status |
Status of settlement from to client's trust account. |
enObligationStatus |
None. |
TradeDate |
Trade date. |
date |
None. |
Response Formats
application/json, text/json
[ { "ObligationID": 1836429, "ClientID": 1234, "ClientRef": "abcd1234", "SourceType": 49, "SourceID": 23456, "NetID": 34567, "Quantity": 1000, "Amount": -22585.0, "AmountFunded": 0.0, "AmountFilled": 0.0, "DueDate": "2019-10-17T00:00:00", "Status": 2, "TradeDate": "2019-10-16T00:00:00" }, { "ObligationID": 1836460, "ClientID": 4321, "ClientRef": "dcba4321", "SourceType": 49, "SourceID": 23467, "NetID": 34568, "Quantity": 1000, "Amount": 1099.0, "AmountFunded": 0.0, "AmountFilled": 0.0, "DueDate": "2019-10-17T00:00:00", "Status": 2, "TradeDate": "2019-10-16T00:00:00" } ]
application/xml, text/xml
<ArrayOfOutstandingFundObligation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account"> <OutstandingFundObligation> <Amount>-22585</Amount> <AmountFilled>0</AmountFilled> <AmountFunded>0</AmountFunded> <ClientID>1234</ClientID> <ClientRef>abcd1234</ClientRef> <DueDate>2019-10-17T00:00:00</DueDate> <NetID>34567</NetID> <ObligationID>1836429</ObligationID> <Quantity>1000</Quantity> <SourceID>23456</SourceID> <SourceType>NettingOrder</SourceType> <Status>Open</Status> <TradeDate>2019-10-16T00:00:00</TradeDate> </OutstandingFundObligation> <OutstandingFundObligation> <Amount>1099</Amount> <AmountFilled>0</AmountFilled> <AmountFunded>0</AmountFunded> <ClientID>4321</ClientID> <ClientRef>dcba4321</ClientRef> <DueDate>2019-10-17T00:00:00</DueDate> <NetID>34568</NetID> <ObligationID>1836460</ObligationID> <Quantity>1000</Quantity> <SourceID>23467</SourceID> <SourceType>NettingOrder</SourceType> <Status>Open</Status> <TradeDate>2019-10-16T00:00:00</TradeDate> </OutstandingFundObligation> </ArrayOfOutstandingFundObligation>