Skip to content

A simple wrapper for making requests with the FreshBooks API

License

Notifications You must be signed in to change notification settings

rtconner/freshbooks-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FreshBooks API

PHP wrapper for the FreshBooks API. Simplifies FreshBooks API XML structure into a PHP array strucure. You need to know the method names and params when you're creating a new FreshBooksApi instance. See all here http://developers.freshbooks.com/

Composer Install

composer require rtconner/freshbooks-api dev-master

.. or ..

"require": {
    "rtconner/freshbooks-api": "dev-master"
}

Sample Code

The XML tag parameters you see on the freshbooks API page are the ones you pass to $fb->post() (as an array)

$domain = 'your-subdomain'; // Do not include the URL scheme (https://). It will be added automatically
$token = '1234567890'; // your api token found in your account
$fb = new Freshbooks\FreshBooksApi($domain, $token); 

Example: list clients with an email of some@email.com

// Method names are the same as found on the freshbooks API
$fb->setMethod('client.list');

// For complete list of arguments see FreshBooks docs at http://developers.freshbooks.com
$fb->post(array(
    'email' => 'some@email.com'
));

$fb->request();

if($fb->success()) {
	echo 'successful! the full response is in an array below';
	var_dump($fb->getResponse());
} else {
	echo $fb->getError();
	var_dump($fb->getResponse());
}

Credits