forked from bcurren/freshbooks.rb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
45 lines (26 loc) · 1015 Bytes
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
= 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.