GET api/company/{companyID}
Gets company details based on the company ID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
companyID |
Company ID |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CompanyName | Description | Type | Additional information |
---|---|---|---|
CompanyID |
Company ID |
integer |
None. |
CompanyName |
Company name |
string |
None. |
TFNRecorded |
If set to true, a tax file number is recorded for the company |
boolean |
None. |
TFNExemptionType |
Tax file number exemption type |
enTaxExemptionCode |
None. |
ABN |
Australian business number |
string |
None. |
ACN |
Australian company number |
string |
None. |
RegisteredAddress |
Registered address of business |
AddressDetails |
None. |
PostalAddress |
Postal address of business |
AddressDetails |
None. |
Email address |
string |
None. |
|
ExternalRef |
External reference. An identifier of company record in front office systems |
string |
None. |
BrandID |
Brand ID associated with the company |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "CompanyID": 1, "CompanyName": "Test company", "TFNRecorded": true, "TFNExemptionType": 1, "ABN": "50673789893", "ACN": "120964034", "RegisteredAddress": { "Address1": "CLEARING PTE LTD,", "Address2": "LEVEL 20", "Address3": "GOVERNOR PHILIP TOWER", "Address4": "1 FARRER PLACE", "Suburb": "SYDNEY", "State": "NSW", "Postcode": "2000", "Country": "AUSTRALIA" }, "PostalAddress": { "Address1": "CLEARING PTE LTD,", "Address2": "LEVEL 20", "Address3": "GOVERNOR PHILIP TOWER", "Address4": "1 FARRER PLACE", "Suburb": "SYDNEY", "State": "NSW", "Postcode": "2000", "Country": "AUSTRALIA" }, "Email": "test@test.com", "ExternalRef": "1300290", "BrandID": 6 }
application/xml, text/xml
Sample:
<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Company"> <ABN>50673789893</ABN> <ACN>120964034</ACN> <BrandID>6</BrandID> <CompanyID>1</CompanyID> <CompanyName>Test company</CompanyName> <Email>test@test.com</Email> <ExternalRef>1300290</ExternalRef> <PostalAddress> <Address1 xmlns="">CLEARING PTE LTD,</Address1> <Address2 xmlns="">LEVEL 20</Address2> <Address3 xmlns="">GOVERNOR PHILIP TOWER</Address3> <Address4 xmlns="">1 FARRER PLACE</Address4> <Suburb xmlns="">SYDNEY</Suburb> <State xmlns="">NSW</State> <Postcode xmlns="">2000</Postcode> <Country xmlns="">AUSTRALIA</Country> </PostalAddress> <RegisteredAddress> <Address1 xmlns="">CLEARING PTE LTD,</Address1> <Address2 xmlns="">LEVEL 20</Address2> <Address3 xmlns="">GOVERNOR PHILIP TOWER</Address3> <Address4 xmlns="">1 FARRER PLACE</Address4> <Suburb xmlns="">SYDNEY</Suburb> <State xmlns="">NSW</State> <Postcode xmlns="">2000</Postcode> <Country xmlns="">AUSTRALIA</Country> </RegisteredAddress> <TFNExemptionType>tfnExempt00000000000</TFNExemptionType> <TFNRecorded>true</TFNRecorded> </Company>