Business Objects

BusinessRequest	Request wrapper for REST methods.
HostedBusinessRestResponse	Response wrapper for REST methods
BusinessSummary	Business summary information from find API
BusinessDetail	Detail information of Business from retrieve API.
BusinessEntity	Object which is included in the BusinessDetail for other names of the entity

BusinessRequest

BusinessRequest object is used when invoking the Harmony RightAddress business Find/Retrieve REST service methods. (* means mandatory field)

name*

Type: String. Mandatory field for both Find/Retrieve API.

For Find API ,it can be a business number, company or any entity names.

For Retrieve API, it can be Id value from Find API or clear text business/company number.

country*

Type: String. Country ISO2 code. (e.g. AU)

hits

Type: Integer. Optional, the maximum number of results returned from the lookup. If empty default will be 20.

taxStatus

Type: String. TAX/GST status want to search, default will be empty which will search ALL. ACT -> Active, CAN -> Cancelled, NON -> None

bnStatus

Type: String. Business number status want to search, default will be empty which will search ALL. ACT -> Active, CAN -> Cancelled

nameTypes

Type: String Array. Depending on country the available filters differ. Entity types want to search from, default will search ALL. ["TRD", "BN", "OTN"] -> search against trading names and business names

Australia:

• MN → main entity name;

• LGL → legal entity name (individuals/sole traders). Use with MN;

• TRD → trading name in Other Entity;

• BN → business name in Other Entity;

• OTN → other name in Other Entity;

• PRV → Australian Private Company

• DGR → deductible gift recipient

Note: Here is the link to the complete list of entity types → https://abr.business.gov.au/Documentation/ReferenceData

New Zealand:

• MN → main entity name;

• TRD → trading name in Other Entity;

• OTN → other name in Other Entity;

state

Type: String Array. The state of the entity for searching, default will search ALL. It accept multiple states. e.g. ["NSW", "QLD"] -> search against NSW and QLD entities

caseType

Type: String. Case type for entity name, default is whatever the case in the reference data. Available values : UP, LOW, TITLE.

JSON Representation

{
  "name": "name, abn or acn",
  "hits": 20,
  "country": "au",
  "taxStatus": "ACT",
  "bnStatus": "ACT",
  "nameTypes": [
    "MN",
    "BN"
  ],
  "state": [
    "VIC",
    "NSW"
  ],
  "caseType": "UP"
}

HostedBusinessRestResponse

An HostedBusinessRestResponse object is returned from the Harmony RightAddress Business find/retrieve REST service method invocation

payload

Type: The list of BusinessSummary for find API or list of BusinessDetail for retrieve API

status

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

messages

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

JSON Representation

For Find API

  {
  "status": "SUCCESS",
  "messages": [],
  "payload": [
    {
      "name": "INSURANCE ADVICE & ADVOCACY STONES CORNER",
      "bn": "xxxxx1825",
      "postcode": "4120",
      "id": "XEE0eyRpm1UY80rNOdIDvQ=="
    },
    {
      "name": "Insurance Glass",
      "bn": "xxxxx8910",
      "postcode": "6172",
      "id": "dETz7USYQoDM1OuyzrjmLQ=="
    }]
    }

BusinessSummary

BusinessSummary is the result from the find API. It contains summary information of the business. id can be used for retrieve API for full information of the business entity.

name

Type: String. The Main or Legal name of the business entity.

bn

Type: String. Partial business number of the business entity, in order to get the all information will require to call the retrieve API.

postcode

Type: String. Postcode of the business entity.

id

Type: String. Id to use for the retrieve API call in order to get full detail of the business entity information.

JSON Representation

  {
      "name": "INSURANCE ADVICE & ADVOCACY STONES CORNER",
      "bn": "xxxxx1825",
      "postcode": "4120",
      "id": "XEE0eyRpm1UY80rNOdIDvQ=="
    }

BusinessDetail

BusinessDetail is the object return from the retrieve API. It includes a list of BusinessEntity object for other names of the business entity.

name

Type: String. Main/Legal name of the business entity.

country

Type: String. Country ISO2 code. (e.g. AU)

bn

Type: String. Business number of the entity.

cn

Type: String. Company number of the entity.

postcode

Type: String. Postcode of the business entity.

state

Type: String. State of the business entity.

name_entity_type

Type: String. Type of the name of the entity. MN → Main Entity Name; LGL → legal Entity Name.

other_entities

Type: List of BusinessEntity object for other entity names.

last_updated_date

Type: String. The last updated date.

bn_status

Type: String. Status of the business number. ACT -> Active, CAN -> Cancelled.

bn_status_from_date

Type: String. Date of the business number from

entity_type_ind

Type: String. Indicator of the entity type with description the the entity_type_text field.

entity_type_text

Type: String. Description for the entity_type_ind value.

tax_status

Type: String. The status of the GST. ACT -> Active, CAN -> Cancelled, NON -> None.

tax_status_from_date

Type: String. The date for the tax_status value. If tax_status is NON, date value is 19000101 .

attributes

Type: List of name value pairs for extra attributes.

JSON Representation

 {
      "name": "SIMON PETER KENDALL",
      "bn": "51321301825",
      "state": "QLD",
      "postcode": "4120",
      "country": "au",
      "name_entity_type": "LGL",
      "other_entities": [
        {
          "entity_name": "INSURANCE ADVICE & ADVOCACY STONES CORNER",
          "entity_type": "BN"
        }
      ],
      "last_updated_date": "20190510",
      "bn_status": "CAN",
      "bn_status_from_date": "20190510",
      "entity_type_ind": "IND",
      "entity_type_text": "Individual/Sole Trader",
      "tax_status": "NON",
      "tax_status_from_date": "19000101"
    }

BusinessEntity

BusinessEntity object is used for other business entities names like other trading name etc. One Business can have a list of BusinessEntity objects if applicable.

entity_name

Type: String. Name of the business entity.

entity_type

Type: String. Type of the name. TRD → trading name; BN → business name ; OTN → other name; DGR → DGR name.

JSON Representation

{
  "entity_name": "INSURANCE ADVICE & ADVOCACY STONES CORNER",
  "entity_type": "BN"
}