GET api/account/{clientID}/availablefunds

Get available funds for client account

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Client ID.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Available funds details

AvailableFundsResult

Name	Description	Type	Additional information
ExposureLimit	Exposure Limit or Trading Limit	decimal number	None.
OpenBuyOrders	Open Buy Orders	decimal number	None.
UnsettledOrders	Unsettled Orders	decimal number	None.
AvailableFunds	Avail Trading Funds or Available Funds or Available to Trade	decimal number	None.
CashBalance	Bell Cash Trust or Direct Investment Account or Macquarie CMA	decimal number	None.
TrustBalance	Trust Account	decimal number	None.
FundsForTransfer	Avail Transfer Funds	decimal number	None.
DefaultFundingSourceType	Funding Source Type	enFundingSourceType	None.
DMLMarketValue	Market Value (Direct Margin Lending)	decimal number	None.
DMLGearedValue	Geared Value (Direct Margin Lending)	decimal number	None.
DMLTotalLoans	Loan (Direct Margin Lending)	decimal number	None.
DMLSurplus	Surplus (Direct Margin Lending)	decimal number	None.
DMLCreditLimit	Credit Limit (Direct Margin Lending)	decimal number	None.
DMLClientEquity	Client Equity (Direct Margin Lending)	decimal number	None.
DMLGearingRatio	Gear ratio (Direct Margin Lending)	decimal number	None.
DMLBuyingPower	Potential Buying Power (Direct Margin Lending)	decimal number	None.
DMLAvailableFund	Available Funds (Direct Margin Lending)	decimal number	None.
DMLMarginRatio	Margin Ratio (Direct Margin Lending)	decimal number	None.
DMLCurrentLVR	Current LVR (Direct Margin Lending)	decimal number	None.
DMLMarketFallSensitivity	How much can the market fall before I am margin called? (Direct Margin Lending)	decimal number	None.
DMLReservedOpenBuy	Reserved for Open Buy Orders (Direct Margin Lending)	decimal number	None.
DMLAvailableFundPosition	Available (Direct Margin Lending)	decimal number	None.
DMLUnusedCreditLimit	Unused Credit Limit (Direct Margin Lending)	decimal number	None.
IsExternalCashAccount	Indicates if cash account is external i.e. HSBC, Macquarie etc	boolean	None.
UnSettledSellOrders	Unsettled Sells	decimal number	None.
BankBalance	Bank Balance	decimal number	None.
AvailableCashBalance	Available Cash Balance	decimal number	None.
CashHoldAmount	Holds on Cash	decimal number	None.
UnsettledBuyOrdersNotHeld	Unsettled Buys not held	decimal number	None.
OpenBuyOrdersNotHeld	Open Buy Orders not held	decimal number	None.
NetEquity	Net Equity	decimal number	None.
BlockedEquity	Blocked Equity	decimal number	None.
BlockedFunds	Blocked Funds	decimal number	None.
BlockedOrders	Blocked Orders	decimal number	None.
AvailableRiskLimit	Available Risk Limit	decimal number	None.
UtilisedRiskLimit	Utilised Risk Limit	decimal number	None.
TotalRiskLimit	Total Risk Limit	decimal number	None.
BreachPercent	Account in Margin Breach (if applicable)	decimal number	None.
InMarginCall	Indicates if the client account is in margin call (if applicable). If in margin call, then BreachPercent is to be displayed.	boolean	None.
MarginLenderName	Margin lender name	string	None.
InternationalCashAvailableForTrade	International Cash Available For Trade	decimal number	None.
InternationalCashAvailableForWithdrawal	International Cash Available For Withdrawal	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "ExposureLimit": 100.0,
  "OpenBuyOrders": 0.0,
  "UnsettledOrders": 0.0,
  "AvailableFunds": 200.0,
  "CashBalance": 200.0,
  "TrustBalance": 150.0,
  "FundsForTransfer": 200.0,
  "DefaultFundingSourceType": 1,
  "DMLMarketValue": 0.0,
  "DMLGearedValue": 0.0,
  "DMLTotalLoans": 0.0,
  "DMLSurplus": 0.0,
  "DMLCreditLimit": 0.0,
  "DMLClientEquity": 0.0,
  "DMLGearingRatio": null,
  "DMLBuyingPower": 0.0,
  "DMLAvailableFund": 0.0,
  "DMLMarginRatio": null,
  "DMLCurrentLVR": null,
  "DMLMarketFallSensitivity": null,
  "DMLReservedOpenBuy": 0.0,
  "DMLAvailableFundPosition": 0.0,
  "DMLUnusedCreditLimit": 0.0,
  "IsExternalCashAccount": false,
  "UnSettledSellOrders": 0.0,
  "BankBalance": 0.0,
  "AvailableCashBalance": 0.0,
  "CashHoldAmount": 0.0,
  "UnsettledBuyOrdersNotHeld": 0.0,
  "OpenBuyOrdersNotHeld": 0.0,
  "NetEquity": 100.0,
  "BlockedEquity": 0.0,
  "BlockedFunds": 0.0,
  "BlockedOrders": 0.0,
  "AvailableRiskLimit": 0.0,
  "UtilisedRiskLimit": 0.0,
  "TotalRiskLimit": 0.0,
  "BreachPercent": null,
  "InMarginCall": false,
  "MarginLenderName": "",
  "InternationalCashAvailableForTrade": 0.0,
  "InternationalCashAvailableForWithdrawal": 0.0
}

