finnish-reference-number v1.1.0

finnish-reference-number

Library to generate and validate Finnish invoice reference numbers (Specifications).

Installation

npm install finnish-reference-number --save

Usage

Generating Finnish invoice reference numbers

Reference numbers can be generated from given identifier (example customer number or invoice number)

Identifier characteristics:

• Contain only numbers 0-9.
• Min length 3 numbers.

• Max length 19 numbers.

  One reference number

  import { generate } from 'finnish-reference-number'

  console.log(generate('1234567890'))
  // => 12345678907

Reference number can be generated also without identifier. In that case epoch timestamp is used. Example of the result in the time of writing this.

  import { generate } from 'finnish-reference-number'

  console.log(generate())
  // => 15764351553058

Multiple reference numbers

  import { generate } from 'finnish-reference-number'

  console.log(generate(['12345', '12346']))
  // => ['123453', '123466']

Validating Finnish invoice reference numbers

Valid Finnish invoice reference number characteristics:

• Contain only numbers 0-9.
• Min length 4 numbers.
• Max length 20 numbers.

• Have valid checksum number as a last character.

  One reference number

  import { validate } from 'finnish-reference-number'

  console.log(validate('12345678907'))
  // => true

  import { validate } from 'finnish-reference-number'

  console.log(validate('12345678900'))
  // => false

Multiple reference numbers

  import { validate } from 'finnish-reference-number'

  console.log(validate(['123453', '123466']))
  // => [true, true]

  import { validate } from 'finnish-reference-number'

  console.log(validate(['123453', '123463']))
  // => [true, false]

Tests

npm run lint
npm test