`js
var easyinvoice = require('easyinvoice');
`

ES6 =<

`js
import easyinvoice from 'easyinvoice';
`

Getting Started - Basic Example

NodeJS

`js
// Import the library into your project
var easyinvoice = require('easyinvoice');

// Create your invoice! Easy!
var data = {
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
products: [
{
quantity: 2,
description: "Test product",
taxRate: 6,
price: 33.87
}
]
};

easyinvoice.createInvoice(data, function (result) {
// The response will contain a base64 encoded PDF file
console.log('PDF base64 string: ', result.pdf);

// Now this result can be used to save, download or render your invoice
// Please review the documentation below on how to do this
});
`

Web

`html



// Import the library into your project






`

High volume: asynchronous invoice creation

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.

Note: using async/await for this example

`js
// Import the library into your project
var easyinvoice = require('easyinvoice');

// Create a promises array to store all your promises
const promises = [];

// Use a loop to prepare all your invoices for async creation
for (let i = 0; i < 25; i++) {
// Add your invoice data to the promise array
promises[i] = easyinvoice.createInvoice({
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
});
}

// Create all your invoices at the same time
const invoices = await Promise.all(promises);
`

Complete Example (NodeJS)

`js
//Import the library into your project
var easyinvoice = require('easyinvoice');

var data = {
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.budgetinvoice.com/img/logo_en_original.png",
// The invoice background
background: "https://public.budgetinvoice.com/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": fs.readFileSync('template.html', 'base64') // Must be base64 encoded html
// }
};

//Create your invoice! Easy!
easyinvoice.createInvoice(data, function (result) {
//The response will contain a base64 encoded PDF file
console.log('PDF base64 string: ', result.pdf);
});
`

Return values

| 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 | Object 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 with tax for all products | Number |

Error handling

Callback

`js
var easyinvoice = require('easyinvoice');

var data = {
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
};

easyinvoice.createInvoice(data, function (invoice) {
console.log(invoice);
}).catch((error) => {
// Handle the error
console.log(error);
});
`

Async/await

`js
var easyinvoice = require('easyinvoice');

var data = {
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
};

try {
const invoice = await easyinvoice.createInvoice(data);
console.log(invoice);
} catch (error) {
// Handle the error
console.log(error);
}
`

Locales and Currency

Used for number formatting and the currency symbol:

`js
//E.g. for Germany, prices would look like 123.456,78 €
const 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
const 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.

Logo and Background

The logo and background inputs accept either a URL or a base64 encoded file.

Supported file types:

- Logo: image
- Background: image, pdf

$3

`js
const data = {
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.budgetinvoice.com/img/logo_en_original.png",
background: "https://public.budgetinvoice.com/img/watermark_draft.jpg",
}
};
`

$3

`js
const data = {
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=="
}
};
`

$3

`js
//Import fs to be able to read from the local file system
var fs = require("fs");

//Use the code below to read your local file as a base64 string
const data = {
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
images: {
logo: fs.readFileSync('logo.png', 'base64'),
background: fs.readFileSync('images/background.png', 'base64')
}
};
`

Click here for an online tool to convert an image to base64

Async/await support

`js
// Import the library into your project
var easyinvoice = require('easyinvoice');

// Create your invoice! Easy!
var data = {
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
};
const result = await easyinvoice.createInvoice(data);

// The response will contain a base64 encoded PDF file
console.log('PDF base64 string: ', result.pdf);
`

To store the file locally (NodeJS)

`js
var fs = require('fs');

var data = {
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
};
const result = await easyinvoice.createInvoice(data);
await fs.writeFileSync("invoice.pdf", result.pdf, 'base64');
`

Print your invoice (browser only)

`js
var data = {
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
};
const result = await easyinvoice.createInvoice(data);
easyinvoice.print(result.pdf);
`

Download your invoice (browser only)

`js
var data = {
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
};
const result = await easyinvoice.createInvoice(data);
easyinvoice.download('myInvoice.pdf', result.pdf);
// you can download like this as well:
// easyinvoice.download();
// easyinvoice.download('myInvoice.pdf');
`

Render(view) your invoice (browser only)

html

`html




`css
#pdf {
text-align: center;
}

#pdf canvas {
border: 1px solid black;
width: 95%;
}
`

js

`js
var data = {
apiKey: "free", // Please register to receive a production apiKey: https://app.budgetinvoice.com/register
mode: "development", // Production or development, defaults to production
};
const elementId = 'pdf';
const result = await easyinvoice.createInvoice(data);
await easyinvoice.render(elementId, result.pdf);
`

Template customization

Download our default template (
invoice-v2) here to have an
example which you can customize.

Supported file types:

- Base64
- URL (soon)

`js
// You are able to provide your own html template
var html = '

Hello world! This is invoice number %number%

// This will return a pdf with the following content
// Hello world! This is invoice number 2022.0001
`

$3

The following placeholders can be put into your template. They will be replaced by their corresponding value upon
creation.