GET api/brand/{brandID}/outstanding-stockobligations

Get all outstanding stock obligations. This includes all stock obligations with status not set to 'complete' or 'QuantityFilled' is not equal to 'Quantity'. Can be used to reconcile external systems.

Request Information

URI Parameters

Name	Description	Type	Additional information
brandID	Brand Identifier.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ClientStockObligation

Name	Description	Type	Additional information
ClientID	TPP client identifier.	integer	None.
ClientRef	Account reference from 3rd party front office systems.	string	None.
ObligationID	TPP obligation identifier.	integer	None.
SourceType	Obligation source type.	enObjectType	None.
SourceID	Obligation source identifier.	integer	None.
NetID	The Netting Reference on the outstanding fund obligation.	integer	None.
SecurityCode	Instrument code.	string	None.
Quantity	Quantity of the stock outstanding.	integer	None.
QuantityFilled	Quantity delivered / received to / from counterparty.	integer	None.
DueDate	Due date.	date	None.
Status	Status of stock registered with client.	enObligationStatus	None.
SettlementType	The registration type used for settlement of the stock obligation.	enOrderSettlementType	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 1234,
    "ClientRef": "abcd1234",
    "ObligationID": 1836430,
    "SourceType": 49,
    "SourceID": 23456,
    "NetID": 34567,
    "SecurityCode": "BHP",
    "Quantity": 1240,
    "QuantityFilled": 0,
    "DueDate": "2019-10-17",
    "Status": 2,
    "SettlementType": 1
  },
  {
    "ClientID": 4321,
    "ClientRef": "dcba4321",
    "ObligationID": 1836431,
    "SourceType": 49,
    "SourceID": 23467,
    "NetID": 34567,
    "SecurityCode": "BHP",
    "Quantity": -1000,
    "QuantityFilled": 0,
    "DueDate": "2019-10-17",
    "Status": 2,
    "SettlementType": 2
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientStockObligation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.DataAccess.LLB.Contracts.ExternalMessagingSender">
  <ClientStockObligation>
    <ClientID>1234</ClientID>
    <ClientRef>abcd1234</ClientRef>
    <DueDate>2019-10-17T00:00:00</DueDate>
    <NetID>34567</NetID>
    <ObligationID>1836430</ObligationID>
    <Quantity>1240</Quantity>
    <QuantityFilled>0</QuantityFilled>
    <SecurityCode>BHP</SecurityCode>
    <SettlementType>BrokerSponsored</SettlementType>
    <SourceID>23456</SourceID>
    <SourceType>NettingOrder</SourceType>
    <Status>Open</Status>
  </ClientStockObligation>
  <ClientStockObligation>
    <ClientID>4321</ClientID>
    <ClientRef>dcba4321</ClientRef>
    <DueDate>2019-10-17T00:00:00</DueDate>
    <NetID>34567</NetID>
    <ObligationID>1836431</ObligationID>
    <Quantity>-1000</Quantity>
    <QuantityFilled>0</QuantityFilled>
    <SecurityCode>BHP</SecurityCode>
    <SettlementType>IssuerSponsored</SettlementType>
    <SourceID>23467</SourceID>
    <SourceType>NettingOrder</SourceType>
    <Status>Open</Status>
  </ClientStockObligation>
</ArrayOfClientStockObligation>