Skip to main content

A client library for the FreshBooks API

Project description

Refreshbooks provides a simple synchronous API for manipulating FreshBooks
invoices, clients, and other data::

from refreshbooks import api

c = api.OAuthClient(
'example.freshbooks.com',
'consumerkey',
'My Consumer Secret',
'An existing token',
'An existing token secret',
user_agent='Example/1.0'
)

# XML structure inferred from args
response = c.invoice.create( # <request method="invoice.create">
invoice=dict( # <invoice>
client_id='8', # <client_id>8</client_id>
lines=[ # <lines>
api.types.line( # <line>
name='Yard Work', # <name>Yard Work</name>
unit_cost='10', # <unit_cost>10</unit_cost>
quantity='4' # <quantity>4</quantity>
) # </line>
] # </lines>
) # </invoice>
) # </request>

invoice_response = c.invoice.get( # <request method="invoice.get">
invoice_id=response.invoice_id # <invoice_id>...</invoice_id>
) # </request>

print "New invoice created: #%s (id %s)" % (
invoice_response.invoice.number,
invoice_response.invoice.invoice_id
)

invoices_response = c.invoice.list() # <request method="invoice.list" />

print "There are %s pages of invoices." % (
invoices_response.invoices.attrib['pages'],
)

for invoice in invoices_response.invoices.invoice:
print "Invoice %s total: %s" % (
invoice.invoice_id,
invoice.amount
)

Consumer keys and secrets can be obtained from FreshBooks. This library
does not handle negotiating for an OAuth token+secret pair; see the
`oauth` module or the OAuth specification for details.

This library also supports the older token-based API authorization
scheme::

c = api.TokenClient(
'example.freshbooks.com',
'My API token',
user_agent='Example/1.0'
)

# ... as above ...

API methods return lxml.objectify.ObjectifiedDataElement trees, which
can be manipulated as Python objects with the same structure as the
underlying XML.

If you are having trouble accessing items as in:

items_response = c.items.list()
for item in items_response.items.item:
print item.item_id

Adjust your syntax to use dictionary item lookup:

items_response = c.items.list()
for item in items_response['items'].item:
print item.item_id

ObjectifiedDataElement provides a method named items which shadows the
items element in the response. Accessing items with dictionary lookup
syntax is the known work-around.

To run tests:

python setup.py nosetests

To run network-accessing integration tests against httpstat.us:

python setup.py nosetests --attr=integration

References:

- http://developers.freshbooks.com/ - The FreshBooks API
- http://developers.freshbooks.com/authentication-2/#OAuth - FreshBooks and OAuth

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

refreshbooks-2.0.tar.gz (14.2 kB view details)

Uploaded Source

Built Distributions

refreshbooks-2.0-py3.2.egg (22.3 kB view details)

Uploaded Egg

refreshbooks-2.0-py2.7.egg (21.7 kB view details)

Uploaded Egg

File details

Details for the file refreshbooks-2.0.tar.gz.

File metadata

  • Download URL: refreshbooks-2.0.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for refreshbooks-2.0.tar.gz
Algorithm Hash digest
SHA256 17be66415e656e76ae3596de482ad6ceb949a074995335e05283a2f49d445b3f
MD5 042fd53a7b6e4335cbf7209336f077b9
BLAKE2b-256 ea2dbf57186bc4e0e6fc99c7744516e03b2864b546484f0d4b067a0d8e7d064a

See more details on using hashes here.

File details

Details for the file refreshbooks-2.0-py3.2.egg.

File metadata

  • Download URL: refreshbooks-2.0-py3.2.egg
  • Upload date:
  • Size: 22.3 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for refreshbooks-2.0-py3.2.egg
Algorithm Hash digest
SHA256 bd9742e1a494e34314645a457221835b7385861e4d7a27382451d51e1d8c2067
MD5 fba0215c2141934c584dc301da9354f0
BLAKE2b-256 93399335e4bf6fcb9c2217679d7d63664a824a6b75c660b98b52363e5c277f7e

See more details on using hashes here.

File details

Details for the file refreshbooks-2.0-py2.7.egg.

File metadata

  • Download URL: refreshbooks-2.0-py2.7.egg
  • Upload date:
  • Size: 21.7 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for refreshbooks-2.0-py2.7.egg
Algorithm Hash digest
SHA256 2936520b15fe79ad6c69ee3ec3daff6039f5a5ae40c6b0704c3b5a97b3cea951
MD5 fa778aa4c1e999031ca5a7db6ccb1fd4
BLAKE2b-256 17b0f2b2e94d4b2417f6d8d97884c9eba765b07039cfff44e1a1f1f5387a2555

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page