Loqate Harmony Documentation
  • GBG Loqate AU & NZ
  • Loqate Harmony API
    • Sign up for free trial
    • Login
    • API Specification
      • Authentication
      • Address
        • Address Validation & Lookup
        • Address by Geocode
        • Address Cleanse
        • Address Parse
        • Geocode Intl
      • Address Insights
        • Australian Insights
          • SEIFA Australia
          • ASGS Australia Statistical Geography Standard
          • Residential / Commercial
          • Deliverable address
      • Suburb Lookup
      • Business Validation and Lookup
      • Email Validation
      • Phone Validation
      • Matching
      • Moved Suppression
      • Deceased Suppression
      • Objects
        • Address Objects
        • Address Type Objects
        • Suburb Objects
        • Parse Objects
        • Email Objects
        • Phone Objects
        • Property Title Objects
        • Match Objects
        • Business Objects
      • Deprecated API services
        • Email Validation v1.1
        • Address v1
        • Address Cleanse v1
        • Address International
        • Address Combined
        • Address Types
    • Guides
      • Best Practices
        • Address Field Mappings
        • Finding an Address
      • User Derived Address
      • Expanded sub-premise reach
      • Parcel Locker Plus
      • Migrating to Address V2
      • Sign up/ Login
      • Support
      • Console
        • Getting your API keys
        • Getting Started
        • Add a Service
        • Dashboard
        • Subscriptions
          • Features
          • Users
          • Subscribed Plans
          • Allowlisting domains
          • Blocklist - Email Validation
        • Reports
        • Invoices
          • Paying Invoices
      • API Latency
    • Demos
      • How to use our demos
      • Address Validation Demo
      • Address by Geocode (Reverse Geocode) Demo
      • Address Cleanse Demo
      • Address Parse Demo
      • Business Validation Demo
      • Email Validation Demo
      • Phone Validation demo
    • Integrations
      • Client Libraries
        • Javascript Library v2.1.0
      • Adobe Commerce (Magento 2) Plugin
        • Magento2 User Guide
      • Woocommerce Plugin
        • Woocommerce Install Guide v2.0.0
        • Woocommerce Settings guide v2.0.0
      • Shopify Plus App
      • Gravity Forms
      • Voxco Survey Software
      • Salesforce CRM
      • Dynamics 365 CRM
      • Batch App - Lightweight
      • Deprecated Integrations
        • Harmony RightAddress c# example
        • Harmony RightAddress cURL example
        • Deprecated JS Library v2.0.1
        • Deprecated JQuery Library v1.8.1
    • Coverage
    • Address Exchange (Beta)
      • ADX Console
        • Searching Addresses in console
        • Create Address in console
        • Create Actions in console
      • ADX API Specification
        • Create Address
        • Get Address
        • Create Address Event
        • Edit Address Event
        • Create/Edit Address Attributes
        • Create/Edit Address Geopoint
        • Get Source Events
      • Reserved Attributes
    • GBG Status
  • Batch / Bulk Data Services
    • Serviced Batch
      • Bulk Address Cleanse
      • Email Serviced Batch
      • Phone Serviced Batch
      • Business Serviced Batch
  • Harmony Suite
    • Harmony Suite Overview
    • Release Notes
      • Version 3.0.0
        • New Features
        • Enhancements
        • Bug Fixes
        • Supported Platforms
    • User Guides
      • Version 3.0.0
        • Welcome to Harmony Suite
        • Glossary of terms
        • Upgrades
          • HSQL Upgrade
        • Email and Phone Validation
          • Prerequisites
          • Phone and Email PDP Configuration Setup
          • Phone Validation using Harmony Batch System
          • Phone Validation using Harmony WS
          • Email Validation using Harmony Batch
          • Email Validation using Harmony WS
          • Guides
            • Understanding Phone Data
            • Understanding Email Data
        • Business Lookup and Validation
          • Prerequisites
          • Business Lookup
          • Business Validation
            • Business Validation using Commercial Name Parser
            • Business Validation Configurations
            • Business Validation using Harmony Batch System
            • Business Validation using Harmony WS
          • Business data update guide
          • Guides
            • Understanding Business Data
            • Understanding Business Verification Code
            • Name Parse Ambiguity
        • Australia Post Parcel Locker Plus Lookup and Validation
          • Prerequisites
          • Australia Post Parcel Locker Plus Lookup
          • Australia Post Parcel Locker Plus Validation
            • PDP Configuration Setup
            • AupostValidation using Harmony Batch System
            • AupostValidation using Harmony WS
          • Guides
            • Knowledgebase Lexical Update
            • Understanding Australia Post Parcel Locker Plus Data
            • Interchangeable terms for Australia Post Parcel Lockers
        • Installation and Upgrade Reference Guide
        • Locate Reference Guide
        • Extensions Reference Guide
        • RealTime Reference Guide
        • Postmaster Reference Guide
        • Rapid Address ANZ Reference Guide
        • Post ANZ Reference Guide
        • Source of Truth Installation Reference Guide
        • Knowledgebase Configuration Reference Guide
        • Web Services Reference Guide
        • Management Console Reference Guide
        • Batch System Match Reference Guide
        • Batch System Cleanse Reference Guide
  • More from GBG
    • GBG GreenID
    • GBG Identity
    • GBG Fraud & Compliance
Powered by GitBook
On this page
  • BusinessRequest
  • HostedBusinessRestResponse
  • BusinessSummary
  • BusinessDetail
  • BusinessEntity
  1. Loqate Harmony API
  2. API Specification
  3. Objects

Business Objects

PreviousMatch ObjectsNextDeprecated API services

Last updated 1 year ago

Request wrapper for REST methods.

Response wrapper for REST methods

BusinessRequest

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

name*

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

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

For 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

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

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

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

JSON Representation

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

BusinessDetail

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

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

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"
}

Business summary information from API

Detail information of Business from API.

Object which is included in the for other names of the entity

Note: Here is the link to the complete list of entity types →

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

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

Type: String. Id to use for the retrieve API call in order to get information.

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

Type: List of object for other entity names.

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

https://abr.business.gov.au/Documentation/ReferenceData
BusinessSummary
BusinessDetail
full detail of the business entity
BusinessEntity
Business
BusinessRequest
HostedBusinessRestResponse
BusinessSummary
BusinessDetail
BusinessEntity
BusinessDetail
BusinessEntity
Find
Retrieve
Find
Retrieve
find
retrieve
find
retrieve