Live Chat Software by Hybrid Solutions
Knowledgebase: Release Notes
Backoffice API 9.5.17
Posted by Yousef Ibrahim on 10 October 2011 02:59 PM

New Properties

1. RootID: Used to get the ID of the main accounts tree node

Syntax:
Object.RootID()
Part : Description
  • Object : Evaluates to CVertexFXBOAPI.
Remark: Use this property when you need the ID of the main accounts tree node for the connected dealer.

2. Account: Used to get the account by its ID. 

Syntax 
Object.Account(AccountID As Long) As COAccount

Part : Description
  • Object : Evaluates to CVertexFXBOAPI
  • AccountID : ID of the account as long
Remark: Use this property to retrieve account object (as COAccount) to fetch its data details.

3. ClientID: Used to get the client ID by his username.

Syntax
Object.ClientID(ClientUsername As String)
Part : Description
  • Object : Evaluates to CVertexFXBOAPI.
  • ClientUsername : The username of the Client.
Remark: In some cases you may need the ID for the client using his username, to be used in another properties or functions that needs the client ID.

4. isChild: Used to check if client is child of office or group.

Syntax 
Object.isChild(ClientID As Long, ParentID As Long)
Part : Description
  • Object: Evaluates to CVertexFXBOAPI.
  • ClientID : ID of the client.
  • ParentID : ID of the parent node.
Remark: Used to check if client is child of office or group. If the client is a child of an office or group. This property will be true. Otherwise, it will have false as its value.

5. DealerUsername: Used to get dealer's username by his ID.

Syntax 
Object.DealerUsername(DealerID As Long)

Part Description
  • Object : Evaluates to CVertexFXBOAPI.
  • DealerID : ID of the Dealer.
Remark : Used to retrieve dealer's username by his ID.

New Data Types:

COAccount: This class represents the Account object, that has the information for this account.

Properties:
  • Part : Description
  • AccountID : The account ID for the account. Read–only
  • ClientID : The Client ID who own this account. Read–only
  • FirstName : The first name of the client who owns this account. Read–only
  • SecondName : The second name of the client who owns this account. Read–only
  • ThirdName : The third name of the client who owns this account. Read–only
  • LastName : The last name of the client who owns this account. Read–only
  • FullName : The full name of the client who owns this account. Read–only
  • DemoAccount : The account type; True, if demo. False, if real. Read–only
  • Credit : The credit for the account. Read–only
  • Balance : The balance for the account. Read–only
  • Equity : The Equity for the account. Read–only
  • MarginLevel : The margin level for the account. Read–only
  • EffectiveMargin : The Effective margin for account. Read–only
  • MarginRequirement : The margin requirement for the account. Read–only

Released On June, 16, 2011

(0 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