punkstar/phreeagent

This package is abandoned and no longer maintained. No replacement package was suggested.

A PHP library for programmatic access to the FreeAgent API

dev-master 2013-10-17 12:14 UTC

Requires

• rmccue/requests: >=1.0

MIT

• Nick Jones

• freeagent

README

This library is incomplete, but you may find it useful.

Implement Features

• Invoices
  • Fetch Single
  • Create
  • Send Email
  • Mark as sent
• Contacts
  • Create
  • Fetch Single
  • Fetch All

Example

<?php
require_once "vendor/autoload.php";

$client_id = '123';
$client_secret = '456';
$refresh_token = '789';

$customer_email = '[e-mail]';
$customer_firstname = 'Nick';
$customer_lastname = 'Jones';
$item_name  = 'Test';
$invoice_total = 29.99;
$included_vat = true;
$order_id = 123;

$config = new Phreeagent\Config($client_id, $client_secret, $refresh_token);

/*
 * Find the customer, create if not available.
 */
$contact = new \Phreeagent\Contact($config);
$all_customers = $contact->all();

if (isset($all_customers[$customer_email])) {
    $customer = $all_customers[$customer_email];
} else {
    $customer = new \Phreeagent\Contact($config);
    $customer->first_name = $customer_firstname;
    $customer->last_name = $customer_lastname;
    $customer->email = $customer_email;
    $customer->create();
}

/*
 * Create the invoice
 */
$invoice = new Phreeagent\Invoice($config);
$invoice->setContact($customer);
$invoice->setDatedOn(new DateTime('now'));
$invoice->comments = 'This is the invoice comment';
$invoice->payment_terms_in_days = 0;

/*
 * Create the invoice item
 */
$invoice_item = new \Phreeagent\Invoice\InvoiceItem();
$invoice_item->description = $item_name;
$invoice_item->item_type = 'Products';
$invoice_item->quantity = 1;
$invoice_item->price = ($included_vat) ? ($invoice_total/1.2) : $invoice_total;
$invoice_item->sales_tax_rate = ($included_vat) ? 20 : null;

/*
 * Add the item to the invoice and create
 */
$invoice->addInvoiceItem($invoice_item);
$invoice->create();

/*
 * Email the invoice to the customer
 */
$message_body = <<<TEXT
$customer_firstname $customer_lastname,

Thanks for purchasing from us!  We've attached your invoice for your reference.  Your invoice is paid, there's no further action required on your part.

Regards,

Test

TEXT;

$invoice->sendEmail($customer_email, '[e-mail]', 'Your Invoice for #' . $order_id, $message_body);

/*
 * Mark the invoice as sent
 */
$invoice->markAsSent();