Name | Description | Type | Additional information |
---|---|---|---|
ClientID |
Client ID of client account |
integer |
Required |
ClientName |
Client account name. If not supplied, ClientName is generated from account holder information |
string |
Required |
ClientNameExtension |
Client name extension |
string |
None. |
ClientType |
Reference to Client Type of the client account |
enClientType |
Required |
ExternalRef |
External reference. An identifer of account in front office systems. Orders entered via the BOON+ interface must use matching value to populate BOON+.ClientOrderNumber field |
string |
None. |
AdvisorRef |
Advisor reference ("Advisor Code"). The ExternalReference of Advisor account |
string |
None. |
AdvisorID |
Advisor ID. Linked advisor to the client account |
integer |
Required |
Status |
Client account status |
enClientStatus |
Required |
ResidencyStatus |
Client Residency Status. e.g. Resident or Non-resident |
enResidencyIndicator |
Required |
BrokerRegistration |
Broker registration details required for Broker Sponsored account |
BrokerRegistration |
None. |
ThirdPartyRegistration |
Third party registration details required for Margin Lending, DVP or "Custodial" accounts |
ThirdPartyRegistration |
None. |
IssuerSponsoredRegistration |
Issuer sponsored registration details |
IssuerSponsoredRegistration |
None. |
Persons |
List of persons associated with the account |
Collection of ClientPerson |
None. |
Trust |
Trust details of account holder |
Trust |
None. |
Super |
Superannuation details |
Trust |
None. |
Custodian |
Reference to Custodian of the account |
Custodian |
None. |
CompanyID |
Company ID of account owner, or where trust / super / minor details are included this specifies the company that is the trustee |
integer |
None. |
ContractNoteEmails |
A list of email addresses that are sent contract PDFs (this is in addition to the primary account holder) |
Collection of ContractNoteEmail |
None. |
BrokerageTemplateExternalRef |
Brokerage template external reference. If specified, must match reference ('BrokerageCode') of brokerage template associated with the brand |
string |
None. |
GSTScheduleRef |
Reference to GST Schedule to be applied to the client If not specified, the client will be set to the full GST Rate schedule |
string |
None. |
ContractNoteComments |
Default text that is to be displayed on the contract PDFs sent to the client |
string |
None. |
BrokerageTemplateID |
Identity of Brokerage Template that matches existing configured Brokerage Template |
integer |
None. |
ClientOrderType |
Client Order Type. Its either Netted or Single order type |
enClientOrderType |
None. |
HINProtection |
If specified and set to true, prevents the incorrect transfer-out of assets or the participation in CA events for the client |
boolean |
None. |
PrincipalTrading |
Set to true for Principal Trading accounts |
boolean |
None. |
BlockOrder |
If specified and set to true, the client is blocked from order creation or amendment |
boolean |
None. |
ShortSell |
If specified and set to true, short sell enabled for the client. |
boolean |
None. |
BTPanorama |
If specified and set to true, BT Panorama enabled for the client. |
boolean |
None. |
HouseAccount |
If specified and set to true, the client is with no sponsorship |
boolean |
None. |
PostContractNotes |
If set to true then contract notes will be posted primary account holder. By default contract notes will be emailed |
boolean |
Required |
ClassSuperAccess |
Allow to enable the access of Class Super - HTTPS Interface Group |
boolean |
None. |
PostalAddress |
Postal address |
Address |
None. |
NominatedBankAccounts |
Nominated bank accounts. The list of funding nominated bank accounts for an account |
Collection of FundingBankAccount |
None. |
CashAccounts |
Cash accounts. A list of cash accounts that can be used for funding with direct access from TPP |
Collection of FundingBankAccount |
None. |
CreatedDateTime |
The date the client account was created |
date |
None. |
ClosedDateTime |
The date the client account was suspended |
date |
None. |
UpdatedDateTime |
The date the client account was updated |
date |
None. |