README.md

This gem provides a Ruby API for billomat.com - an online accounting service.

• Installation
• Usage
  • Configuration
  • Basic usage
• Development
• Contributing

Installation

Add this line to your application's Gemfile:

gem 'billomat'

And then execute:

$ bundle

Or install it yourself as:

$ gem install billomat

Usage

Configuration

The billomat gem can be easily configured. If you're using Rails you might want to put this in your application.rb or inside an initializer.

Billomat.configure do |config|
  # Subdomain, e.g. example.billomat.net
  config.subdomain = 'example'
  # API key
  config.api_key   = '4aefdc...'
  # timeout in seconds
  config.timeout   = 5

  # You can also configure a registerd app to increase your
  # API call limit as described here:
  # https://www.billomat.com/en/api/basics/rate-limiting/
  config.app_id = '12345'
  config.app_secret = 'c3df...'
end

Basic usage

Currently there is basic support for the models:

• Invoice
• Client
• InvoicePayment
• InvoiceItem
• Contact

Billomat::Models::Invoice.where(invoice_number: 'RE1234')
=> [#<Billomat::Models::Invoice:0x005574b58d6510 ...]

Billomat::Models::Invoice.find('1234')
=> #<Billomat::Models::Invoice:0x005574b58d6510

client = Billomat::Models::Client.find('1234')
client.save
=> true

client.delete
=> true

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

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