addons/base_vat/base_vat.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2011 OpenERP SA (<http://openerp.com>)
   6 #
   7 #    This program is free software: you can redistribute it and/or modify
   8 #    it under the terms of the GNU General Public License as published by
   9 #    the Free Software Foundation, either version 3 of the License, or
  10 #    (at your option) any later version.
  11 #
  12 #    This program is distributed in the hope that it will be useful,
  13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 #    GNU General Public License for more details.
  16 #
  17 #    You should have received a copy of the GNU General Public License
  18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 #
  20 ##############################################################################
  21
  22 import logging
  23 import string
  24 import datetime
  25 import re
  26
  27 try:
  28     import vatnumber
  29 except ImportError:
  30     logging.getLogger('base_vat').warning("VAT validation partially unavailable because the `vatnumber` Python library cannot be found. "
  31                                           "Install it to support more countries, for example with `easy_install vatnumber`.")
  32     vatnumber = None
  33
  34 from osv import osv, fields
  35 from tools.misc import ustr
  36 from tools.translate import _
  37
  38 _ref_vat = {
  39     'be': 'BE0477472701', 'at': 'ATU12345675',
  40     'bg': 'BG1234567892', 'cy': 'CY12345678F',
  41     'cz': 'CZ12345679', 'de': 'DE123456788',
  42     'dk': 'DK12345674', 'ee': 'EE123456780',
  43     'es': 'ESA12345674', 'fi': 'FI12345671',
  44     'fr': 'FR32123456789', 'gb': 'GB123456782',
  45     'gr': 'GR12345670', 'hu': 'HU12345676',
  46     'ie': 'IE1234567T', 'it': 'IT12345670017',
  47     'lt': 'LT123456715', 'lu': 'LU12345613',
  48     'lv': 'LV41234567891', 'mt': 'MT12345634',
  49     'nl': 'NL123456782B90', 'pl': 'PL1234567883',
  50     'pt': 'PT123456789', 'ro': 'RO1234567897',
  51     'se': 'SE123456789701', 'si': 'SI12345679',
  52     'sk': 'SK0012345675', 'el': 'EL12345670',
  53     'mx': 'MXABC123456T1B', 'no': 'NO123456785',
  54     'hr': 'HR01234567896', # Croatia, contributed by Milan Tribuson
  55 }
  56
  57 class res_partner(osv.osv):
  58     _inherit = 'res.partner'
  59
  60     def _split_vat(self, vat):
  61         vat_country, vat_number = vat[:2].lower(), vat[2:].replace(' ', '')
  62         return vat_country, vat_number
  63
  64     def simple_vat_check(self, cr, uid, country_code, vat_number, context=None):
  65         '''
  66         Check the VAT number depending of the country.
  67         http://sima-pc.com/nif.php
  68         '''
  69         check_func_name = 'check_vat_' + country_code
  70         check_func = getattr(self, check_func_name, None) or \
  71                         getattr(vatnumber, check_func_name, None)
  72         if not check_func:
  73             # No VAT validation available, default to check that the country code exists
  74             res_country = self.pool.get('res.country')
  75             return bool(res_country.search(cr, uid, [('code', '=ilike', country_code)], context=context))
  76         return check_func(vat_number)
  77
  78     def vies_vat_check(self, cr, uid, country_code, vat_number, context=None):
  79         try:
  80             # Validate against  VAT Information Exchange System (VIES)
  81             # see also http://ec.europa.eu/taxation_customs/vies/
  82             return vatnumber.check_vies(country_code.upper()+vat_number)
  83         except Exception:
  84             # see http://ec.europa.eu/taxation_customs/vies/checkVatService.wsdl
  85             # Fault code may contain INVALID_INPUT, SERVICE_UNAVAILABLE, MS_UNAVAILABLE,
  86             # TIMEOUT or SERVER_BUSY. There is no way we can validate the input
  87             # with VIES if any of these arise, including the first one (it means invalid
  88             # country code or empty VAT number), so we fall back to the simple check.
  89             return self.simple_vat_check(cr, uid, country_code, vat_number, context=context)
  90
  91     def check_vat(self, cr, uid, ids, context=None):
  92         user_company = self.pool.get('res.users').browse(cr, uid, uid).company_id
  93         if user_company.vat_check_vies:
  94             # force full VIES online check
  95             check_func = self.vies_vat_check
  96         else:
  97             # quick and partial off-line checksum validation
  98             check_func = self.simple_vat_check
  99
 100         for partner in self.browse(cr, uid, ids, context=context):
 101             if not partner.vat:
 102                 continue
 103             vat_country, vat_number = self._split_vat(partner.vat)
 104             if not check_func(cr, uid, vat_country, vat_number, context=context):
 105                 return False
 106         return True
 107
 108     def vat_change(self, cr, uid, ids, value, context=None):
 109         return {'value': {'vat_subjected': bool(value)}}
 110
 111     _columns = {
 112         'vat_subjected': fields.boolean('VAT Legal Statement', help="Check this box if the partner is subjected to the VAT. It will be used for the VAT legal statement.")
 113     }
 114
 115     def _construct_constraint_msg(self, cr, uid, ids, context=None):
 116         def default_vat_check(cn, vn):
 117             # by default, a VAT number is valid if:
 118             #  it starts with 2 letters
 119             #  has more than 3 characters
 120             return cn[0] in string.ascii_lowercase and cn[1] in string.ascii_lowercase
 121         vat_country, vat_number = self._split_vat(self.browse(cr, uid, ids)[0].vat)
 122         vat_no = "'CC##' (CC=Country Code, ##=VAT Number)"
 123         if default_vat_check(vat_country, vat_number):
 124             vat_no = _ref_vat[vat_country] if vat_country in _ref_vat else vat_no
 125         return '\n' + _('This VAT number does not seem to be valid.\nNote: the expected format is %s') % vat_no
 126
 127     _constraints = [(check_vat, _construct_constraint_msg, ["vat"])]
 128
 129
 130     # Mexican VAT verification, contributed by <moylop260@hotmail.com>
 131     # and Panos Christeas <p_christ@hol.gr>
 132     __check_vat_mx_re = re.compile(r"(?P<primeras>[A-Za-z\xd1\xf1&]{3,4})" \
 133                                     r"[ \-_]?" \
 134                                     r"(?P<ano>[0-9]{2})(?P<mes>[01][0-9])(?P<dia>[0-3][0-9])" \
 135                                     r"[ \-_]?" \
 136                                     r"(?P<code>[A-Za-z0-9&\xd1\xf1]{3})$")
 137     def check_vat_mx(self, vat):
 138         ''' Mexican VAT verification
 139
 140         Verificar RFC México
 141         '''
 142         # we convert to 8-bit encoding, to help the regex parse only bytes
 143         vat = ustr(vat).encode('iso8859-1')
 144         m = self.__check_vat_mx_re.match(vat)
 145         if not m:
 146             #No valid format
 147             return False
 148         try:
 149             ano = int(m.group('ano'))
 150             if ano > 30:
 151                 ano = 1900 + ano
 152             else:
 153                 ano = 2000 + ano
 154             datetime.date(ano, int(m.group('mes')), int(m.group('dia')))
 155         except ValueError:
 156             return False
 157
 158         #Valid format and valid date
 159         return True
 160
 161
 162     # Norway VAT validation, contributed by Rolv Råen (adEgo) <rora@adego.no>
 163     def check_vat_no(self, vat):
 164         '''
 165         Check Norway VAT number.See http://www.brreg.no/english/coordination/number.html
 166         '''
 167         if len(vat) != 9:
 168             return False
 169         try:
 170             int(vat)
 171         except ValueError:
 172             return False
 173
 174         sum = (3 * int(vat[0])) + (2 * int(vat[1])) + \
 175             (7 * int(vat[2])) + (6 * int(vat[3])) + \
 176             (5 * int(vat[4])) + (4 * int(vat[5])) + \
 177             (3 * int(vat[6])) + (2 * int(vat[7]))
 178
 179         check = 11 -(sum % 11)
 180         if check == 11:
 181             check = 0
 182         if check == 10:
 183             # 10 is not a valid check digit for an organization number
 184             return False
 185         return check == int(vat[8])
 186
 187 res_partner()
 188
 189 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: