GET api/account/cash?clientID={clientID}&adviserID={adviserID}&personID={personID}

Get cash balances.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Client ID to filter on.	integer	None.
adviserID	Adviser ID to filter on.	integer	None.
personID	Person ID to filter on.	integer	None.

Body Parameters

None.

Response Information

Resource Description

Cash balance for a client account.

Collection of ClientCashBalance

Name	Description	Type	Additional information
ClientID	Unique client identifier.	integer	None.
Balances	Available balance.	Collection of CashBalance	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 1234,
    "Balances": [
      {
        "AccountID": 100500,
        "Balance": 10000.0,
        "AvailableBalance": 9860.0
      }
    ]
  },
  {
    "ClientID": 5678,
    "Balances": [
      {
        "AccountID": 100500,
        "Balance": 10000.0,
        "AvailableBalance": 9860.0
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientCashBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Cash">
  <ClientCashBalance>
    <Balances>
      <CashBalance>
        <AccountID>100500</AccountID>
        <AvailableBalance>9860.00</AvailableBalance>
        <Balance>10000.00</Balance>
      </CashBalance>
    </Balances>
    <ClientID>1234</ClientID>
  </ClientCashBalance>
  <ClientCashBalance>
    <Balances>
      <CashBalance>
        <AccountID>100500</AccountID>
        <AvailableBalance>9860.00</AvailableBalance>
        <Balance>10000.00</Balance>
      </CashBalance>
    </Balances>
    <ClientID>5678</ClientID>
  </ClientCashBalance>
</ArrayOfClientCashBalance>

Error Response Information

Resource Description

Cash balance for a client account.

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>