If this package helped you out please star us on Github!
Much appreciated!
Using composer:
$ composer require budgetinvoice/easyinvoice
Note: Since these samples are in JSON, don't forget to convert them to PHP notation when used
Plan | Rate | Price | Link |
---|---|---|---|
Free | 25 invoices / 15 days | $0 | Not required to register |
Paid | Unlimited | - 30 day free trial - 1st month $1.99 - $17.99 per month *Prices include VAT |
Note: The GUI is not (yet) fully translated to English, though the path to getting an apiKey should mostly be in
English. Also this will allow you to use the in app purchase mechanism to pay for the subscription.
When using the free version, you can set the mode to 'development' to make sure you are not running into rate limits while testing this package or developing your invoices. The free version is limited to 25 invoices per 15 days. When your invoice looks good, you can switch to 'production' mode to create your production invoices. Production mode is activated by either not setting the mode or setting the mode to 'production'.
In case you don't want to use the pip package, but you want to call our invoice creation api directly.
# HTTPS POST
https://api.budgetinvoice.com/v2/free/invoices
# POST Data
Format: JSON
Structure: {
"data": { # Parent parameter must be 'data'
"mode": "development", # Production or development, defaults to production
"products": [
{
"quantity": 2,
"description": "Test product",
"taxRate": 6,
"price": 33.87
}
],
}
}
# Optionally add your paid apiKey to the header
Header: "Authorization": "Bearer 123abc" # Please register to receive a production apiKey: https://app.budgetinvoice.com/register
require __DIR__ . '/vendor/autoload.php';
use BudgetInvoice\EasyInvoice
// Set the data you wish to see on your invoice
$invoiceData = [
"apiKey" => "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
"mode" => "development", // Production or development, defaults to production
"product": [
"quantity" => 2,
"description" => "Product 1",
"tax-rate" => 6,
"price" => 33.87
]
];
// Sample code to test the library
$invoice = EasyInvoice::create($invoiceData);
// The invoice['pdf'] variable wil contain a base64 PDF string
echo $invoice['pdf'];
// Save the file locally as PDF
$fileName = 'invoice';
EasyInvoice::save($invoice['pdf'], $fileName);
Our API is able to handle high volumes of requests. If you need to create a lot of invoices fast, make sure to create them asynchronously. This will allow you to create multiple invoices at the same time.
require __DIR__ . '/vendor/autoload.php';
use BudgetInvoice\EasyInvoice
//Set the data you wish to see on your invoice
$invoiceData = [
"apiKey" => "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
"mode" => "development", // Production or development, defaults to production
"images" => [
// The logo on top of your invoice
"logo" => "https://public.easyinvoice.cloud/img/logo_en_original.png",
// The invoice background
"background" => "https://public.easyinvoice.cloud/img/watermark-draft.jpg"
],
// Your own data
"sender" => [
"company" => "Sample Corp",
"address" => "Sample Street 123",
"zip" => "1234 AB",
"city" => "Sampletown",
"country" => "Samplecountry"
//"custom1" => "custom value 1",
//"custom2" => "custom value 2",
//"custom3" => "custom value 3"
],
// Your recipient
"client" => [
"company" => "Client Corp",
"address" => "Clientstreet 456",
"zip" => "4567 CD",
"city" => "Clientcity",
"country" => "Clientcountry"
// "custom1" => "custom value 1",
// "custom2" => "custom value 2",
// "custom3" => "custom value 3"
],
"information" => [
// Invoice number
"number" => "2021.0001",
// Invoice data
"date" => "12-12-2021",
// Invoice due date
"dueDate" => "31-12-2021"
],
// The products you would like to see on your invoice
// Total values are being calculated automatically
"products" => [
[
"quantity" => 2,
"description" => "Product 1",
"taxRate" => 6,
"price" => 33.87
],
[
"quantity" => 4.1,
"description" => "Product 2",
"taxRate" => 6,
"price" => 12.34
],
[
"quantity" => 4.5678,
"description" => "Product 3",
"taxRate" => 21,
"price" => 6324.453456
]
],
// The message you would like to display on the bottom of your invoice
"bottomNotice" => "Kindly pay your invoice within 15 days.",
// Settings to customize your invoice
"settings" => [
"currency" => "USD", // See documentation 'Locales and Currency' for more info. Leave empty for no currency.
// "locale" => "nl-NL", // Defaults to en-US, used for number formatting (See documentation 'Locales and Currency')
// "marginTop" => 25, // Defaults to '25'
// "marginRight" => 25, // Defaults to '25'
// "marginLeft" => 25, // Defaults to '25'
// "marginBottom" => 25, // Defaults to '25'
// "format" => "A4", // Defaults to A4, options => A3, A4, A5, Legal, Letter, Tabloid
// "height" => "1000px", // allowed units: mm, cm, in, px
// "width" => "500px", // allowed units: mm, cm, in, px
// "orientation" => "landscape" // portrait or landscape, defaults to portrait
],
// Translate your invoice to your preferred language
"translate" => [
// "invoice" => "FACTUUR", // Default to 'INVOICE'
// "number" => "Nummer", // Defaults to 'Number'
// "date" => "Datum", // Default to 'Date'
// "dueDate" => "Verloopdatum", // Defaults to 'Due Date'
// "subtotal" => "Subtotaal", // Defaults to 'Subtotal'
// "products" => "Producten", // Defaults to 'Products'
// "quantity" => "Aantal", // Default to 'Quantity'
// "price" => "Prijs", // Defaults to 'Price'
// "productTotal" => "Totaal", // Defaults to 'Total'
// "total" => "Totaal" // Defaults to 'Total',
// "taxNotation" => "btw", // Defaults to 'vat'
],
// Customize enables you to provide your own templates
// Please review the documentation for instructions and examples
// "customize" => [
// "template" => base64_encode("<p>Hello World</p>"); // Must be base64 encoded html
// ],
];
//Sample code to test the library
$invoice = EasyInvoice::create($invoiceData);
//The invoice object wil contain a base64 PDF string
echo $invoice['pdf'];
// Save the file locally as PDF
$fileName = 'invoice';
EasyInvoice::save($invoice['pdf'], $fileName);
Key | Value | Data Type |
---|---|---|
result['pdf'] | The PDF file as base64 string | String |
result['calculations']['products'] | Array of objects reflecting the products used in creation | Array |
result['calculations']['products'][key]['subtotal'] | Rounded price without tax per product | Number |
result['calculations']['products'][key]['tax'] | Rounded tax per product | Number |
result['calculations']['products'][key]['total'] | Rounded price including tax per product | Number |
result['calculations']['tax'] | Array of objects containing total calculated tax per unique tax rate | Array |
result['calculations']['tax'][rate] | Total tax for all products with same tax rate | Number |
result['calculations']['subtotal'] | Rounded price without tax for all products | Number |
result['calculations']['total'] | Rounded price without tax for all products | Number |
require __DIR__ . '/vendor/autoload.php';
use BudgetInvoice\EasyInvoice
// Set the data you wish to see on your invoice
$invoiceData = [
"apiKey" => "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
"mode" => "development", // Production or development, defaults to production
"product": [
"quantity" => 2,
"description" => "Product 1",
"tax-rate" => 6,
"price" => 33.87
]
];
try {
// Sample code to test the library
$invoice = EasyInvoice::create($invoiceData);
// The invoice['pdf'] variable wil contain a base64 PDF string
echo $invoice['pdf'];
// Save the file locally as PDF
$fileName = 'invoice';
EasyInvoice::save($invoice['pdf'], $fileName);
} catch (Exception $e){
echo $e->getMessage();
}
Used for number formatting and the currency symbol:
//E.g. for Germany, prices would look like 123.456,78 €
$data = [
"apiKey" => "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
"mode" => "development", // Production or development, defaults to production
"settings" => [
"locale" => "de-DE",
"currency" => "EUR"
]
];
//E.g. for US, prices would look like $123,456.78
$data = [
"apiKey" => "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
"mode" => "development", // Production or development, defaults to production
"settings" => [
"locale" => "en-US",
"currency" => "USD"
]
];
Formatting and symbols are applied through the ECMAScript Internationalization API
Click here for a list of locale codes
Click here for a list of currency codes
Disclaimer: Not all locales and currency codes found in the above lists might be supported by the ECMAScript Internationalization API.
The logo and url inputs accept either a URL or a base64 encoded file.
Supported file types:
$invoiceData = [
"apiKey" => "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
"mode" => "development", // Production or development, defaults to production
"images" => [
"logo" => "https://public.easyinvoice.cloud/img/logo_en_original.png",
"background" => "https://public.easyinvoice.cloud/img/watermark_draft.jpg"
]
];
$invoiceData = [
"apiKey" => "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
"mode" => "development", // Production or development, defaults to production
//Note: Sample base64 string
//Please use the link below to convert your image to base64
"images":[
"logo" => "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"background" => "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
]
];
Click here for an online tool to convert an image to base64
Download our default template (invoice-v2) here to have an example which you can customize.
Supported file types:
// You are able to provide your own html template
$html = "<p>Hello world! This is invoice number %number%</p>";
$invoiceData = [
"apiKey" => "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
"mode" => "development", // Production or development, defaults to production
"customize" => [
"template" => base64_encode($html) // Your template must be base64 encoded
],
"information" => [
"number" => "2022.0001"
]
];
$invoice = EasyInvoice::create($invoiceData);
// This will return a pdf with the following content
// Hello world! This is invoice number 2022.0001
The following placeholders can be put into your template. They will be replaced by their corresponding value upon creation.
Placeholder | Will be replaced by |
%document-title% | translate.invoice |
%logo% | images.logo |
%company-from% | sender.company |
%address-from% | sender.address |
%zip-from% | sender.zip |
%city-from% | sender.city |
%country-from% | sender.country |
%sender-custom-1% | sender.custom1 |
%sender-custom-2% | sender.custom2 |
%sender-custom-3% | sender.custom3 |
%company-to% | client.company |
%address-to% | client.address |
%zip-to% | client.zip |
%city-to% | client.city |
%country-to% | client.country |
%client-custom-1% | client.custom1 |
%client-custom-2% | client.custom2 |
%client-custom-3% | client.custom3 |
%number-title% | translate.number |
%number% | settings.number |
%date-title% | translate.date |
%date% | settings.date |
%due-date-title% | translate.due-date |
%due-date% | settings.due-date |
%products-header-products% | translate.products |
%products-header-quantity% | translate.quantity |
%products-header-price% | translate.price |
%products-header-total% | translate.product-total |
A custom product row must be enclosed in products tags like:
```html
|
products |
```html
Within:
|
products[].description |
```html
Within:
|
products[].quantity |
```html
Within:
|
products[].price |
```html
Within:
|
products[].quantity * products[].price (rounded) |
%subtotal-title% | translate.subtotal |
%subtotal% | Auto inserted:
Calculated total price excluding tax |
A custom tax row must be enclosed in tax tags like:
```html
|
tax |
```html
Within:
|
settings.tax-notation |
```html
Within:
|
Auto inserted: Distinct tax rate used in products |
```html
Within:
|
Auto inserted: Calculated total tax for rate |
%total% | Auto inserted: Calculated total price including tax |