GET api/account/client-without-details?externalRef={externalRef}&clientName={clientName}&hin={hin}

Get all clients with matching by person principal brand ID / by external reference, client name, CHESS HIN (partial), and client ID

Request Information

URI Parameters

Name	Description	Type	Additional information
externalRef	External reference.	string	None.
clientName	Unique client identifier (partial name match).	string	None.
hin	CHESS HIN (broker-sponsored registration). Digits only, or CHESS-style with a leading X (e.g. X00004545). Partial digit sequences match when contained in the SQL string form of the HIN. Minimum 5 digits required when specified.	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ClientWithoutDetails

Name	Description	Type	Additional information
ClientID	Client ID of client account	integer	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.
ClientName	Client account name. If not supplied, ClientName is generated from account holder information	string	Required
Status	Client account status	enClientStatus	Required
HIN	CHESS broker-sponsored HIN for the client when a non-inactive registration exists; otherwise null.	string	None.
GSTScheduleRate	Client GST Schedule Rate	decimal number	Required
GSTScheduleReference	Client GST Schedule Reference	string	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 100500,
    "ExternalRef": null,
    "ClientName": "John Smith",
    "Status": 3,
    "HIN": "28418639",
    "GSTScheduleRate": 0.0,
    "GSTScheduleReference": "Exempt"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientWithoutDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <ClientWithoutDetails>
    <ClientID>100500</ClientID>
    <ClientName>John Smith</ClientName>
    <ExternalRef i:nil="true" />
    <GSTScheduleRate>0.00</GSTScheduleRate>
    <GSTScheduleReference>Exempt</GSTScheduleReference>
    <HIN>28418639</HIN>
    <Status>Suspended</Status>
  </ClientWithoutDetails>
</ArrayOfClientWithoutDetails>

Error Response Information

Resource Description

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>