freshbooks-php-sdk

File Uploads

Some FreshBooks resource can include images and attachments. For example, invoices can have a company logo or banner image as part of the invoice presentation object as well as images or pdfs attachments. Expenses can also include copies or photos of receipts as attachments.

All images and attachments first need to be uploaded to FreshBooks via the images or attachments endpoints.

These will then return a path to your file with a JWT. This path will can then be passed as part of the data in a subsequent call.

See FreshBooks' invoice attachment and expense attachment documentation for more information.

Invoice Images and Attachments

See FreshBooks' API Documentation.

The upload() function takes a PHP resource. Logo's and banners are added to the invoice presentation object. To include an uploaded attachment on an invoice, the invoice request must include an attachments object.

$logo = $freshBooksClient->images()->upload($accountId, fopen('./sample_logo.png', 'r'));
$attachment = $freshBooksClient->attachments()->upload($accountId, fopen('./sample_attachment.pdf', 'r'));

$presentation = [
    'image_logo_src' => "/uploads/images/{$logo->jwt}",
    'theme_primary_color' => '#1fab13',
    'theme_layout' => 'simple'
];

$invoiceData = [
    'customerid' => $clientId,
    'attachments' => [
        [
            'jwt' => $attachment->jwt,
            'media_type' => $attachment->mediaType
        ]
    ],
    'presentation' => presentation
];

$invoice = $freshBooksClient->invoices()->create($accountId, $invoiceData);

Expense Receipts

See FreshBooks' API Documentation.

Expenses have have images or PDFs of the associated receipt attached. The expense request must include an attachments object.

$attachment = $freshBooksClient->attachments()->upload($accountId, fopen('./sample_receipt.pdf', 'r'));

$expense->amount = new Money("6.49", "CAD");
$expense->date = new DateTime();
$expense->staffId = 1;
$expense->categoryId = 3436009;

$expenseAttachment = new ExpenseAttachment();
$expenseAttachment->jwt = $attachment->jwt;
$expenseAttachment->mediaType = $attachment->mediaType;

$expense->attachment = $expenseAttachment;

$includes = (new IncludesBuilder())->include('attachment');
$expense = $freshBooksClient->expenses()->create($accountId, model: $expense, includes: $includes);

Search results