Syntax
Public Function AccountStatusReport (ClientID As Integer, AccountType As Integer,TransTag As String) As CallingResultsEnum
Description
This function is used to show the account status for all accounts under the given client,After AccountStatusReport executes the ReportDataReceived event fire.
Parameters
Parameter |
Description |
ClientID |
The report will return the status for the accounts under this client |
AccountType |
The type of the accounts that will appear in the report, wither it is for the normal accounts or for the coverage accounts, and then Press Report. 1 normal accounts 2 coverage accounts |
TrasnTag |
String value used to mark the requested report when the result came from the server |
Rerurn value
Return value of type CallingResultsEnum, if the request sent to the server successfully it will return SuccessResult
Sample
Private Sub Report_Click(sender As System.Object, e As System.EventArgs) Handles Report.Click
' BOAPI is a predefined variable as CVertexBOAPI10
Dim Result As CallingResultsEnum
Result= BOAPI.AccountStatusReport (BOAPI.RootID, 1,"")
End Sub
Results
The result of this report contains many details, the following table shows each column description:
Data row index |
Column Name |
Description |
1 |
Account |
Shows the account ID for each client under the group that you have chosen for the generated report. |
2 |
Balance |
The balance amount for each account |
3 |
Credit |
The credit amount for each account. |
4 |
Flt P/L |
The floating profit/ loss for each account. |
5 |
Margin Req |
The requirement margin for each account (Used margin) |
6 |
Client ID |
The client ID for the account
|
7 |
commission |
The commission amount for each account |
8 |
Trading P/L |
The profit/ loss for each account |
9 |
TransTag |
The same string which sent by the requested report. |
NOTE : Equity = Balance + Credit + Flt P\L
Margin level ----> If margin Req (used Margin) = 0 Then Margin level = 100%
Else Margin level = Math.Round(100 * Equity / MarginReq, 2).ToString() + "%"
Free Margin = Equity - margin Req
Net Credit ---> If Credit > Equity Then Net Credit = Credit - Equity
Else Net Credit = 0
Net Equity ---> If Equity > Credit Then Net Equity= Equity - Credit
Else Net Equity = 0
See Also
VertexFX Backoffice API Index
|