application/xml, text/xml

Sample:

<AvailableFundsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Account">
  <AvailableCashBalance>0</AvailableCashBalance>
  <AvailableFunds>200</AvailableFunds>
  <AvailableRiskLimit>0</AvailableRiskLimit>
  <BankBalance>0</BankBalance>
  <BlockedEquity>0</BlockedEquity>
  <BlockedFunds>0</BlockedFunds>
  <BlockedOrders>0</BlockedOrders>
  <BreachPercent i:nil="true" />
  <CashBalance>200</CashBalance>
  <CashHoldAmount>0</CashHoldAmount>
  <DMLAvailableFund>0</DMLAvailableFund>
  <DMLAvailableFundPosition>0</DMLAvailableFundPosition>
  <DMLBuyingPower>0</DMLBuyingPower>
  <DMLClientEquity>0</DMLClientEquity>
  <DMLCreditLimit>0</DMLCreditLimit>
  <DMLCurrentLVR i:nil="true" />
  <DMLGearedValue>0</DMLGearedValue>
  <DMLGearingRatio i:nil="true" />
  <DMLMarginRatio i:nil="true" />
  <DMLMarketFallSensitivity i:nil="true" />
  <DMLMarketValue>0</DMLMarketValue>
  <DMLReservedOpenBuy>0</DMLReservedOpenBuy>
  <DMLSurplus>0</DMLSurplus>
  <DMLTotalLoans>0</DMLTotalLoans>
  <DMLUnusedCreditLimit>0</DMLUnusedCreditLimit>
  <DefaultFundingSourceType>CashAccount</DefaultFundingSourceType>
  <ExposureLimit>100</ExposureLimit>
  <FundsForTransfer>200</FundsForTransfer>
  <InMarginCall>false</InMarginCall>
  <InternationalCashAvailableForTrade>0</InternationalCashAvailableForTrade>
  <InternationalCashAvailableForWithdrawal>0</InternationalCashAvailableForWithdrawal>
  <IsExternalCashAccount>false</IsExternalCashAccount>
  <MarginLenderName></MarginLenderName>
  <NetEquity>100</NetEquity>
  <OpenBuyOrders>0</OpenBuyOrders>
  <OpenBuyOrdersNotHeld>0</OpenBuyOrdersNotHeld>
  <TotalRiskLimit>0</TotalRiskLimit>
  <TrustBalance>150</TrustBalance>
  <UnSettledSellOrders>0</UnSettledSellOrders>
  <UnsettledBuyOrdersNotHeld>0</UnsettledBuyOrdersNotHeld>
  <UnsettledOrders>0</UnsettledOrders>
  <UtilisedRiskLimit>0</UtilisedRiskLimit>
</AvailableFundsResult>