POST api/account/client/institutionalcode
Get a client account details using exact match of BIC and BookingCode in profile.
Request Information
URI Parameters
None.
Body Parameters
Institutional Code
InstitutionalCodeRequestName | Description | Type | Additional information |
---|---|---|---|
BIC |
Business Identifier Code of client account |
string |
Required |
BookingCode |
Booking Code |
string |
Required |
MasterClientReference |
Master Client Reference |
string |
Required |
Request Formats
application/json, text/json
{ "BIC": "BICCODE", "BookingCode": "A1C", "MasterClientReference": "BD_A" }
application/xml, text/xml
<InstitutionalCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account"> <BIC>BICCODE</BIC> <BookingCode>A1C</BookingCode> <MasterClientReference>BD_A</MasterClientReference> </InstitutionalCodeRequest>
Response Information
Resource Description
A Client object with ClientID, ExternalRef, Status and ClientName
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
<ClientWithoutDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account"> <ClientID>100500</ClientID> <ClientName>John Smith</ClientName> <ExternalRef i:nil="true" /> <GSTScheduleRate>0.00</GSTScheduleRate> <GSTScheduleReference>Exempt</GSTScheduleReference> <Status>Suspended</Status> </ClientWithoutDetails>
Error Response Information
Resource Description
A Client object with ClientID, ExternalRef, Status and ClientName
stringError Response Formats
application/json, text/json
"sample string 1"
application/xml, text/xml
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>