Use Rails methods to interact with your data in Bukku accounting software.

Take a look at Bukku's API to know what data you can extract from Bukku.

As of February 2026, the gem handles GET, POST, and file upload requests.

Add the gem into your Gemfile like so:

gem "bukku_rails"

1. Install the gem gem install bukku_rails

2. Test the gem standalone irb -r bukku_rails

3. If your satisfied with the gem usage you can include the gem in your Gemfile of your app.

You will need 2 things - your subdomain and API Token.

You can get these after you login into your Bukku account, Control Panel -> Integrations -> Turn ON API Access.

Note: Bukku offers 2 type of access:

1. Staging - For testing your app. You can email Bukku for a Staging account which will be a great way to test your Rails app to see if it is extracting the correct data from Bukku's staging server (exactly the same app).

2. Production - Your actual Bukku data, where all your data lives.

Bukku Rails provides usage for both access, under 2 different classes:

1. Staging use the BukkuTest class, like so client = BukkuTest.new(domain: "sub-domain", token: "api-token-from-bukku-fyi")

2. Production use Bukku class, like so client = Bukku.new(domain: "sub-domain", token: "api-token-from-bukku-my")

Just like in Rails the methods follow the singular and plural expression. Methods that might return multiple records are plural expression methods. While methods that returns or create a single records are singular methods. So be careful where you put your s's 😁

To use the gem you will need to initialize a client first. Either choose a Bukku's Staging or Production server to test your app.

For Staging at https://api.bukku.fyi

client = BukkuTest.new(
  token: "your_bukku_api_token",
  domain: "your_company_subdomain"
)

For Production at https://api.bukku.my

client = Bukku.new(
  token: "your_bukku_api_token",
  domain: "your_company_subdomain"
)

Fetch all invoices:

invoices = client.get_invoices

Fetch invoices with date filters or parameters: To know more on what Query Parameters is acceptable head to Bukku API page

invoices = client.get_invoices(date_from: "2025-11-01", date_to: "2025-11-30")

Fetch a specific invoice:

invoice = client.get_invoice(123)

Creating a new contact (or supplier):

body = {
  entity_type: "MALAYSIAN_COMPANY",
  legal_name: invoice.supplier_name,
  types: ["supplier"]
}

contact = client.create_contact(body: body)

File upload:

file_data = File.read("invoice.pdf")
filename  = "invoice.pdf"
mime_type = "application/pdf"

client.upload_file(file_data: file_data, filename: filename, mime_type: mime_type)

Bug reports and pull requests are welcome on GitHub at https://github.com/stopar/bukku_rails.

The gem is available as open source under the terms of the MIT License