swissqrbill Java Library

To generate a QR bill, follow these steps:

1. Instantiate a Bill object.
2. Populate the Bill with account details (IBAN), amount, currency, and reference.
3. Create Address objects for both the creditor and debtor and assign them to the bill.
4. Configure the output format using BillFormat (e.g., setting GraphicsFormat, OutputSize, and Language).
5. Call QRBill.generate(bill) to receive the generated content as a byte[].

package net.codecrete.qrbill.examples;

import net.codecrete.qrbill.generator.Address;
import net.codecrete.qrbill.generator.Bill;
import net.codecrete.qrbill.generator.QRBill;
import net.codecrete.qrbill.generator.BillFormat;
import net.codecrete.qrbill.generator.GraphicsFormat;
import net.codecrete.qrbill.generator.OutputSize;
import net.codecrete.qrbill.generator.Language;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

public class QRBillExample {

    public static void main(String[] args) {

        // Setup bill
        Bill bill = new Bill();
        bill.setAccount("CH4431999123000889012");
        bill.setAmountFromDouble(199.95);
        bill.setCurrency("CHF");

        // Set creditor
        Address creditor = new Address();
        creditor.setName("Robert Schneider AG");
        creditor.setStreet("Rue du Lac");
        creditor.setHouseNo("1268/2/22");
        creditor.setPostalCode("2501");
        creditor.setTown("Biel");
        creditor.setCountryCode("CH");
        bill.setCreditor(creditor);

        // more bill data
        bill.setReference("210000000003139471430009017");
        bill.setUnstructuredMessage("Abonnement für 2020");

        // Set debtor
        Address debtor = new Address();
        debtor.setName("Pia-Maria Rutschmann-Schnyder");
        debtor.setStreet("Grosse Marktgasse");
        debtor.setHouseNo("28");
        debtor.setPostalCode("9400");
        debtor.setTown("Rorschach");
        debtor.setCountryCode("CH");
        bill.setDebtor(debtor);

        // Set output format
        BillFormat format = new BillFormat();
        format.setGraphicsFormat(GraphicsFormat.SVG);
        format.setOutputSize(OutputSize.QR_BILL_ONLY);
        format.setLanguage(Language.DE);
        bill.setFormat(format);

        // Generate QR bill
        byte[] svg = QRBill.generate(bill);

        // Save QR bill
        Path path = Paths.get("qrbill.svg");
        try {
            Files.write(path, svg);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }

        System.out.println("QR bill saved at " + path.toAbsolutePath());
    }
}

To integrate Swiss QR bills into Jasper Reports efficiently, use the QrBillRenderer class instead of importing external SVG files. Using QrBillRenderer significantly reduces PDF file size (approximately 12KB per slip compared to 100KB when using SVGs) because it avoids the overhead of converting text into complex vector shapes.

You can instantiate the renderer in two ways:

1. Direct Integration: Use the QrBillRenderer(Bill) constructor to create an instance and pass it directly into your Jasper report data source.
2. Data Source Wrapping: Use QrBillImageDataSource. This class wraps an existing data source and automatically adds a QrBillImage column. It retrieves necessary data (creditor, debtor, amount, etc.) from the wrapped data source using configurable field names.

// Option 1: Direct constructor
new QrBillRenderer(billInstance);

// Option 2: Using the wrapper
new QrBillImageDataSource(existingDataSource);

The Validator class provides a static method to validate a Bill object against official Swiss QR bill standards. This process performs two main functions:

1. Validation: It checks for errors (e.g., invalid IBAN, incorrect currency, out-of-range amounts, or missing mandatory fields) and warnings (e.g., values that were clipped or contained unsupported characters).
2. Cleaning: It produces a "cleaned" version of the bill (billOut) where whitespace is removed, text is normalized (e.g., uppercase currency), and values are clipped to meet length constraints.

To use it, pass a Bill instance to Validator.validate(bill). The returned ValidationResult contains both the list of validation messages and the new, cleaned Bill object.

// Assuming 'bill' is an existing Bill instance
ValidationResult result = Validator.validate(bill);

if (!result.getMessages().isEmpty()) {
    // Handle errors or warnings
    result.getMessages().forEach(msg -> {
        System.out.println(msg.getType() + ": " + msg.getMessage());
    });
}

// Use the cleaned bill for generation
Bill cleanedBill = result.getCleanedBill();