Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Python FreshBooks API client

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.rst

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'
)

response = c.invoice.create(
    invoice=dict(
        client_id='8',
        lines=[
            api.types.line(
                name='Yard Work',
                unit_cost='10',
                quantity='4'
            )
        ]
    )
)

invoice_response = c.invoice.get(
    invoice_id=response.invoice_id
)

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

invoices_response = c.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.

References:

Something went wrong with that request. Please try again.