POST api/account/client/{clientID}/v2
Update a client account version 2
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientID |
Unique client identifier |
integer |
Required |
Body Parameters
New values of client attributes
ClientAccountUpdateV2Name | 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 |
AddressV2 |
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 ClientAccountUpdateV2+FundingBankAccountUpdate |
None. |
Persons |
List of persons associated with the account |
Collection of ClientAccountUpdateV2+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 ClientAccountUpdateV2+FundingBankAccountUpdate |
None. |
InternationalBankAccounts |
International Bank Accounts. |
Collection of ClientAccountUpdateV2+InternationalBankUpdate |
None. |
IssuerSponsoredRegistration |
Issuer sponsored registration details |
IssuerSponsoredRegistration |
None. |
ThirdPartyRegistration |
Third party registration details |
ClientAccountUpdateV2+ThirdPartyRegistrationUpdate |
None. |
Request Formats
application/json, text/json
{ "BrokerageTemplateExternalRef": "REF0001", "ContractNoteEmails": [ { "EmailAddress": "testemail@testemail.com" } ], "ContractNoteComments": "", "PrincipalTrading": true, "Status": 3, "AdvisorRef": "258970", "GSTScheduleRef": "Default", "ClassSuperAccess": false, "BlockOrder": false, "HouseAccount": false, "HINProtection": false, "ShortSell": false, "Trust": { "TrustType": 1, "Designation": "CLEAR TRUST ACCOUNT", "TFN": "862793498", "ABN": "50673789893" }, "Super": { "TrustType": 1, "Designation": "CLEAR SUPERANNUATION FUND", "TFNExemptionType": 1, "ABN": "50673789893" }, "ClientName": "John Smith", "ClientNameExtension": "Mr", "PostalAddress": { "Address1": "123 DOWN STREET", "Address2": "WILLOW LANE", "Address3": "", "Address4": "", "Suburb": "LOWTOWN", "State": "WA", "Postcode": "12445", "Country": "AUSTRALIA" }, "PostContractNotes": true, "CashAccounts": [ { "AccountName": "Test Account", "BSB": "013986", "AccountNumber": "12345678", "AllowBuyFunding": true, "AllowSellFunding": true, "IsBuyFundingDefault": true, "IsSellFundingDefault": true, "IsDividendDefault": true } ], "Persons": [ { "PersonID": 23412, "IsPrincipal": true, "OwnershipType": 1, "ClientRelationshipTypes": [ 5 ] } ], "CompanyID": 12345, "NominatedBankAccounts": [ { "AccountName": "Test Account", "BSB": "013986", "AccountNumber": "12345678", "AllowBuyFunding": true, "AllowSellFunding": true, "IsBuyFundingDefault": true, "IsSellFundingDefault": true, "IsDividendDefault": true } ], "InternationalBankAccounts": [ { "InternationalBankName": "MayBank", "InternationalBankAddress": { "Address1": "Mr John Smith", "Address2": "71 POHLMAN STREET", "Address3": "SOUTHPORT QLD", "Address4": "", "Suburb": null, "State": null, "Postcode": null, "Country": null }, "BeneficiaryName": "John Smith", "BeneficiaryAddress": { "Address1": "Mr John Smith", "Address2": "71 POHLMAN STREET", "Address3": "SOUTHPORT QLD", "Address4": "", "Suburb": null, "State": null, "Postcode": null, "Country": null }, "CountryCode": "MYS", "AccountNumber": "1001923781265", "SWIFTCode": "", "CurrencyCode": "MYR", "FeesBorneBy": 1, "AllowBuyFunding": false, "AllowSellFunding": false, "IsBuyFundingDefault": false, "IsSellFundingDefault": false, "IsETODefault": false, "IsDividendDefault": false, "IsFundsTransferDefault": false } ], "IssuerSponsoredRegistration": { "RegistrationAddress": { "RegAddress1": "Mr John Smith", "RegAddress2": "71 POHLMAN STREET", "RegAddress3": "SOUTHPORT QLD", "RegAddress4": "", "RegAddress5": "", "RegAddress6": " 4215" } }, "ThirdPartyRegistration": { "PID": 2552, "FacilityId": "20012425", "SupplementaryFormat": "53951236", "ContactName": "Mr John Smith", "ContactNumber": "0355721888", "SettlementProviderID": 123 } }
application/xml
text/xml
Response Information
Resource Description
ClientAccountUpdateResultName | Description | Type | Additional information |
---|---|---|---|
ClientID |
An identifier of updated client |
integer |
None. |
Response Formats
application/json, text/json
{ "ClientID": 100500 }
application/xml, text/xml
<ClientAccountUpdateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account"> <ClientID>100500</ClientID> </ClientAccountUpdateResult>
Error Response Information
Resource Description
BadRequestResultName | Description | Type | Additional information |
---|---|---|---|
Errors | Collection of Error |
None. |
Error Response Formats
application/json, text/json
{ "Errors": [ { "Code": 10025, "Description": "sample string 1" }, { "Code": 10025, "Description": "sample string 1" } ] }
application/xml, text/xml
<BadRequestResultOfenClientUpdateErrorYd1IcMMv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ErrorResponse"> <Errors> <ErrorOfenClientUpdateErrorYd1IcMMv> <Code>ClientRegistrationAddress</Code> <Description>sample string 1</Description> </ErrorOfenClientUpdateErrorYd1IcMMv> <ErrorOfenClientUpdateErrorYd1IcMMv> <Code>ClientRegistrationAddress</Code> <Description>sample string 1</Description> </ErrorOfenClientUpdateErrorYd1IcMMv> </Errors> </BadRequestResultOfenClientUpdateErrorYd1IcMMv>