GET api/bfg/v1/funds?clientId={clientId}

Get client available funds.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client ID to retrieve all funds	integer	Required

Body Parameters

None.

Response Information

Resource Description

Available funds for the client.

AvailableFundsResponse

Name	Type	Additional information
ExposureLimit	decimal number	None.
OpenBuyOrders	decimal number	None.
UnsettledOrders	decimal number	None.
AvailableFunds	decimal number	None.
CashBalance	decimal number	None.
TrustBalance	decimal number	None.
FundsForTransfer	decimal number	None.
DefaultFundingSourceType	enFundingSourceType	None.
DMLMarketValue	decimal number	None.
DMLGearedValue	decimal number	None.
DMLTotalLoans	decimal number	None.
DMLSurplus	decimal number	None.
DMLCreditLimit	decimal number	None.
DMLClientEquity	decimal number	None.
DMLGearingRatio	decimal number	None.
DMLBuyingPower	decimal number	None.
DMLAvailableFund	decimal number	None.
DMLMarginRatio	decimal number	None.
DMLCurrentLVR	decimal number	None.
DMLMarketFallSensitivity	decimal number	None.
DMLReservedOpenBuy	decimal number	None.
DMLAvailableFundPosition	decimal number	None.
DMLUnusedCreditLimit	decimal number	None.
DMLSwingBalance	decimal number	None.
IsExternalCashAccount	boolean	None.
UnSettledSellOrders	decimal number	None.
BankBalance	decimal number	None.
AvailableCashBalance	decimal number	None.
CashHoldAmount	decimal number	None.
UnsettledBuyOrdersNotHeld	decimal number	None.
OpenBuyOrdersNotHeld	decimal number	None.
NetEquity	decimal number	None.
BlockedEquity	decimal number	None.
BlockedFunds	decimal number	None.
BlockedOrders	decimal number	None.
AvailableRiskLimit	decimal number	None.
UtilisedRiskLimit	decimal number	None.
TotalRiskLimit	decimal number	None.
BreachPercent	decimal number	None.
InMarginCall	boolean	None.
IsMarginLendingAccount	boolean	None.
IsDMLAccount	boolean	None.
MarginLenderName	string	None.
InternationalCashAvailableForTrade	decimal number	None.
InternationalCashAvailableForWithdrawal	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "ExposureLimit": 1.0,
  "OpenBuyOrders": 2.0,
  "UnsettledOrders": 3.0,
  "AvailableFunds": 4.0,
  "CashBalance": 5.0,
  "TrustBalance": 6.0,
  "FundsForTransfer": 7.0,
  "DefaultFundingSourceType": 1,
  "DMLMarketValue": 8.0,
  "DMLGearedValue": 9.0,
  "DMLTotalLoans": 10.0,
  "DMLSurplus": 11.0,
  "DMLCreditLimit": 12.0,
  "DMLClientEquity": 13.0,
  "DMLGearingRatio": 1.0,
  "DMLBuyingPower": 14.0,
  "DMLAvailableFund": 15.0,
  "DMLMarginRatio": 1.0,
  "DMLCurrentLVR": 1.0,
  "DMLMarketFallSensitivity": 1.0,
  "DMLReservedOpenBuy": 16.0,
  "DMLAvailableFundPosition": 17.0,
  "DMLUnusedCreditLimit": 18.0,
  "DMLSwingBalance": 1.0,
  "IsExternalCashAccount": true,
  "UnSettledSellOrders": 20.0,
  "BankBalance": 21.0,
  "AvailableCashBalance": 22.0,
  "CashHoldAmount": 23.0,
  "UnsettledBuyOrdersNotHeld": 24.0,
  "OpenBuyOrdersNotHeld": 25.0,
  "NetEquity": 26.0,
  "BlockedEquity": 27.0,
  "BlockedFunds": 28.0,
  "BlockedOrders": 29.0,
  "AvailableRiskLimit": 30.0,
  "UtilisedRiskLimit": 31.0,
  "TotalRiskLimit": 32.0,
  "BreachPercent": 1.0,
  "InMarginCall": true,
  "IsMarginLendingAccount": true,
  "IsDMLAccount": true,
  "MarginLenderName": "sample string 36",
  "InternationalCashAvailableForTrade": 1.0,
  "InternationalCashAvailableForWithdrawal": 1.0
}

application/xml, text/xml

Sample:

<AvailableFundsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Funds">
  <AvailableCashBalance>22</AvailableCashBalance>
  <AvailableFunds>4</AvailableFunds>
  <AvailableRiskLimit>30</AvailableRiskLimit>
  <BankBalance>21</BankBalance>
  <BlockedEquity>27</BlockedEquity>
  <BlockedFunds>28</BlockedFunds>
  <BlockedOrders>29</BlockedOrders>
  <BreachPercent>1</BreachPercent>
  <CashBalance>5</CashBalance>
  <CashHoldAmount>23</CashHoldAmount>
  <DMLAvailableFund>15</DMLAvailableFund>
  <DMLAvailableFundPosition>17</DMLAvailableFundPosition>
  <DMLBuyingPower>14</DMLBuyingPower>
  <DMLClientEquity>13</DMLClientEquity>
  <DMLCreditLimit>12</DMLCreditLimit>
  <DMLCurrentLVR>1</DMLCurrentLVR>
  <DMLGearedValue>9</DMLGearedValue>
  <DMLGearingRatio>1</DMLGearingRatio>
  <DMLMarginRatio>1</DMLMarginRatio>
  <DMLMarketFallSensitivity>1</DMLMarketFallSensitivity>
  <DMLMarketValue>8</DMLMarketValue>
  <DMLReservedOpenBuy>16</DMLReservedOpenBuy>
  <DMLSurplus>11</DMLSurplus>
  <DMLSwingBalance>1</DMLSwingBalance>
  <DMLTotalLoans>10</DMLTotalLoans>
  <DMLUnusedCreditLimit>18</DMLUnusedCreditLimit>
  <DefaultFundingSourceType>CashAccount</DefaultFundingSourceType>
  <ExposureLimit>1</ExposureLimit>
  <FundsForTransfer>7</FundsForTransfer>
  <InMarginCall>true</InMarginCall>
  <InternationalCashAvailableForTrade>1</InternationalCashAvailableForTrade>
  <InternationalCashAvailableForWithdrawal>1</InternationalCashAvailableForWithdrawal>
  <IsDMLAccount>true</IsDMLAccount>
  <IsExternalCashAccount>true</IsExternalCashAccount>
  <IsMarginLendingAccount>true</IsMarginLendingAccount>
  <MarginLenderName>sample string 36</MarginLenderName>
  <NetEquity>26</NetEquity>
  <OpenBuyOrders>2</OpenBuyOrders>
  <OpenBuyOrdersNotHeld>25</OpenBuyOrdersNotHeld>
  <TotalRiskLimit>32</TotalRiskLimit>
  <TrustBalance>6</TrustBalance>
  <UnSettledSellOrders>20</UnSettledSellOrders>
  <UnsettledBuyOrdersNotHeld>24</UnsettledBuyOrdersNotHeld>
  <UnsettledOrders>3</UnsettledOrders>
  <UtilisedRiskLimit>31</UtilisedRiskLimit>
</AvailableFundsResponse>