freshbooks 6.x-2.0-beta1

This is the first public release of the FreshBooks API 2.x module.

Getting Started

NOTE: Version 2.x of the FreshBooks API module is a rewrite that wraps around the FreshBooks PHP library by Milan Rukavina. Its interface is not compatible with modules and site code that was written for version 1.x of the FreshBooks module.

1. Download the zip file for version 1.2 of the FreshBooks PHP library by Milan Rukavina. Later versions may be compatible, but have not been tested.
2. Under your Drupal site folder, create a libraries folder (i.e. sites/example.com/libraries or sites/all/libraries).
3. Extract the contents of the library/FreshBooks folder from the zip file into libraries/freshbooks-php. When done, the path from the root of the Drupal install to the file HttpClient.php should be something like sites/example.com/libraries/freshbooks-php/HttpClient.php or sites/all/libraries/freshbooks-php/HttpClient.php.
4. Install the Libraries API module.
5. Install the 2.x FreshBooks API module.
6. Visit Administer > Site Configuration > FreshBooks to supply and test your FreshBooks API access credentials.

API Integration Status

The FreshBooks PHP library natively supports almost all of the FreshBooks API that was published on http://developers.freshbooks.com as of February 2, 2010.

FreshBooks Extended API

In addition, enabling the included "FreshBooks Extended API" sub-module adds support for features FreshBooks added on February 23, 2010, including auto-billing, webhooks, client "view links", and the following additional calls:

• callback.create
• callback.verify
• callback.resendToken
• callback.list
• callback.delete

The following API call is known to be unsupported:

• gateway.list

FreshBooks Webhooks API

Enabling the included "FreshBooks Webhooks API" sub-module (which depends upon the "FreshBooks Extended API" sub-module) enables a Drupal site to respond to Webhooks call-backs by implementing special Drupal hooks. See freshbooks_webhooks/hooks.php for examples and documentation on all currently known webhooks hook implementations.

The callback URI on the FreshBooks site should be set to the menu path freshbooks/callback on the Drupal site (i.e. http://www.example.com/freshbooks/callback). The FreshBooks Webhooks API module will automatically verify the callback with FreshBooks using the callback.verify API call. Incoming Webhooks callbacks should also generate entries in the watchdog log.