POST api/account/client/{clientID}

Update a client account

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Unique client identifier	integer	Required

Body Parameters

New values of client attributes

ClientAccountUpdate

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

Request Formats

application/json, text/json

Sample:

{
  "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
  },
  "FATCACRS": {
    "FATCACountryDetails": [
      {
        "Country": "MYS",
        "TINExemption": 1
      },
      {
        "Country": "HKG",
        "TIN": "456789"
      }
    ],
    "TaxStatus": 3,
    "GIIN": "789101",
    "FATCACRSStatus": 1
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'System.Collections.Generic.List`1[[TPP.B2B.Webservices2.Contract.Account.ClientAccountUpdate+InternationalBankUpdate, TPP.B2B.Webservices2, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfClientAccountUpdate.InternationalBankUpdate:http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'System.Collections.Generic.List`1[[TPP.B2B.Webservices2.Contract.Account.ClientAccountUpdate+InternationalBankUpdate, TPP.B2B.Webservices2, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfClientAccountUpdate.InternationalBankUpdate:http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

Response Information

Resource Description

ClientAccountUpdateResult

Name	Description	Type	Additional information
ClientID	An identifier of updated client	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientID": 100500
}

application/xml, text/xml

Sample:

<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

BadRequestResult

Name	Description	Type	Additional information
Errors			None.

Error Response Formats

application/json, text/json

Sample:

{
  "Errors": [
    {
      "Code": 10025,
      "Description": "sample string 1"
    },
    {
      "Code": 10025,
      "Description": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<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>