Knowledgebase:
TransactionsLogReport
Posted by Mohammad Rahhal, Last modified by Rawan Al Hourani on 11 February 2018 09:46 AM

Syntax

 Public Function TransactionsLogReport(ClientID As Integer, FromDate As String, ToDate As String, TicketOrder As Integer, Trans As Integer, TransType As Integer, Account As Integer, BuySell As VertexGeneral10.OperationTypeEnum,lotsAmount As Double,SymbolID As Integer,Price As Double,ClosePrice As Double,WhoType As Integer,WhoID As Integer, IP As String,Method As String,TransTag As String) As CallingResultsEnum

This function used to get the transaction log report that show the entire transactions done in whole system or for a certain account(s),Office(s), or Group(s) , after TransactionsLogReport executes the ReportDataReceived event fire.

Parameters

Parameter Description 
ClientID The report will show the transactions for all account under this client.
FromDate Specify the duration.
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means from beginning
ToDate Specify the duration.
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means till now
TicketOrder The report will show the transactions for this TicketID/OrderID.
0 means for all orders
Trans The report will show the transactions of these types :
0  All.
1 New.
2 Update.
3 Delete.
TransType

The report will show the transactions of these types :
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.
0 means for all Accounts
BuySell The report will show the transactions of type OperationTypeEnum
0  All type
LotsAmount  The report will show the transactions of this amounts.
0 means for all lots amoumts 
SymbolID The report will show the transactions of this symbol.
0 means for all symbols
Price The report will show the transactions of this price.
0 means for all prices
ClosePrice  The report will show the transactions of this close price.
0 means for all close prices
WhoType The report will show the transactions of Dealers or client.
0 means for all 
1 means for Dealers
2 means for Client
WhoID The ID of Dealer or Client
0 All
-1 System 
IP The report will show the transactions of this IP
“” means for all IPs
Method

How the action was handled, it can be one of (Auto, Buy Limit, Buy Stop, Sell Limit, Sell Stop, Cancel, Cancelled - No Money, Done, Hedge, Liquidate, Manual, Order, Take Profit, Stop Loss).

"" All
"BL" means buy limit
"BS" means buy stop
"SL" means sell limit & stop loss
"SS" means sell stop
"AUTO"
"CANCEL"
"CANCELLED-NO MONEY" 
"DONE"
"HEDGE"
"LIQ" means liquidate
"MANUAL"
"ORDER"
"TP" means take profit
TransTag

String value used to mark the requested report when the result came from server

Return value
Return value of type CallingResultsEnum, if the request sent to server successfully it will return SuccessResult

Sample

 Private Sub GetTranLog_Click (ByVal sender As System.Object, ByVal e As System.EventArgs) Handles GetTranLog.Click

       ‘BOAPI is a predefined variable as CVertexBOAPI10  

     Dim Result As CallingResultsEnum

     vSymbol = BOAPI.SymbolByName ("USD/CHF")

     If (vSymbol IsNot Nothing) Then

       Result = BOAPI.TransactionsLogReport (BOAPI.RootID, "", "", 0, 0, 0, 0, 0, 0,vSymbol.ID, 0, 0, 0,0,"","")

       vSymbol = Nothing

     End If

 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 Time Shows the date and time for each transaction
2 Ticket/ Order The ticket/order ID for each transaction
3 Trans The type of each transaction (New, Update, or Delete)
4 TransType The type of the transaction, its value equal either of: 1 means 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 equal (3 Money Transaction), then its value equal: 1 means "Deposit", -1  "Withdrawal", 2 "Adjustment",  3 "Credit In", -3  "Credit Out".

If the TransType equal (5 Limit/Stop Transaction), then its value equal: 1 means "Buy Limit Type", -1 "Sell Limit Type", 2 "Buy Stop Type", -2 "Sell Stop Type"

6 TicketOrder2

Open position ID if TransType equal 2 (Liquidate Position)

7 Account The account ID for each transaction
8 B/S The type of the order (Buy/ Sell)
9 Amount The amount for each transaction
10 SymbolID The symbol ID for each transaction (If the transaction belongs to a money transaction it will be empty)
11 Price /SL The open price or the stop loss price for each transaction (If the transaction belongs to a money transaction it will be empty)
12 Close Price /TP The close price or the take profit price for each transaction (If the transaction belongs to a money transaction it will be empty)
13 commission  The commission amount for each transaction (If the transaction belongs to a money transaction it will be empty)
14 interest  The interest amount for each transaction (If the transaction belongs to a money transaction it will be empty)
15 Ref symbol price The ref symbol price for each transaction
16 WhoType The person type (Dealer/Client) who performed for each transaction
17 Who The Dealer/Client name who performed for each transaction
18 Method How the action was handled, it can be one of (Auto, Buy Limit, Buy Stop, Sell Limit, Sell Stop, Cancel, Cancelled - 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 Symbol name  The symbol name for each transaction (If the transaction belongs to a money transaction it will be empty).
22 Clinet ID Client number which transaction belong to , value of type Integer.
23 TicketOrder3 Open position ID if TransType equal 5 (Limit/Stop).
24 TransTag The same string which sent by the requested report.

See Also


VertexFX Backoffice API Index

(1 vote(s))
Helpful
Not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please enter the text you see in the image into the textbox below (we use this to prevent automated submissions).

Help Desk Software by Hybrid Solutions