Invoice-pdfkit

Business document generator

• License: MIT License
• Author: Matteljay
• Language: JavaScript with TypeScript definitions
• IDE: Visual Studio Code
• Homepage: https://libersystems.com

Table of contents

• About
• Example
• Features
• Donation
• Translation
• Notes

About

invoice-pdfkit attempts to standardize and internationalize the creation of common business pdf documents. Retail articles and hourly job declarations often require documents such as: invoice, price quotation, packing slip, receipt, return checklist and refund proofs. Those can now be generated from three simple JavaScript objects: company, order and payment, all very flexible with optional fields. Traditional bank transfer and cryptocurrency transactions on all layers are supported. Total amounts and optional tax compliance such as VAT and sales taxes are automatically calculated from your list of prices.

Example

Minimal code usage, install this module in your project folder: npm i invoice-pdfkit

const tradePDF = require("invoice-pdfkit");
const fs = require("fs");

const myCompany = {
  company: "Your Awesome Name",
  email: "[email protected]",
  web: "https://that-buzz.org",
};

const myOrder = {
  id: "S4TIX8GX",
  date: {
    created: 1659372135311,
    due: 1655118412147,
  },
  bill: {
    company: "SomeTarget Inc.",
    email: "[email protected]",
  },
  items: [
    {
      id: "w85",
      desc: "Expensive Watch",
      tax: "21",
      qty: "18",
      price: "2545.25",
    },
    {
      id: "s63",
      desc: "Repair service in hours",
      tax: "9",
      qty: "2",
      price: "32.0",
    },
  ],
  total: {
    discount: 41,
    stateTax: 10,
    fedTax: 5.1,
    ship: 7.24,
  },
};

console.log("Language options: " + tradePDF.getLanguages());
tradePDF.init({
  logo: fs.existsSync("logo.jpg") ? fs.readFileSync("logo.jpg") : undefined,
  company: myCompany,
  currency: "USD",
});
const pdfData = tradePDF.invoice(myOrder);
fs.writeFileSync("simple.pdf", pdfData);
console.log("Generated simple.pdf");

More complete examples with PDF output are available in test/. If you clone this repo, npm run tsstart will regenerate the example files.

Features

• Integration with the Node Package Manager: invoice-pdfkit
• Easy to translate for your language, see the locales/ folder.
• Can be used to declare working hours as well as a list of articles and their prices.
• Total price is automatically calculated, factoring in several price inputs.
• Common types of VAT and sales tax fields are supported.
• Exchange rate specification for final payment in a different currency (such as bitcoin) is supported.
• QR-code support for both legacy bank transfers and crypto payments, especially useful for the long address payload of bitcoin lightning network invoices.
• Short-form human readable crypto addresses such as Ethereum's ENS can be specified in either the company or payment object at the same location as the bank account number or IBAN/SEPA number.
• A list of all supported fields can be found in types/main.d.ts. TypeScript support is optional. Most of the fields are demonstrated by the example files.
• Add function for return total price in float. Just see examples in test/run.ts.

Donation

This software is free as in transparent, open source and can be used per MIT license. Not free as in zero cost, 1000 lines of code didn't grow on a tree and no ads are integrated. Buy the writer a coffee or whatever you consider reasonable if you decide to use it in the current or modified state. Further details in CONTACT.md.

Translation

Currently supported languages:

• English (GB, US, CA, AU, ...)
• Dutch (NL and Flanders BE)
• German (DE, AT, CH)
• Indonesia (ID)

To add your language, go to the locales/ folder and create a folder specific to your language with a translation.json inside. After forking and editing, feel free to create a Git pull request. Don't forget to add your language to this README.md as well.

Notes

Some fields may be missing for your region. For example: most dutch entrepreneurs are forced to register a KvK number. Simply add that text in the company.registration field: "KvK 0441.956.713". Australian banks may require a BSB number for payments. Simply add that text to payment.bankID or company.bankID: "BSB 033-548". All supported fields can be found here: types/main.d.ts. If you still feel some essential fields are missing, a Git pull request is welcome.

The source code includes a reasonably advanced flex-table implementation for pdfkit, see the module src/flex-table.js this may be used in your own projects.