swissqrbill

SwissQRBill

With SwissQRBill you can easily generate the new QR Code payment slips which will be introduced on 30 June 2020 in switzerland.

Contents

• Features
• Installation
• Usage
• API

Features

• Generates PDF with scalable vector graphics
• Supports german, english, italian and french invoices
• Supports A4 invoices as well as A6/5 (QR Bill only)
• Supports empty fields as defined in the specifications
• Allows you to add other content above the invoice using PDFKit
• Easy to use
• Free and open source

Installation

npm i swissqrbill --save

Usage

const SwissQRBill = require("swissqrbill");

const data = {
  currency: "CHF",
  amount: 1199.95,
  reference: "210000000003139471430009017",
  creditor: {
    name: "Robert Schneider AG",
    address: "Rue du Lac 1268",
    zip: 2501,
    city: "Biel",
    account: "CH4431999123000889012",
    country: "CH"
  },
  debitor: {
    name: "Pia-Maria Rutschmann-Schnyder",
    address: "Grosse Marktgasse 28",
    zip: 9400,
    city: "Rorschach",
    country: "CH"
  }
};

const bill = new SwissQRBill.PDF(data, "qrbill.pdf");

This will generate the above PDF.

API

Methods

• Constructor
  • SwissQRBill.PDF(data, outputPath[, options])
• Methods
  • addPage()
  • end()
  • addQRBill()
  • mmToPoints(mm)

SwissQRBill.PDF(data, outputPath[, options])

• data - object containing all relevant billing data.
• outputPath - string output path for the generated PDF file.
• options - object containing settings, optional.

Returns a new instance of SwissQRBill.PDF

Available options:

• language - string: Either "DE" | "EN" | "IT" | "FR". Default "DE".
• size - string: Either "A4" | "A6/5". Default "A6/5".
• scissors - boolean: Whether you want to show the scissor icons or the text Separate before paying in. Default true.
• autoGenerate - boolean: Whether you want to automatically finalize the PDF. When set to false you are able to add your own content to the PDF using PDFKit. Default true.

addPage()

Adds a new page to the PDF.

end()

Finalizes the PDF document, after this command you are no longer able to edit the PDF. Note: This function is automatically called when the option autoGenerate is set to true.

addQRBill()

Adds the QR Bill to the bottom of the current page. Note: This function is automatically called when the option autoGenerate is set to true.

mmToPoints(mm)

• mm - number containg the millimeters you want to convert to points. Converts milimeters to points which are used in the PDF file. Returns a number containing the converted millimeters in points.

PDFKit

This module uses PDFKit to generate PDF files. You are able to generate a complete bill using PDFKit methods and then add the QR Bill to the bottom using addQRBill() when the option autoGenerate is set to false.

The documentation for PDFKit can be found here.

The following example adds 3 Pages and then the QR Bill at the bottom of the third page.

const SwissQRBill = require("swissqrbill");

const data = {
  currency: "CHF",
  amount: 1199.95,
  reference: "210000000003139471430009017",
  creditor: {
    name: "Robert Schneider AG",
    address: "Rue du Lac 1268",
    zip: 2501,
    city: "Biel",
    account: "CH4431999123000889012",
    country: "CH"
  },
  debitor: {
    name: "Pia-Maria Rutschmann-Schnyder",
    address: "Grosse Marktgasse 28",
    zip: 9400,
    city: "Rorschach",
    country: "CH"
  }
};

const bill = new SwissQRBill.PDF(data, "./output/multipage.pdf", { autoGenerate: false });

bill.document.fontSize(11);
bill.document.font("Helvetica-Bold");

bill.document.text("PAGE 1", bill.mmToPoints(5), bill.mmToPoints(20), {
  width: bill.mmToPoints(210),
  align: "center",
});

bill.addPage();

bill.document.text("PAGE 2", bill.mmToPoints(5), bill.mmToPoints(20), {
  width: bill.mmToPoints(210),
  align: "center",
});

bill.addPage();

bill.document.text("PAGE 3", bill.mmToPoints(5), bill.mmToPoints(20), {
  width: bill.mmToPoints(210),
  align: "center",
});

bill.addQRBill();

bill.end();

Changelog

v1.0.6 - 04.03.2020

• Fixed QR Code fields.
• Added user data validation.