public
Fork of bentlegen/freshbooks.rb
Description: FreshBooks API wrapper
Homepage: http://freshbooks.rubyforge.org
Clone URL: git://github.com/polomasta/freshbooks.rb.git
Turn2Live (author)
Sat Dec 27 02:51:30 -0800 2008
commit  cb0629ecc8a87d400b896fba11c8e66ff111367b
tree    60a40dd24bda6ee352038613db93708661347651
parent  073adeec928c0809a9633f786756c6922babff8c
name age message
file LICENSE Sat Sep 15 08:02:39 -0700 2007 git-svn-id: svn+ssh://rubyforge.org/var/svn/fre... [bentlegen]
file README Wed Aug 06 20:33:46 -0700 2008 Updated README; more like docs at http://freshb... [bentlegen]
file freshbooks.rb Sat Dec 27 02:51:30 -0800 2008 adds support for invoice links [Turn2Live]
README
= 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.