| Name | Description | Type | Additional information |
|---|---|---|---|
| BrokerageTemplateExternalRef |
Brokerage template external reference if specified, must match reference ('BrokerageCode') of brokerage template associated with the brand |
string |
String length: inclusive between 0 and 100 |
| ContractNoteEmails |
A list of email addresses that are sent contract PDFs (this is in addition to the primary account holder). If set will replace all existing. |
Collection of ContractNoteEmail |
String length: inclusive between 0 and 1000 |
| ContractNoteComments |
Default text that is to be displayed on the contract PDFs sent to the client |
string |
String length: inclusive between 0 and 1000 |
| PrincipalTrading |
If specified and set to true, the client is flagged as a PrincipalTrading account |
boolean |
None. |
| Status |
Status can be set to Suspended to trigger account closure |
enClientStatus |
None. |
| AdvisorRef |
Advisor Reference ("Advisor Code"). This must match ExternalReference of existing Advisor account. If not set, will be associated with default Advisor account. |
string |
String length: inclusive between 0 and 100 |
| 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 |
String length: inclusive between 0 and 100 |
| ClassSuperAccess |
If specified and set to true, the access of Class Super - HTTPS Interface Group is enabled, otherwise disabled access of Class Super - HTTPS Interface Group if any. |
boolean |
None. |
| BlockOrder |
If specified and set to true, the client is blocked from order creation or amendment |
boolean |
None. |
| HouseAccount |
Optional. If specified and set to true, the client is setup with no sponsorship |
boolean |
None. |
| HINProtection |
Optional. If specified and set to true, the HIN Protection will be enabled for the client |
boolean |
None. |
| ShortSell |
Optional. If specified and set to true, short sell will be enabled for the client |
boolean |
None. |
| Trust |
Trust details of account holder |
TrustUpdate |
None. |
| Super |
Superannuation details |
TrustUpdate |
None. |
| ClientName |
Client Name |
string |
None. |
| ClientNameExtension |
Client name extension |
string |
None. |
| PostalAddress |
Postal address |
Address |
None. |
| PostContractNotes |
If set to true then contract notes will be posted primary account holder. By default contract notes will be emailed |
boolean |
None. |
| CashAccounts |
Cash accounts. A list of cash accounts that can be used for funding with direct access from TPP |
Collection of ClientAccountUpdate+FundingBankAccountUpdate |
None. |
| Persons |
List of persons associated with the account |
Collection of ClientAccountUpdate+ClientPersonUpdate |
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. |
| NominatedBankAccounts |
Nominated bank accounts. A list of nominated bank accounts for broker sponsored client |
Collection of ClientAccountUpdate+FundingBankAccountUpdate |
None. |
| InternationalBankAccounts |
International Bank Accounts. |
Collection of ClientAccountUpdate+InternationalBankUpdate |
None. |
| IssuerSponsoredRegistration |
Issuer sponsored registration details |
IssuerSponsoredRegistration |
None. |
| ThirdPartyRegistration |
Third party registration details |
ClientAccountUpdate+ThirdPartyRegistrationUpdate |
None. |
| FATCACRS |
Details of foreign tax residences for company and trust accounts |
ClientAccountUpdate+TIN |
String length: inclusive between 0 and 1000 |