esr-code-line
v1.0.2
Published
A code line generator for orange payment slips used in Switzerland
Downloads
303
Maintainers
Readme
Code Line Generator for Orange Payment Slips used in Switzerland
This package contains utility functions for generating the code line on the orange payment slips used in Switzerland. The code is shown on the bottom right of the slip inside the white area:
| Statements | Branches | Functions | Lines | | --------------------------- | ----------------------- | ------------------------- | -------------------- | | | | | |
Specification
The slip is known under these different names and abbreviations depending on the language:
- English: Orange inpayment slip with reference number (ISR)
- German: Oranger Einzahlungsschein mit Referenznummer (ESR)
- French: Bulletin de versement orange avec numéro de référence (BVR)
- Italian: Polizza di versamento arancione con numero di riferimento (PVR)
The technical specification is from chapter 5 of the Postfinance manual.
Please note that the QR-Bill replaces this standard (see paymentstandards.ch). Depending on the project it may be viable to skip ahead to this newer one.
Installation
npm install esr-code-line
Usage
The code line consists of information already on the payment slip, except for the slip type:
The parameters are:
-
slipType
a code defining the type of the slip. E.g. "01" for a ISR in CHF. See section 5.1 of the manual. -
amountFrancsOrEuros
the main currency unit in either CHF or EUR. -
amountRappenOrCents
the fractional currency unit in Rappen or Cents. -
referenceNumber
the reference number with or without spaces. -
customerNumber
the ISR customer number in CHF or EUR. Formatted VV-XXX-C. See section 5.1 of the manual.
const { codeLine } = require("esr-code-line");
const code = codeLine({
slipType: "01",
amountFrancsOrEuros: "3949",
amountRappenOrCents: "75",
referenceNumber: "12 00000 00000 23447 89432 16899",
customerNumber: "01-162-8",
}); // returns "0100003949753>120000000000234478943216899+ 010001628>"
The codeLine function does not add check digits to the reference or customer numbers. They can however be added using the attachCheckDigit
function included in the module.
const { attachCheckDigit } = require("esr-code-line");
attachCheckDigit("04"); // returns "042"