freshbooks.rb

freshbooks.rb copied to clipboard

= About

FreshBooks.rb is a Ruby interface to the FreshBooks API. It exposes easy-to-use classes and methods for interacting with your FreshBooks account.

= Examples

Initialization:

FreshBooks.setup('sample.freshbooks.com', 'mytoken')

Updating a client name:

clients = FreshBooks::Client.list client = clients[0] client.first_name = 'Suzy' client.update

Updating an invoice:

invoice = FreshBooks::Invoice.get(4) invoice.lines[0].quantity += 1 invoice.update

Creating a new item

item = FreshBooks::Item.new item.name = 'A sample item' item.create

= License

This work is distributed under the MIT License. Use/modify the code however you like.

= Download

FreshBooks.rb is distributed as a gem via Rubyforge. The easiest way to install it is like so:

gem install freshbooks

Alternatively, you can download it from the Rubyforge project page.

= Credits

FreshBooks.rb is written and maintained by Ben Vinegar, with contributions from Flinn Meuller, Kenneth Kalmer, and others.