API

Methods

Objects

Company Objects

Company Company information.
CompanyRestRequest Request wrapper for company lookup REST methods.
CompanyRestResponse Response wrapper for company lookup REST methods.

Company

Company Information

name

Type: String Company Name

abn

Type: String Company ABN Number

statecode

Type: String State information of the company address

postcode

Type: String Postcode information of the company address

status

Type: String Status of the company if applicable

legalName

Type: String Legal name of the company if applicable

acn

Type: String Company acn number

isCurrentIndicator

Type: String Y/N

JSON Representation


    {
       "name":"xxx",
       "abn":"xxx",
       "statecode":"xxx",
       "postcode":"xx",
       "status":"xx",
       "legalName":"xx",
       "acn": "xx",
       "isCurrentIndicator": "Y/N"
    }

CompanyRestRequest

An CompanyRestRequest object is used when invoking the Harmony RightAddress company lookup REST service methods.

apiName

Type: String Optional. If you dont specify the value, then it will call ABRSearchByNameAdvancedSimpleProtocol2012 which is searched by company name. List of API names can be found in http://abr.business.gov.au/abrxmlsearch/abrxmlsearch.asmx

guid

Type: String Optional. You only need to specify this value if you want to use your own guid.

optionalConfig

Type: String Optional.

payload

Type: Company Specify the Company name, or acn, or abn in the request payload name field

JSON Representation


    Lookup by the company name
    {
        "payload":{"name":"abc"} ]
    }
    Lookup by the ASIC number (ACN or ARBN)
    {
    	"payload":{"name":"xxxx6693"}, 
    	"apiName":"SearchByASICv201408"
    }

CompanyRestResponse

An CompanyRestResponse object is returned from the Harmony RightAddress company lookup REST service methods.

payload

Type: List of Company The list of companies which matched the search criteria.

status

Type: String The status of the request (i.e. 'SUCCESS' or 'ERROR').

messages

Type: String[] Any error messages generated during the REST service method invocation (e.g. '[ "Access is denied" ]')

JSON Representation


    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [ 
		{
		"name":"xxx",
		"abn":"xxx",
		"statecode":"xxx",
		"postcode":"xx",
		"status":"xx",
		"legalName":"xx",
		"acn": null,
		"isCurrentIndicator": "Y"
		},,....
        ]
    }