Name | Description | Type | Additional information |
---|---|---|---|
NominatedBankAccounts |
Nominated bank accounts. The list of funding nominated bank accounts for an account. |
Collection of NominatedBankAccount |
None. |
CashAccounts |
Cash accounts. A list of cash accounts that can be used for funding with direct access from TPP. |
Collection of BankAccount |
None. |
InternationalBankAccounts |
List of International Bank Accounts |
Collection of InternationalBankAccount |
None. |
AdvisorID |
Advisor ID |
integer |
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 |
BrokerRegistration |
Broker registration details required for Broker Sponsored. |
BrokerRegistrationCreation |
None. |
ThirdPartyRegistration |
Third party registration details required for Margin Lending, DVP or "Custodian" accounts. |
ThirdPartyRegistration |
None. |
IssuerSponsoredRegistration |
Issuer sponsored registration details |
IssuerSponsoredRegistration |
None. |
Persons |
List of persons associated with the account. Must include primary holder (primary destination for contract pdfs and statements). Must include account holders to support broker and issuer sponsorship. |
Collection of ClientPersonLink |
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. |
CompanyRef |
An external company identifier that has been added to a Company via the External Reference field on the company creation endpoint |
string |
String length: inclusive between 0 and 100 |
Trust |
Trust details of account holder. Required for broker and issuer sponsorship where account is owned by a trust. |
TrustCreation |
None. |
Super |
Superannuation details. Required for broker and issuer sponsorship where account is owned by a superannuation trust. |
TrustCreation |
None. |
Minor |
Minor Details. Required for broker and issuer sponsorship where account is owned by a minor. |
Minor |
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. |
ContractNoteAddresses |
Contract note addresses |
Collection of ContractNoteAddress |
None. |
ContractNoteComments |
Default text that is to be displayed on the contract note PDFs sent to the client. |
string |
String length: inclusive between 0 and 100 |
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 |
ExternalRef |
External reference. An identifer of account in front office systems. |
string |
String length: inclusive between 0 and 100 |
ApplicationMoney |
Allow application money to be charged and collected on rights purchase by client |
boolean |
None. |
Custodian |
Reference to custodian of the account |
Custodian |
None. |
ClientGroups |
Client Groups. Can be used to tag accounts as 'Principal Trading' |
Collection of ClientAccountCreation+enClientGroupPublicID |
None. |
PostContractNotes |
If set to true then contract notes will be posted primary account holder. By default contract notes will be emailed. |
boolean |
None. |
ClientName |
Client Name |
string |
String length: inclusive between 0 and 255 |
ClientNameExtension |
Client Name Extension |
string |
String length: inclusive between 0 and 255 |
GSTScheduleRef |
Reference to GST Schedule to be applied to the client. |
string |
String length: inclusive between 0 and 100 |
ClassSuperAccess |
Allow to enable the access of Class Super - HTTPS Interface Group |
boolean |
None. |
PrincipalTrading |
If specified and set to true, the client is flagged as a PrincipalTrading account |
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. |
ShortSell |
Optional. If specified and set to true, short sell will be enabled for the client |
boolean |
None. |
HINProtection |
Optional. If specified and set to true, HINProtection will be enabled for the client |
boolean |
None. |
PostalAddress |
Postal address for the account. This will be displayed on contract PDFs and other statements. If not provided, will use address on principal contact / custodian / company address |
Address |
None. |
ACHRegistration |
ACH Registration details |
ACHRegistration |
None. |
FATCACRS |
Details of foreign tax residences for company and trust accounts |
TIN |
None. |
LodgementReference |
Direct debit entry reference value |
string |
String length: inclusive between 0 and 18 |