Syntax
Public Overrides Function transactionsLogReport (ByRef clientID As Integer, ByRef FromDate As String, ByRef ToDate As String, ByRef TicketOrder As Integer, ByVal Trans As Integer, ByRef TransType As Integer, ByVal Account As Integer, ByVal BuySell As OperationTypeEnum, ByVal LotsAmount As Double, ByRef SymbolID ByRef price As Double, ByRef closePrice As Double, ByRef WhoType As Integer, ByRef WhoID As Integer, ByRef IP As String, ByVal Method As String) As TransResult
This function is used to get the transaction log report which shows the entire transactions done in whole system or for a certain Account(s), office(s), or Group(s).After TransactionLogReport executes the ReportDataReceived event fire.
Parameters
Key | Description |
clientID | The client number which the report will show the transactions for all account under this client. Value of type is Integer. |
FromDate | Specify the duration. Value of type is String. Date in this format DD/MM/YYYY HH:NN:SS, means form beginning |
ToDate | Specify the duration. Value of type is String. Date in this format DD/MM/YYYY HH:NN:SS. means till now. |
TicketOrder | The report will show the transactions for this TicketID/OrderID. Value of type is Integer. 0 means for all orders. |
Trans | The report will show the transactions of these types. Value is Integer: 0 : All 1 : New 2 : Update 3 : Delete |
TransType | The report will show the transaction of these types. Value of type is Integer. 0 : All 1 : New 2 : liquidate 3 : Dp/Wd/Aj/Ci/Co 4 : TP/SL Order 5 : limit/Stop Order |
Account | The Report will show the transactions for this Account. Value of type is Integer. 0: means for all Account |
BuySell | The report will show the transactions of type OperationTypeEnum. 0: All type |
LotsAmount | The report will show the transactions of this amount. Value of type is Double. 0: means for all Lots amount |
SymbolID | The report will show the transaction of this Symbol. Value of type is Integer. 0: means for all symbol. |
price | The report will show the transactions of this price. Value of type is Integer. 0 : means for all Prices |
closePrice | The report will show the transactions of this close price.Value of type is Double 0: means for all close prices. |
WhoType | The report will show the transactions of Dealers or client. Value of type is Integer. 0: means for all 1: means for Dealers 2: means for client |
WhoID | The IDof Dealer or client. Value of type is Integer. 0 : means for All |
IP | The report will show the transactions of this IP. Value of type is String. means for All IPs |
Method | How the action was handled. It can be on of (Auto, Buy limit, Buy Stop , Sell limit, Sell Stop , Cancel, Cancelled- No money, Done, Hedge , Liquidate ,Manual , Order ,Take Profit, Stop Loss). Value of type is String. All BL means Buy Limit BS means buy Stop SL means Sell Limit & Stop Loss AUTO CANCEL CANCEL-NO MONEY DONE HEDGE LIQ means liquidate MANUAL ORDER TP means Take Profit |
Return value
Returns value of type TransResult. If the request was sent to server successfully it will return Succeeded.
Sample
Private Sub TransReport_Click (ByVal sender As System.Object, ByVal e As System.EventArgs) Handles TransReport.Click Dim Result As VertexFXBridgeAPI.TransResult Dim Root_ID As Integer = BO.GetBO.RootID Result= BO.GetBO.transactionsLogReport(Root_ID, ,,0,0,0,0,0,0,0,0,0,0,,) End Sub
Result:
The result of this report contains many details; the following table shows each column description
Data row Index | Column name | Description |
1 | Time | Shows the date and time of each transaction. |
2 | Ticket/Order | The Ticket/Order IDof each transaction. |
3 | Trans | The type of each transaction(New, Update, or Delete) |
4 | TransType | The type of the transaction. The following values equal: 1 New Position 2 Liquidate Position 3 Money Transaction (depends on TransSubType value). 4 Take Profit/Stop Loss transaction 5 Limit/Stop transaction |
5 | TransSubType | If the TransType equals (3 money transactions) then its equal 1: means Deposit. -1: means Withdrawal. 2: means Adjusment. 3: means Credit In. -3 : means Credit Out. If the TransType equal (5 limit/Stop Transaction) then its equal 1: means Buy limit type. -1: means Sell limit type. 2: means Buy Stop type. -2 : means Sell Stop type. |
6 | TicketOrder2 | Open Position ID if TransType equals 2 (Liquidate position) |
7 | Account | Account ID for each transaction. |
8 | B/S | The type of order(Buy/Sell) |
9 | Amount | Amount for each transaction. |
10 | SymbolID | The symbol ID for each transaction (if the transaction belongs to money transactions it will be empty). |
11 | PriceSL | The open Price or Stop loss price for each transaction (if the transaction belongs to money transactions it will be empty). |
12 | Close Price / TP | The close price or the take profit price for each transaction (if the transaction belongs to money transactions it will be empty). |
13 | Commission | The commission amount for each transaction. (If the transaction belongs to money transactions it will be empty). |
14 | Interest | The interest amount for each transaction. (If the transaction belongs to money transactions it will be empty). |
15 | Ref Symbol price | The ref Symbol price for each transaction (if the transaction belongs to money transactions it will be empty). |
16 | Who Type | The person type (Dealer / Client) who performed each transaction. |
17 | Who name | The Dealer/Client name who performed each transaction. |
18 | Method | How the action was handled, it can be one of (Auto, But Limit, Buy Stop, Sell Limit, Sell stop, Cancel, Cancel No money, Done, Hedge, Liquidate, Manual, Order, Take Profit , Stop Loss. |
19 | IP | The IP address of the dealer/ client who performed each transaction. |
20 | Profit | The profit amount for each transaction. |
21 | SymbolName | The symbol name for each transaction (if the transaction belongs to money transactions it will be empty). |
22 | ClientID | Client number which transactions belong to. |
23 | TicketOrder3 | Open position if the transaction equal (5 Limit/Stop). |
See Also