GET api/account/sponsored-balances?clientID={clientID}

Return daily snapshot of sponsored balances for client(s) with quantities that could be used for calculating registered stock available to sell for each client.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID		integer	None.

Body Parameters

None.

Response Information

Resource Description

List of ClientSponsoredBalance

Collection of ClientSponsoredBalance

Name	Description	Type	Additional information
ClientID	TPP client identifier.	integer	None.
ClientRef	Account reference from 3rd party front office systems.	string	None.
Balances	List of Client's Broker Sponsored balance by Security Code.	Collection of ClientSponsoredBalance+SponsoredBalance	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 123456,
    "ClientRef": "XX123",
    "Balances": [
      {
        "SecurityCode": "ABC",
        "SecurityName": "Security name for ABC",
        "Registered": 123.45,
        "OutstandingObligations": 1,
        "OpenSells": 123.45,
        "Reserved": 123.45,
        "Subpoenaed": 123.45
      },
      {
        "SecurityCode": "DEF",
        "SecurityName": "Security name for DEF",
        "Registered": 123.45,
        "OutstandingObligations": 1,
        "OpenSells": 123.45,
        "Reserved": 123.45,
        "Subpoenaed": 123.45
      }
    ]
  },
  {
    "ClientID": 123456,
    "ClientRef": "XX123",
    "Balances": [
      {
        "SecurityCode": "ABC",
        "SecurityName": "Security name for ABC",
        "Registered": 123.45,
        "OutstandingObligations": 1,
        "OpenSells": 123.45,
        "Reserved": 123.45,
        "Subpoenaed": 123.45
      },
      {
        "SecurityCode": "DEF",
        "SecurityName": "Security name for DEF",
        "Registered": 123.45,
        "OutstandingObligations": 1,
        "OpenSells": 123.45,
        "Reserved": 123.45,
        "Subpoenaed": 123.45
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientSponsoredBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <ClientSponsoredBalance>
    <Balances>
      <ClientSponsoredBalance.SponsoredBalance>
        <OpenSells>123.45</OpenSells>
        <OutstandingObligations>1</OutstandingObligations>
        <Registered>123.45</Registered>
        <Reserved>123.45</Reserved>
        <SecurityCode>ABC</SecurityCode>
        <SecurityName>Security name for ABC</SecurityName>
        <Subpoenaed>123.45</Subpoenaed>
      </ClientSponsoredBalance.SponsoredBalance>
      <ClientSponsoredBalance.SponsoredBalance>
        <OpenSells>123.45</OpenSells>
        <OutstandingObligations>1</OutstandingObligations>
        <Registered>123.45</Registered>
        <Reserved>123.45</Reserved>
        <SecurityCode>DEF</SecurityCode>
        <SecurityName>Security name for DEF</SecurityName>
        <Subpoenaed>123.45</Subpoenaed>
      </ClientSponsoredBalance.SponsoredBalance>
    </Balances>
    <ClientID>123456</ClientID>
    <ClientRef>XX123</ClientRef>
  </ClientSponsoredBalance>
  <ClientSponsoredBalance>
    <Balances>
      <ClientSponsoredBalance.SponsoredBalance>
        <OpenSells>123.45</OpenSells>
        <OutstandingObligations>1</OutstandingObligations>
        <Registered>123.45</Registered>
        <Reserved>123.45</Reserved>
        <SecurityCode>ABC</SecurityCode>
        <SecurityName>Security name for ABC</SecurityName>
        <Subpoenaed>123.45</Subpoenaed>
      </ClientSponsoredBalance.SponsoredBalance>
      <ClientSponsoredBalance.SponsoredBalance>
        <OpenSells>123.45</OpenSells>
        <OutstandingObligations>1</OutstandingObligations>
        <Registered>123.45</Registered>
        <Reserved>123.45</Reserved>
        <SecurityCode>DEF</SecurityCode>
        <SecurityName>Security name for DEF</SecurityName>
        <Subpoenaed>123.45</Subpoenaed>
      </ClientSponsoredBalance.SponsoredBalance>
    </Balances>
    <ClientID>123456</ClientID>
    <ClientRef>XX123</ClientRef>
  </ClientSponsoredBalance>
</ArrayOfClientSponsoredBalance>