Codecrete.SwissQRBill.Generator 3.3.0

dotnet add package Codecrete.SwissQRBill.Generator --version 3.3.0                
NuGet\Install-Package Codecrete.SwissQRBill.Generator -Version 3.3.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Codecrete.SwissQRBill.Generator" Version="3.3.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Codecrete.SwissQRBill.Generator --version 3.3.0                
#r "nuget: Codecrete.SwissQRBill.Generator, 3.3.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Codecrete.SwissQRBill.Generator as a Cake Addin
#addin nuget:?package=Codecrete.SwissQRBill.Generator&version=3.3.0

// Install Codecrete.SwissQRBill.Generator as a Cake Tool
#tool nuget:?package=Codecrete.SwissQRBill.Generator&version=3.3.0                

Swiss QR Bill for .NET

Open-source .NET library to generate Swiss QR bills. Try it yourself and create a QR bill.

Introduction

The Swiss QR bill is the QR code based payment format that started on 30 June, 2020. The payment slip is sent electronically or presented online in most cases. It can still be printed at the bottom of an invoice or added to the invoice on a separate sheet. The payer scans the QR code with his/her mobile banking app to initiate the payment and then just needs to confirm it.

If the invoicing party adds structured bill information (VAT rates, payment conditions etc.) to the QR bill, the payer can automate the booking in accounts payable. The invoicing party can also automate the accounts receivable processing as the payment includes all relevant data including a reference number. The Swiss QR bill is convenient for the payer and payee.

QR Bill

More examples can be found in the Wiki

Features

The Swiss QR bill library:

  • generates QR bills as PDF, SVG and PNG files (see home page for Windows-specific EMF)
  • generates payment slips (210mm by 105mm), payment part (148mm by 105mm), A4 sheets or QR code only
  • is multilingual: German, French, Italian, English, Romansh
  • validates the invoice data and provides detailed validation information
  • adds or retrieves structured bill information (according to Swico S1)
  • parses the invoice data embedded in the QR code
  • is easy to use (see example below)
  • is small and fast
  • is free – even for commercial use (MIT License)
  • is built for .NET Standard 2.0, i.e. it runs with .NET Core 2.0 or higher, .NET Framework 4.6.1 or higher, Mono 5.4 or higher, Universal Windows Platform 10.0.16299 or higher, Xamarin etc.
  • this library version uses SkiaSharp for platform-independent PNG file generation
  • see home page for more examples and other library versions including EMF generation

Getting started

  1. Create a new Visual Studio project for .NET Core 3.x (File > New > Project... / Visual C# > .NET Core > Console App (.NET Core))

  2. Add the library via NuGet:

    Either via Project > Manage NuGet Packages... / Browse / search for qrbill / Install

    Or by running a command in the Package Manager Console

Install-Package Codecrete.SwissQRBill.Generator -Version 3.3.0
  1. Add the code:
using Codecrete.SwissQRBill.Generator;
using System;
using System.IO;

namespace Codecrete.SwissQRBill.Examples.Basic
{
    class Program
    {
        static void Main(string[] args)
        {
            // Setup bill data
            Bill bill = new Bill
            {
                // creditor data
                Account = "CH4431999123000889012",
                Creditor = new Address
                {
                    Name = "Robert Schneider AG",
                    Street = "Rue du Lac",
                    HouseNo = "1268/2/22",
                    PostalCode = "2501",
                    Town = "Biel",
                    CountryCode = "CH"
                },

                // payment data
                Amount = 199.95m,
                Currency = "CHF",
                
                // debtor data
                Debtor = new Address
                {
                    Name = "Pia-Maria Rutschmann-Schnyder",
                    Street = "Grosse Marktgasse",
                    HouseNo = "28",
                    PostalCode = "9400",
                    Town = "Rorschach",
                    CountryCode = "CH"
                },

                // more payment data
                Reference = "210000000003139471430009017",
                UnstructuredMessage = "Abonnement für 2020",

                // output format
                Format = new BillFormat
                {
                    Language = Language.DE,
                    GraphicsFormat = GraphicsFormat.SVG,
                    OutputSize = OutputSize.QrBillOnly
                }
            };

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

            // Save generated SVG file
            const string path = "qrbill.svg";
            File.WriteAllBytes(path, svg);
            Console.WriteLine($"QR bill saved at { Path.GetFullPath(path) }");
        }
    }
}
  1. Run it

API documention

See DocFX API Documentation

Further topics

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Codecrete.SwissQRBill.Generator:

Package Downloads
LEC.Services.SwissQRBill

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.3.0 25,745 6/1/2024
3.1.1 52,391 8/31/2023
3.1.0 2,793 7/16/2023
3.0.6 70,350 10/12/2022
3.0.5 74,018 7/5/2022
3.0.4 9,529 6/11/2022
3.0.3 25,011 3/12/2022
3.0.2 1,575 2/25/2022
3.0.1 29,810 12/30/2021
3.0.0 1,832 12/28/2021
2.5.3 38,374 7/16/2021
2.5.2 16,684 4/26/2021
2.5.0 15,445 10/19/2020
2.4.3 3,234 7/21/2020
2.4.2 1,346 7/16/2020
2.4.1 1,312 7/15/2020
2.4.0 1,490 7/5/2020
2.3.5 89,510 6/25/2020
2.3.4 11,202 6/20/2020
2.3.3 1,718 6/13/2020
2.3.2 1,270 6/11/2020
2.3.1 5,353 5/26/2020
2.3.0 1,358 5/16/2020
2.2.4 1,298 5/13/2020
2.2.3 1,304 5/4/2020
2.2.2 2,137 3/9/2020
2.2.1 1,310 3/5/2020
2.2.0 4,881 2/22/2020
2.1.1 1,642 1/19/2020
2.1.0 1,648 1/12/2020
2.0.0 1,550 2/20/2019
0.9.4 1,480 1/27/2019
0.9.3 1,562 1/17/2019
0.9.2 1,465 1/6/2019
0.9.1 1,497 1/4/2019
0.9.0 1,578 1/4/2019

New in release 3.3:
- Ready for QR bill specification 2.3 (extended Latin character set, deprecated address type)
- New output size for online channels