# abn_search

**Repository Path**: rubygems/abn_search

## Basic Information

- **Project Name**: abn_search
- **Description**: No description available
- **Primary Language**: Ruby
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-10-14
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

A simple ABN search library for validating and obtaining ABN details from the Australian Business Register.

You will need a GUID to be able to use the ABR business lookup API. You can obtain one at the following link;
http://abr.business.gov.au/Documentation/UserGuideWebRegistration.aspx

= Rails Installation

Simply add the following line to your Gemfile and run bundle install.

  gem 'abn_search'

= Usage

  require 'abn_search'

  # Search by ABN Number
  client = Abn::Search.new("YOUR_GUID_HERE")
  result = client.search("59001215354")
  => {:acn=>"001215354", ":abn=>"59001215354", :entity_type=>"Australian Public Company", :status=>"Active", :main_name=>"SONY AUSTRALIA LIMITED", :trading_name=>"", :legal_name=>"", :other_trading_name=>"", :name=>"SONY AUSTRALIA LIMITED"}

  puts result[:entity_type]
  => "Australian Public Company"

  puts result[:status]
  => "Active"

  puts result[:name]
  => "SONY AUSTRALIA LIMITED"

  # Search by ACN Number
  result = client.search_by_acn("001215354")
  => {:acn=>"001215354", ":abn=>"59001215354", :entity_type=>"Australian Public Company", :status=>"Active", :main_name=>"SONY AUSTRALIA LIMITED", :trading_name=>"", :legal_name=>"", :other_trading_name=>"", :name=>"SONY AUSTRALIA LIMITED"}

  # Search by name
  results = client.search_by_name("Sony", ['NSW'], '2000')
  results.each do |result|
    puts result[:name]
  end

= Errors
If an ABN is missing, invalid or expired - check the errors attribute.

  client.errors
  => ["Business ABN 89107860122 has expired."]

= Notes
- Australian Business Register: http://www.abr.business.gov.au/
- XML API: http://abr.business.gov.au/ABRXMLSearch/AbrXmlSearch.asmx
- GUID Registration link: http://abr.business.gov.au/Documentation/UserGuideWebRegistration.aspx