GET api/account/client/{clientID}
Get client account with client ID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientID |
Unique client identifier |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ClientName | 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. |
Response Formats
application/json, text/json
{ "ClientID": 100500, "ClientName": "John Smith", "ClientNameExtension": "", "ClientType": 9, "ExternalRef": "BP101", "AdvisorRef": "1295", "AdvisorID": 1000, "Status": 3, "ResidencyStatus": 1, "BrokerRegistration": { "HIN": "28418639", "HolderType": "S", "HolderStatus": "A", "Status": 1, "ResidencyIndicator": "D", "PID": 2552, "RegistrationAddress": { "RegAddress1": "Mr John Smith", "RegAddress2": "79 COLLINGWOOD STREET", "RegAddress3": "OSBORNE PARK WA", "RegAddress4": "", "RegAddress5": "", "RegAddress6": "6017" } }, "ThirdPartyRegistration": { "PID": 2552, "FacilityId": "20012425", "SupplementaryFormat": "53951236", "ContactName": "Mr John Smith", "ContactNumber": "0355721888", "Status": 1, "SettlementProviderID": 100000 }, "IssuerSponsoredRegistration": { "RegistrationAddress": { "RegAddress1": "Mr John Smith", "RegAddress2": "79 COLLINGWOOD STREET", "RegAddress3": "SOUTHPORT QLD", "RegAddress4": "", "RegAddress5": "", "RegAddress6": "4215" } }, "Persons": [ { "PersonID": 10001, "IsPrincipal": true, "OwnershipType": 1, "ClientRelationshipTypes": [ 1, 3 ] } ], "Trust": { "TrustType": 1, "TFNRecorded": true, "ABN": "50673789893", "TFNExemptionType": null }, "Super": { "TrustType": 1, "TFNRecorded": false, "ABN": "50673789893", "TFNExemptionType": 1 }, "Custodian": { "CustodianRef": "BSCL", "RegisteredName": "" }, "CompanyID": 41178, "ContractNoteEmails": [ { "EmailAddress": "testemail2@testemail.com" } ], "BrokerageTemplateExternalRef": "REF0001", "GSTScheduleRef": "GST", "ContractNoteComments": "Comments", "BrokerageTemplateID": 1632, "ClientOrderType": 1, "HINProtection": false, "PrincipalTrading": true, "BlockOrder": false, "ShortSell": false, "BTPanorama": false, "HouseAccount": false, "PostContractNotes": false, "ClassSuperAccess": false, "PostalAddress": { "Address1": "Mr John Smith,", "Address2": "210 GEORGE STREET", "Address3": "", "Address4": "", "Suburb": "SYDNEY", "State": "NSW", "Postcode": "2000", "Country": "AUSTRALIA" }, "NominatedBankAccounts": [ { "AccountName": "Account Name", "BSB": "013986", "AccountNumber": "12345678", "AllowBuyFunding": true, "AllowSellFunding": true, "IsBuyFundingDefault": true, "IsSellFundingDefault": true, "IsDividendDefault": false } ], "CashAccounts": [ { "AccountName": "Account Name", "BSB": "182740", "AccountNumber": "12345678", "AllowBuyFunding": true, "AllowSellFunding": true, "IsBuyFundingDefault": true, "IsSellFundingDefault": true, "IsDividendDefault": false } ], "CreatedDateTime": "2007-10-08T13:18:20", "ClosedDateTime": "2007-12-18T17:15:35", "UpdatedDateTime": "2007-12-18T17:15:35" }
application/xml, text/xml
<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account"> <AdvisorID>1000</AdvisorID> <AdvisorRef>1295</AdvisorRef> <BTPanorama>false</BTPanorama> <BlockOrder>false</BlockOrder> <BrokerRegistration> <HIN>28418639</HIN> <HolderStatus>A</HolderStatus> <HolderType>S</HolderType> <PID>2552</PID> <RegistrationAddress> <RegAddress1>Mr John Smith</RegAddress1> <RegAddress2>79 COLLINGWOOD STREET</RegAddress2> <RegAddress3>OSBORNE PARK WA</RegAddress3> <RegAddress4></RegAddress4> <RegAddress5></RegAddress5> <RegAddress6>6017</RegAddress6> </RegistrationAddress> <ResidencyIndicator>D</ResidencyIndicator> <Status>Active</Status> </BrokerRegistration> <BrokerageTemplateExternalRef>REF0001</BrokerageTemplateExternalRef> <BrokerageTemplateID>1632</BrokerageTemplateID> <CashAccounts> <FundingBankAccount> <AccountName>Account Name</AccountName> <AccountNumber>12345678</AccountNumber> <AllowBuyFunding>true</AllowBuyFunding> <AllowSellFunding>true</AllowSellFunding> <BSB>182740</BSB> <IsBuyFundingDefault>true</IsBuyFundingDefault> <IsDividendDefault>false</IsDividendDefault> <IsSellFundingDefault>true</IsSellFundingDefault> </FundingBankAccount> </CashAccounts> <ClassSuperAccess>false</ClassSuperAccess> <ClientID>100500</ClientID> <ClientName>John Smith</ClientName> <ClientNameExtension></ClientNameExtension> <ClientOrderType>Single</ClientOrderType> <ClientType>Custodian</ClientType> <ClosedDateTime>2007-12-18T17:15:35</ClosedDateTime> <CompanyID>41178</CompanyID> <ContractNoteComments>Comments</ContractNoteComments> <ContractNoteEmails> <ContractNoteEmail> <EmailAddress>testemail2@testemail.com</EmailAddress> </ContractNoteEmail> </ContractNoteEmails> <CreatedDateTime>2007-10-08T13:18:20</CreatedDateTime> <Custodian> <CustodianRef>BSCL</CustodianRef> <RegisteredName></RegisteredName> </Custodian> <ExternalRef>BP101</ExternalRef> <GSTScheduleRef>GST</GSTScheduleRef> <HINProtection>false</HINProtection> <HouseAccount>false</HouseAccount> <IssuerSponsoredRegistration> <RegistrationAddress> <RegAddress1>Mr John Smith</RegAddress1> <RegAddress2>79 COLLINGWOOD STREET</RegAddress2> <RegAddress3>SOUTHPORT QLD</RegAddress3> <RegAddress4></RegAddress4> <RegAddress5></RegAddress5> <RegAddress6>4215</RegAddress6> </RegistrationAddress> </IssuerSponsoredRegistration> <NominatedBankAccounts> <FundingBankAccount> <AccountName>Account Name</AccountName> <AccountNumber>12345678</AccountNumber> <AllowBuyFunding>true</AllowBuyFunding> <AllowSellFunding>true</AllowSellFunding> <BSB>013986</BSB> <IsBuyFundingDefault>true</IsBuyFundingDefault> <IsDividendDefault>false</IsDividendDefault> <IsSellFundingDefault>true</IsSellFundingDefault> </FundingBankAccount> </NominatedBankAccounts> <Persons> <ClientPerson> <ClientRelationshipTypes xmlns:d4p1="http://schemas.datacontract.org/2004/07/TPP.Utilities"> <d4p1:enClientRelationshipType>Trustee</d4p1:enClientRelationshipType> <d4p1:enClientRelationshipType>Beneficiary</d4p1:enClientRelationshipType> </ClientRelationshipTypes> <IsPrincipal>true</IsPrincipal> <OwnershipType>AccountHolder</OwnershipType> <PersonID>10001</PersonID> </ClientPerson> </Persons> <PostContractNotes>false</PostContractNotes> <PostalAddress> <Address1>Mr John Smith,</Address1> <Address2>210 GEORGE STREET</Address2> <Address3></Address3> <Address4></Address4> <Country>AUSTRALIA</Country> <Postcode>2000</Postcode> <State>NSW</State> <Suburb>SYDNEY</Suburb> </PostalAddress> <PrincipalTrading>true</PrincipalTrading> <ResidencyStatus>Resident</ResidencyStatus> <ShortSell>false</ShortSell> <Status>Suspended</Status> <Super> <ABN>50673789893</ABN> <TFNExemptionType>tfnExempt00000000000</TFNExemptionType> <TFNRecorded>false</TFNRecorded> <TrustType>Company</TrustType> </Super> <ThirdPartyRegistration> <ContactName>Mr John Smith</ContactName> <ContactNumber>0355721888</ContactNumber> <FacilityId>20012425</FacilityId> <PID>2552</PID> <SettlementProviderID>100000</SettlementProviderID> <Status>Active</Status> <SupplementaryFormat>53951236</SupplementaryFormat> </ThirdPartyRegistration> <Trust> <ABN>50673789893</ABN> <TFNExemptionType i:nil="true" /> <TFNRecorded>true</TFNRecorded> <TrustType>Company</TrustType> </Trust> <UpdatedDateTime>2007-12-18T17:15:35</UpdatedDateTime> </Client>