Knowledgebase - Help Desk

LoginHistoryReport

Syntax Public Overrides Function LoginHistoryReport( ByRef ClientID As Integer , ByRef FromDate As String, ByRef ToDate As String, ByRef IP As String, ByRef API As Integer, ByRef Username As String, ByRef succeededFailed As Integer, ByRef WhoType As Inte...

MarketOrdersHistoryReport

Syntax Public Overrides Function MarketOrdersHistoryReport(ByRef ClientID As Integer , ByRef FromDate As String, ByRef ToDate As String, ByRef OrderID As Integer, ByRef Ticket As Integer, ByRef AccountID As Integer, ByRef transType As String, ByRef Order...

PendingOrdersReport

Syntax Public Overrides Function PendingOrdersReport(ByRef ClientID As Integer , ByRef FromDate As String, ByRef ToDate As String, ByRef AccountId As Integer, ByRef OrderType As Integer, ByRef lots As Double, ByRef SymbolID As Integer, ByRef Price As Dou...

DetailedOpenPositionsReport

Syntax Public Overrides Function DetailedOpenPositionsReport(ByRef ClientID As Integer , ByRef AccountType As Integer, ByVal SymbolID As Integer, ByVal PositionType As Integer) As TransResult This function is used to get detailed open positions report w...

NetOpenPositionsReport

Syntax Public Overrides Function NetOpenPositionsReport(ByRef ClientID As Integer , ByRef AccountType As Integer, ByVal SymbolID As Integer, ByVal PositionType As Integer) As TransResult This function is used to get the net open positions report which s...

MaintenanceMarginCallReport

Syntax Public Overrides Function MaintenanceMarginCallReport(ByRef ClientID As Integer) As TransResult This function is used to get the maintenance margin call report which shows the close account(s) to liquidate. If the effective margin gets less than ...

AccountInformationReport

Syntax Public Overrides Function AccountInformationReport(ByRef ClientID As Integer) As TransResult This function is used to get the account information report which shows the information for all accounts under the client. After AccountInformationReport...

AccountStatusReport

Syntax Public Overrides Function AccountStatusReport(ByRef ClientID As Integer,ByRef AccountType As Integer) As TransResult This function is used to show the account status for all accounts under the given client. After AccountStatusReport executes the ...

MoneyTransactionsReport

Syntax Public Overrides Function MoneyTransactionsReport(ByRef ClientID As Integer,ByRef TransactionType As Integer, ByRef fromDate As String, ByRef ToDate As String) As TransResult This function is used to get the money transaction report which shows a...

SMSReport

Syntax Public Overrides Function SMSReport(ByRef ClientID As Integer, ByRef fromDate As String, ByRef ToDate As String) As TransResult This function is used to get the SMS report which shows the details of each SMS sent in the whole system or for a cert...

SymbolLotsReport

Syntax Public Overrides Function SymbolLotsReport(ByRef ClientID As Integer, ByRef fromDate As String, ByRef ToDate As String) As VertexFXBridgeAPI.TransResult This function is used to get the symbol lots report which shows the net closed positions on e...

SymbolTypesReport

Syntax Public Overrides Function SymbolTypesReport (ClientID As Integer, ByRef fromDate As String, ByRef ToDate As String) As TransResult This function is used to get the symbol type report which shows the net closed positions for the symbol types (Spot...

transactionsLogReport

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...

ManualDeleteSLTPOrder

Syntax Public Overrides Function ManualDeleteSLTPOrder (ByVal AccountID As Integer, ByVal OrderID As Integer) As VertexFXBridgeAPI.TransResult This function is used to delete a manage order for a specific account number. After ManualDeleteSLTPOrder meth...

ManualUpdateSLTPOrder

Syntax Public Overrides Function ManualUpdateSLTPOrder (ByVal AccountID As Integer, ByVal OrderID As Integer, ByVal lots As Double, ByVal OrderType As VertexFXBridgeAPI.OperationTypeEnum, ByVal SymbolName As String, Optional ByVal SL As Object = "", Opti...

ManualNewSLTPOrder

Syntax Public Overrides Function ManualNewSLTPOrder (ByVal AccountID As Integer, ByVal Ticket As Integer, ByVal Lots As Double ,ByVal OrderType As VertexFXBridgeAPI .OperationTypeEnum , ByVal SymbolID As String , Optional ByVal SL As Object = "" , Option...

ManualDeleteLimitOrder

Syntax Public Overrides Function ManualDeleteLimitOrder (ByVal AccountID As Integer, ByVal OrderID As Integer) As VertexFXBridgeAPI.TransResult This function is used to cancel an entry order for a specific account number. After ManualDeleteLimitOrder me...

ManualUpdateLimitOrder

Syntax Public Overrides Function ManualUpdateLimitOrder (ByVal AccountID As Integer, ByVal OrderID As Integer, ByVal OrderType As VertexFXBridgeAPI.OperationTypeEnum, ByVal Lots As Double, ByVal SymbolName As String, ByVal NewPrice As Double, Optional By...

ManualNewLimitOrder

Syntax Public Overrides Function ManualNewLimitOrder (ByVal AccountID As Integer, ByVal OrderType As VertexFXBridgeAPI.OperationTypeEnum, ByVal SymbolID As Integer,ByVal Lots As Double, ByVal AtPrice As Double, Optional ByVal SL As Object = "", Optional ...

RejectMultipleOrders

Syntax Public Overrides Function RejectMultipleOrders (ByVal BOOrderIDs As String) As VertexFXBridgeAPI.TransResult This function is used to reject multiple clients orders, After RejectMultipleOrders method executes the BORejectResultRecievied [http://w...

AcceptMultipleOrders

Syntax Public Overrides Function AcceptMultipleOrders (ByVal BOOrderIDs As String) As VertexFXBridgeAPI.TransResult This function is used to accept multiple clients orders; after AcceptMultipleOrders method executes the BOAcceptResultRecievied [http://w...

RejectRequotedOrder

SYNTAX Public Overrides Function RejectRequotedOrder(ByVal OrderID As String) As TransResult DESCRIPTION This function should reject re-quoted order with the LP, this will return an object of type TransResult [http://www.hybridsolutions.com/support/ind...

AcceptRequotedOrder

SYNTAX Public Overrides Function AcceptRequotedOrder(ByVal OrderID As String,ByVal NewPrice As Double)As TransResult DESCRIPTION This function should accept re-quoted order with the LP, this will return an object of type TransResult [http://www.hybrids...

CloseByHedge

SYNTAX Public Overrides Function CloseByHedge(ByVal LPOrderID1 As String, ByVal LPOrderID2 As String, ByVal BuySell1 As OperationType, ByVal BuySell2 As OperationType, ByVal Amount As Double, ByVal LPSymbolName As String, ByVal LPAccountID As String, ByV...

CloseMarketOrder

SYNTAX Public Overrides Function CloseMarketOrder (ByVal LPOrderID As String, ByVal BuySell As OperationType, ByVal Amount As Double, ByVal LPSymbolName As String, ByVal LPAccountID As String, ByVal BOOrderID As String, ByVal BOAccountID As String, ByVa...

NewSLTPOrder

SYNTAX Public Overrides Function NewSLTPOrder(ByVal LPOrderID As String, ByVal BuySell As OperationType, ByVal Amount As Double, ByVal LPSymbolName As String, ByVal LPAccountID As String, ByVal BOOrderID As String, ByVal BOAccountID As String, Optional B...

DeleteSLTPOrder

SYNTAX Public Overrides Function DeleteSLTPOrder(ByVal LPOrderID As String, ByVal BuySell As OperationType, ByVal Amount As Double, ByVal LPSymbolName As String, ByVal LPAccountID As String, ByVal BOOrderID As String, ByVal BOAccountID As String) As Tran...

UpdateSLTPOrder

SYNTAX Public Overrides Function UpdateSLTPOrder(ByVal LPOrderID As String, ByVal BuySell As OperationType, ByVal Amount As Double, ByVal LPSymbolName As String, ByVal LPAccountID As String, ByVal BOOrderID As String, ByVal BOAccountID As String, Option...

DeleteLimitOrder

SYNTAX Public Overrides Function DeleteLimitOrder(ByVal LPOrderID As String, ByVal LOType As LimitOrderType, ByVal Amount As Double, ByVal LPSymbolName As String, ByVal LPAccountID As String, ByVal BOOrderID As String, ByVal BOAccountID As String) As Tr...

UpdateLimitOrder

SYNTAX Public Overrides Function UpdateLimitOrder(ByVal LPOrderID As String, ByVal LOType As LimitOrderType, ByVal Amount As Double, ByVal LPSymbolName As String, ByVal LimitPrice As Double, ByVal LPAccountID As String, ByVal BOOrderID As String, ByVal B...

UpdateLimitOrder

Syntax Public Overrides Function UpdateLimitOrder(ByVal OrderID As Long, ByVal Lots As Double, ByVal NewPrice As Double, Optional ByVal SL As Object = "", Optional ByVal TP As Object = "") As TransResult This function is used to update updating a limit/...

UpdateSLTPOrder

Syntax Public Overrides Function UpdateSLTPOrder(ByVal OrderID As Long, ByVal Lots As Double, Optional ByVal SL As Object = "", Optional ByVal TP As Object = "") As TransResult This function is used to update an SL/TP order. PARAMETERS Key Descr...

SwitchOrder

Syntax Public Overrides Function SwitchOrder(ByVal OrderID As Integer) As TransResult This function is used to pass the order to another available dealer, and returns an integer value of type TransResult [http://www.hybridsolutions.com/support/index.php...

StopOffset

Syntax Public Overrides Function StopOffset(ByVal SymbolName As String) As Double This function is used to returns the Stop Offset for specific symbol. PARAMETERS Key Description SymbolName Symbol name of type string -------------------...

Spread

Syntax Public Overrides Function Spread(ByVal SymbolName As String) As Double This function is used to return the spread for specific symbol. PARAMETERS Key Description SymbolName Symbol name of type string ------------------------- SE...

ServerGMTOffset

Syntax Public Overrides Function ServerGMTOffset() As Double This function is used to retrieve the server GMT offset as a value of type double. PARAMETERS No parameters. ------------------------- SEE ALSO * Spread [http://www.hybridsolutions.com/...

SendSMSToSelectedAccount

Syntax Public Overrides Function SendSMSToSelectedAccount(ByVal SMSText As String) As TransResult This function is used to send SMS to the already selected account. PARAMETERS Key Description SMSText Body of the SMS --------------------...

SendSMS

Syntax Public Overrides Function SendSMS(ByVal AccountID As Long, ByVal SMSText As String) As TransResult This function is used to send SMS to a specific client. PARAMETERS Key Description AccountID Account ID of the client you want to s...

SelectAccount

Syntax Public Overrides Function SelectAccount(ByVal AccountID As Long) As TransResult This function is used to select an account and load its pending orders and open positions. PARAMETERS Key Description AccountID AccountID of type long...

RootID

Syntax Public Overrides Function RootID() As Long This function is used to get the ID of the main accounts tree node. PARAMETERS No parameters. REMARKS You can use this property when you need the ID of the main accounts tree node for the connected d...

OrderSymbol

Syntax Public Overrides Function OrderSymbol(ByVal OrderID As Long)As Symbol This function is used to return the symbol for a specific order. PARAMETERS Key Description OrderID ID for the order you want to know the symbol using it REMAR...

OrderOpenPrice

Syntax Public Overrides Function OrderOpenPrice(ByVal OrderID As Long)As Double This function is used to know the open price for specific order. PARAMETERS Key Description OrderID Value of type long REMARKS If you want to retrieve an o...

OrderLots

Syntax Public Overrides Function OrderLots(ByVal OrderID As Long)As Double This function is used to know the amount of lots for a specific order. PARAMETERS Key Description OrderID ID for the order you want to know its lots amount REMAR...

OrderHitPrice

Syntax Public Overrides Function OrderHitPrice(ByVal OrderID As Long)As Double This function is used to know the order hit price. PARAMETERS Key Description OrderID Value of type long REMARKS You can use this function to know the order...

OrderBuySell

Syntax Public Overrides Function OrderBuySell(ByVal OrderID As Long)As OperationTypeEnum This function is used to recognize if your order type is Buy, Sell, BuyStop or SellStop. PARAMETERS Key Description OrderID ID for the order you wan...

OpenPositionsCount

Syntax Public Overrides Function OpenPositionsCount()As Long This function is used to inform you about the open positions count. PARAMETERS No parameters. REMARKS In the case you want to know how many open positions you have you can use this propert...

OpenPositionByTicket

Syntax Public Overrides Function OpenPositionByTicket(ByVal TicketID As Long)As Position This function is used to get the open positions by ticket ID. PARAMETERS Key Description TicketID Value of type Long REMARKS You can get any open ...

OpenPositionByIndex

Syntax Public Overrides Function OpenPositionByIndex(ByVal Index As Short)As Position This function is used to get the open positions by index. PARAMETERS Key Description Index Value of type short REMARKS If you want to list all the op...

OnlineSessions

Syntax Public Overrides Function OnlineSessions()As VBA.Collection This function is used to retrieve the collection of online sessions [http://www.hybridsolutions.com/support/index.php?/Knowledgebase/Article/View/4126]. PARAMETERS No parameters. ----...

NewSLTPOrder

Syntax Public Overrides Function NewSLTPOrder(ByVal Ticket As String, ByVal Lots As Double, Optional ByVal SL As Object = "", Optional ByVal TP As Object = "")As TransResult This function is used to create new SL/TP order. PARAMETERS Key Descrip...

NewLimitOrder

Syntax Public Overrides Function NewLimitOrder(ByVal OrderType As LimitOrderType, ByVal SymbolID As long, ByVal Lots As Double, ByVal AtPrice As Double, Optional ByVal SL As Object = "", Optional ByVal TP As Object = "")As TransResult This function is u...

Minimum Amount

Syntax Public Overrides Function MinimumAmount(ByVal SymbolName As String)As Double This function is used to return the minimum amount per deal for specific symbol. PARAMETERS Key Description SymbolName The symbol name of type string Sa...

Maximum Amount

Syntax Public Overrides Function MaximumAmount(ByVal SymbolName As String)As Double This function is used to return the maximum amount per deal for specific symbol. PARAMETERS Key Description SymbolName The symbol name of type string Sa...

LimitOffset

Syntax Public Overrides Function LimitOffset(ByVal SymbolName As String)As Double This function is used to return the Limit Offset for specific symbol. PARAMETERS Key Description SymbolName The symbol name of type string Sample Public ...

isChild

Syntax Public Overrides Function isChild(ByVal ClientID As Long, ByVal ParentID As Long)As Boolean This function is used to check if the client is child of office or group. PARAMETERS Key Description ClientID ID of the client ParentI...

GMTOffset

Syntax Public Overrides Function GMTOffset()As Double This function is used to retrieve the GMT offset as a value of type double. PARAMETERS No parameters. ------------------------- SEE ALSO * isChild [http://www.hybridsolutions.com/support/index...

FirstWhiteLabel

Syntax Public Overrides Function FirstWhiteLabel()As Long This function is used to retrieve the ID of white label that the dealer belongs to. PARAMETERS No parameters. ------------------------- SEE ALSO * GMTOffset [http://www.hybridsolutions.com...

DeleteSLTPOrder

Syntax Public Overrides Function DeleteSLTPOrder(ByVal OrderID As Long)As TransResult This function is used to delete an SL/TP orders. PARAMETERS Key Description OrderID Value of type long Sample Public Sub BOChatOrderReceived (ByVal ...

DeleteLimitOrder

Syntax Public Overrides Function DeleteLimitOrder(ByVal OrderID As Long)As TransResult This function is used to delete a limit/stop order. PARAMETERS Key Description OrderID Value of type long Sample Public Sub NewLimitOrderResult (ByV...

DealerUsername

Syntax Public Overrides Function DealerUsername(ByVal DealerID As Long)As String This function is used to get dealer's username by his ID. PARAMETERS Key Description DealerID ID of the Dealer REMARKS Used to retrieve dealer's username ...

ClosePosition

Syntax Public Overrides Function ClosePosition(ByVal AccountID As Long, ByVal Ticket As Long, ByVal Amount As Double, ByVal Price As Double, ByVal RefPrice As Double, ByVal Comm As Double)As TransResult This function is to close an open position at a sp...

ClientSymbol

Syntax Public Overrieds Function ClientSymbol(ByVal SymbolName As String, ByVal AccountID As Long)As Symbol This function takes the symbol ID and account ID, and returns an object of type Symbol with client spread. PARAMETERS Key Description ...

ClientsCount

Syntax Public Overrides Function ClientsCount()As Long This function gets the number of clients as a value of type long. PARAMETERS No Parameters. ------------------------- SEE ALSO * ClientSymbol [http://www.hybridsolutions.com/support/index.php...

ClientByIndex

Syntax Public Overrides Function ClientByIndex(ByVal Index As Integer)As Client This function returns the client of the given index number. PARAMETERS Key Description Index Value of type integer ------------------------- SEE ALSO * ...

ClientByID

Syntax Public Overrides Function ClientByID(ByVal ID As Long)As Client This function returns the client with the given ID. PARAMETERS Key Description ID Value of type long ------------------------- SEE ALSO * ClientByIndex [http://w...

ChatOrdersCount

Syntax Public Overrides Function ChatOrdersCount()As Long This function retrieves the orders number those existing in the chatting screen. PARAMETERS No parameters. ------------------------- SEE ALSO * ClientByID [http://www.hybridsolutions.com/s...

ChatOrdersByIndex

Syntax Public Overrides Function ChatOrderByIndex(ByVal Index As Integer)As Order This function retrieves the orders for corresponding index. PARAMETERS Key Description Index The order index of type integer ------------------------- SE...

AccountSummaries

Syntax Public Overrides Function AccountsSummaries(ByVal AccountID As Long, ByRef Balance As Double, ByRef FltPL As Double, ByRef Credit As Double, ByRef Equity As Double, ByRef marginReq As Double, ByRef MarginLevel As Double, ByRef EffMargin As Double)...

AccountsCount

Syntax Public Overrides Function AccountsCount(ByVal ClientID As Long)As Long This function displays the number of accounts of the given client ID. PARAMETERS Key Description ClientID Value of type long ------------------------- SEE AL...

AccountByIndex

Syntax Public Overrides Function AccountByIndex(ByVal ClientID As Long, ByVal Index As Integer)As Account This function displays an account by its index with the given client ID and index. PARAMETERS Key Description ClientID Value of typ...

AccountByID

Syntax Public Overrides Function AccountByID(ByVal AccountID As Long)As Account This function returns an account of the given ID. PARAMETERS Key Description AccountID Value of type long ------------------------- SEE ALSO * AccountBy...

SymbolsCount

Syntax Public Overrides Function SymbolsCount()As Long This function displays the total number of the symbols. PARAMETERS No Parameters. ------------------------- SEE ALSO * AccountByID [http://www.hybridsolutions.com/support/index.php?/Knowledge...

NewPosition

Syntax Public Overrides Function NewPosition(ByVal AccountID As String, ByVal BuySell As VertexFXBridgeAPI.OperationType, ByVal Amount As Double, ByVal SymbolName As String, ByVal AtPrice As String)As TransResult This function opens a new position with ...

Accounts

Syntax Public Overrides Function Accounts()As List(Of String) This function returns the list of the accounts for the current Backoffice. Sample Public Overrides Function Accounts() Return m_BO.AccountsList () End Function ----------------------...

DisableReceivingOrders

Syntax Public Overrides Sub DisableReceivingOrders() This function turns the chatting screen off. Parameters No Parameters. ------------------------- SEE ALSO * Accounts [http://www.hybridsolutions.com/support/index.php?/Knowledgebase/Article/Vi...

EnableReceivingOrders

Syntax Public Overrides Sub EnableReceivingOrders() This function turns the chatting screen on. Remarks You can switch chatting on using this method, if chatting is set on, all of the orders will come as ChatOrderReceived event. ---------------------...

Disconnect

Syntax Public Overrides Sub Disconnect() This function logs out from the server. Parameters No parameters. ------------------------- SEE ALSO * EnableReceivingOrders [http://www.hybridsolutions.com/support/index.php?/Knowledgebase/Article/View/38...

Connect

Syntax Public Overrides Sub Connect() This function logs in to the server and loads all data. After Login finishes loading the AllDataAreLoaded event is fired. Parameters No Parameters. ------------------------- SEE ALSO * Disconnect [http://w...

SymbolDigits

Syntax Public Overrides Function SymbolDigits(ByVal BOSymbolName As String) As Short This function returns the number of digits that after the decimal for a specific symbol. Parameters Key Description BOSymbolName The name of symbol Ret...

Symbol

Syntax Public Overrides Function Symbol(ByVal Index As Integer)As Symbol Public Overrides Function Symbol(ByVal Name As String)As Symbol This function returns an object of type Symbol [http://www.hybridsolutions.com/support/index.php?/Knowledgebase/...

LoginUsername

Syntax Public Overrides Function LoginUsername()As String This function returns the dealer username. Return Value It will return a value of type string. ------------------------- SEE ALSO * Symbol [http://www.hybridsolutions.com/support/index.php...

RejectOrder

Syntax Public Overrides Function RejectOrder(ByVal BOOrderID As String)As TransResult This function rejects the orders, it will return an object of type TransResult [http://www.hybridsolutions.com/support/index.php?/Knowledgebase/Article/View/3838] that...

CancelLimitOrder

Syntax Public Overrides Function CancelLimitOrder(ByVal AccountID As String, ByVal OrderID As String)As VertexFXBridgeAPI.TransResult This function cancels a certain limit order, it will return an object of type TransResult [http://www.hybridsolutions.c...

AcceptOrder

Syntax Public Overrides Function AcceptOrder(ByVal BOOrderID As String, Optional ByVal AtPrice As Double = 0 )As TransResult This function accepts the orders, it will return an object of type TransResult [http://www.hybridsolutions.com/support/index.php...

LogedOn

Syntax Public Overrides Function LogedOn()As Boolean Return Value This function informs you the session connection status. Parameters No parameters. Remarks If this property value is true then the session status will be connected, if it is false th...

Initialize

Syntax Public Overrides Sub Initialize() This method will be called by the bridge once creating a new instance of your Backoffice. In this method you have to set parameters for your Backoffice as username, password, server IP, and port etc... Sample P...

ValidateParameter

Syntax Public Overrides Function ValidateParameter(ByVal Parameter As String, ByVal Value As String) As Boolean This function validates the parameters that are added in your Backoffice class, it checks if the value is valid or not for this parameter, th...