GET api/account/client-without-details?externalRef={externalRef}&clientName={clientName}
Get all clients with matching by person principal brand ID / by external reference, client name and client ID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
externalRef |
External reference |
string |
None. |
clientName |
Unique client identifier |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ClientWithoutDetailsName | 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 |
GSTScheduleRate |
Client GST Schedule Rate |
decimal number |
Required |
GSTScheduleReference |
Client GST Schedule Reference |
string |
Required |
Response Formats
application/json, text/json
[ { "ClientID": 100500, "ExternalRef": null, "ClientName": "John Smith", "Status": 3, "GSTScheduleRate": 0.0, "GSTScheduleReference": "Exempt" } ]
application/xml, text/xml
<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> <Status>Suspended</Status> </ClientWithoutDetails> </ArrayOfClientWithoutDetails>