1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
|
# ogm_vcs.py - functions for handling Belgian OGM-VCS
# coding: utf-8
#
# Copyright (C) 2025 Cédric Krier
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA
"""Belgian OGM-VCS.
The OGM-VCS is used in bank transfer as structured communication.
* https://febelfin.be/en/publications/2023/febelfin-banking-standards-for-online-banking
>>> validate('+++010/8068/17183+++')
'010806817183'
>>> validate('010/8068/17180')
Traceback (most recent call last):
...
InvalidChecksum: ...
>>> format('010806817183')
'010/8068/17183'
>>> calc_check_digits('0108068171')
'83'
"""
from __future__ import annotations
from stdnum.exceptions import *
from stdnum.util import clean, isdigits
def compact(number: str) -> str:
"""Convert the number to the minimal representation. This strips the number
of any invalid separators and removes surrounding whitespace."""
return clean(number, ' +/').strip()
def calc_check_digits(number: str) -> str:
"""Calculate the check digit that should be added."""
number = compact(number)
return '%02d' % ((int(number[:10]) % 97) or 97)
def validate(number: str) -> str:
"""Check if the number is a valid OGM-VCS."""
number = compact(number)
if not isdigits(number) or int(number) <= 0:
raise InvalidFormat()
if len(number) != 12:
raise InvalidLength()
if calc_check_digits(number) != number[-2:]:
raise InvalidChecksum()
return number
def is_valid(number: str) -> bool:
"""Check if the number is a valid VAT number."""
try:
return bool(validate(number))
except ValidationError:
return False
def format(number: str) -> str:
"""Format the number provided for output."""
number = compact(number)
number = number.rjust(12, '0')
return f'{number[:3]}/{number[3:7]}/{number[7:]}'
|