Easily create beautiful pdf invoices.
Project description
Easy Invoice is a package that will help you to create beautiful PDF invoices with ease.
If this package helped you out please star us on Github!
Much appreciated!
Platform support
Platform | Repository | Supported | Link |
---|---|---|---|
PHP | Composer | Yes! | |
Javascript | NPM | Yes! | |
Python | PIP | Yes! | |
Java | Maven | In progress... |
Sample
JSON Configs used for above samples:
Installing
Using PIP:
$ pip install easyinvoice
Using PIP3:
$ pip3 install easyinvoice
Getting Started - Basic Example
# Import the EasyInvoice library
from easyinvoice import EasyInvoice
# This will return the PDF as base64 string
result = EasyInvoice.create({})
# To save the PDF locally call the save function
EasyInvoice.save(result["pdf"])
Full Example
# Import the EasyInvoice library
from easyinvoice import EasyInvoice
# Data will contain all the information we would like to see on our invoice
data = {
# Customize enables you to provide your own templates
# Please review the documentation for instructions and examples
"customize": {
# "template": "SGVsbG8gd29ybGQh" // Must be base64 encoded html. This example contains 'Hello World!' in base64
},
"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": "sender-custom1",
# "custom2": "sender-custom2",
# "custom3": "sender-custom3"
},
# Your recipient
"client": {
"company": "Client Corp",
"address": "Clientstreet 456",
"zip": "4567 CD",
"city": "Clientcity",
"country": "Clientcountry"
# "custom1": "client-custom1",
# "custom2": "client-custom2",
# "custom3": "client-custom3"
},
"information": {
# Invoice number
"number": "2021.0001",
# Invoice data
"date": "12-12-2021",
# Invoice due date
"due-date": "31-12-2021"
},
# The products you would like to see on your invoice
# Total values are being calculated automatically
"products": [
{
"quantity": 2,
"description": "Test2",
"tax-rate": 6,
"price": 33.87
},
{
"quantity": 4.1,
"description": "Test1",
"tax-rate": 6,
"price": 12.34
},
{
"quantity": 4.5678,
"description": "Test2",
"tax-rate": 21,
"price": 6324.453456
}
],
# The message you would like to display on the bottom of your invoice
"bottom-notice": "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')
# "tax-notation": "gst", # Defaults to 'vat'
# "margin-top": 25, # Defaults to '25'
# "margin-right": 25, # Defaults to '25'
# "margin-left": 25, # Defaults to '25'
# "margin-bottom": 25, # Defaults to '25'
# "format": "A4" # Defaults to A4, options: A3, A4, A5, Legal, Letter, Tabloid
},
# Translate your invoice to your preferred language
"translate": {
# "invoice": "FACTUUR", # Default to 'INVOICE'
# "number": "Nummer", # Defaults to 'Number'
# "date": "Datum", # Default to 'Date'
# "due-date": "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'
# "product-total": "Totaal", # Defaults to 'Total'
# "total": "Totaal" # Defaults to 'Total'
},
}
# Returns a dict containing all the data of the invoice
result = EasyInvoice.create(data)
# Store the pdf locally
EasyInvoice.save(result["pdf"], 'myInvoice')
Return values
Key | Value | Data Type |
---|---|---|
result["pdf"] | The PDF file as base64 string | String |
result["calculations"]["products"] | Array of 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 |
Locales and Currency
Used for number formatting and the currency symbol:
# E.g. for Germany, prices would look like 123.456,78 €
data = {
"settings":
{
"locale": "de-DE",
"currency": "EUR"
}
}
# E.g. for US, prices would look like $123,456.78
data = {
"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 url inputs accept either a URL or a base64 encoded file.
Supported file types:
- Logo: image
- Background: image, pdf
URL
data = {
"images": {
"logo": "https://public.easyinvoice.cloud/img/logo_en_original.png",
"background": "https://public.easyinvoice.cloud/img/watermark_draft.jpg"
}
}
Base64
data = {
# 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
Template customization
Download our default template (invoice-v2) here to have an example which you can customize.
Supported file types:
- Base64
- URL (soon)
# You are able to provide your own html template
html = "<p>Hello world! This is invoice number %number%</p>"
data = {
"customize": {
# Your template needs to be base64 encoded
"template": base64.b64encode(html)
},
"settings": {
"number": '2022.0001'
}
}
EasyInvoice.create(data)
# This will return a pdf with the following content
# Hello world! This is invoice number 2022.0001
Variable placeholders
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:
<products>
<!-- Product row html -->
</products>
Don't leave out the product tags or your custom product row won't be iterable by the template parser and you will end up with a single product row. Customize the html as you wish. |
products |
Within: <products></products>
%description% |
products[].description |
Within: <products></products>
%quantity% |
products[].quantity |
Within: <products></products>
%price% |
products[].price |
Within: <products></products>
%row-total% |
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:
<tax>
<!-- Tax row html -->
</tax>
Don't leave out the tax tags or your custom tax row won't be iterable by the template parser and you will end up with a single tax row. Customize the html as you wish. |
tax |
Within: <tax></tax>
%tax-notation% |
settings.tax-notation |
Within: <tax></tax>
%tax-rate% |
Auto inserted: Distinct tax rate used in products |
Within: <tax></tax>
%tax% |
Auto inserted: Calculated total tax for rate |
%total% | Auto inserted: Calculated total price including tax |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for easyinvoice-2.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f885b44e9a31abb395530d90d857eb3b047da307199d6840898e2a0b0dc5a339 |
|
MD5 | 2f41063ba51de4912d82cd27831878e6 |
|
BLAKE2b-256 | 221b9d90dcc5e2bce07d6508acb97c1a1e42918d348016864cf1ef8d4f606954 |