1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2012 OpenERP SA (<http://openerp.com>)
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.
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.
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/>.
20 ##############################################################################
26 _logger = logging.getLogger(__name__)
31 _logger.warning("VAT validation partially unavailable because the `vatnumber` Python library cannot be found. "
32 "Install it to support more countries, for example with `easy_install vatnumber`.")
35 from openerp.osv import fields, osv
36 from openerp.tools.misc import ustr
37 from openerp.tools.translate import _
43 'ch': 'CHE-123.456.788 TVA or CH TVA 123456', #Swiss by Yannick Vaucher @ Camptocamp
52 'fr': 'FR32123456789',
56 'hr': 'HR01234567896', # Croatia, contributed by Milan Tribuson
58 'it': 'IT12345670017',
61 'lv': 'LV41234567891',
63 'mx': 'MXABC123456T1B',
64 'nl': 'NL123456782B90',
69 'se': 'SE123456789701',
74 class res_partner(osv.osv):
75 _inherit = 'res.partner'
77 def _split_vat(self, vat):
78 vat_country, vat_number = vat[:2].lower(), vat[2:].replace(' ', '')
79 return vat_country, vat_number
81 def simple_vat_check(self, cr, uid, country_code, vat_number, context=None):
83 Check the VAT number depending of the country.
84 http://sima-pc.com/nif.php
86 if not ustr(country_code).encode('utf-8').isalpha():
88 check_func_name = 'check_vat_' + country_code
89 check_func = getattr(self, check_func_name, None) or \
90 getattr(vatnumber, check_func_name, None)
92 # No VAT validation available, default to check that the country code exists
93 res_country = self.pool.get('res.country')
94 return bool(res_country.search(cr, uid, [('code', '=ilike', country_code)], context=context))
95 return check_func(vat_number)
97 def vies_vat_check(self, cr, uid, country_code, vat_number, context=None):
99 # Validate against VAT Information Exchange System (VIES)
100 # see also http://ec.europa.eu/taxation_customs/vies/
101 return vatnumber.check_vies(country_code.upper()+vat_number)
103 # see http://ec.europa.eu/taxation_customs/vies/checkVatService.wsdl
104 # Fault code may contain INVALID_INPUT, SERVICE_UNAVAILABLE, MS_UNAVAILABLE,
105 # TIMEOUT or SERVER_BUSY. There is no way we can validate the input
106 # with VIES if any of these arise, including the first one (it means invalid
107 # country code or empty VAT number), so we fall back to the simple check.
108 return self.simple_vat_check(cr, uid, country_code, vat_number, context=context)
110 def button_check_vat(self, cr, uid, ids, context=None):
111 if not self.check_vat(cr, uid, ids, context=context):
112 msg = self._construct_constraint_msg(cr, uid, ids, context=context)
113 raise osv.except_osv(_('Error!'), msg)
116 def check_vat(self, cr, uid, ids, context=None):
117 user_company = self.pool.get('res.users').browse(cr, uid, uid).company_id
118 if user_company.vat_check_vies:
119 # force full VIES online check
120 check_func = self.vies_vat_check
122 # quick and partial off-line checksum validation
123 check_func = self.simple_vat_check
124 for partner in self.browse(cr, uid, ids, context=context):
127 vat_country, vat_number = self._split_vat(partner.vat)
128 if not check_func(cr, uid, vat_country, vat_number, context=context):
132 def vat_change(self, cr, uid, ids, value, context=None):
133 return {'value': {'vat_subjected': bool(value)}}
136 '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.")
139 def _commercial_fields(self, cr, uid, context=None):
140 return super(res_partner, self)._commercial_fields(cr, uid, context=context) + ['vat_subjected']
142 def _construct_constraint_msg(self, cr, uid, ids, context=None):
143 def default_vat_check(cn, vn):
144 # by default, a VAT number is valid if:
145 # it starts with 2 letters
146 # has more than 3 characters
147 return cn[0] in string.ascii_lowercase and cn[1] in string.ascii_lowercase
148 vat_country, vat_number = self._split_vat(self.browse(cr, uid, ids)[0].vat)
149 vat_no = "'CC##' (CC=Country Code, ##=VAT Number)"
150 if default_vat_check(vat_country, vat_number):
151 vat_no = _ref_vat[vat_country] if vat_country in _ref_vat else vat_no
152 return '\n' + _('This VAT number does not seem to be valid.\nNote: the expected format is %s') % vat_no
154 _constraints = [(check_vat, _construct_constraint_msg, ["vat"])]
157 __check_vat_ch_re1 = re.compile(r'(MWST|TVA|IVA)[0-9]{6}$')
158 __check_vat_ch_re2 = re.compile(r'E([0-9]{9}|-[0-9]{3}\.[0-9]{3}\.[0-9]{3})(MWST|TVA|IVA)$')
160 def check_vat_ch(self, vat):
162 Check Switzerland VAT number.
164 # VAT number in Switzerland will change between 2011 and 2013
165 # http://www.estv.admin.ch/mwst/themen/00154/00589/01107/index.html?lang=fr
166 # Old format is "TVA 123456" we will admit the user has to enter ch before the number
167 # Format will becomes such as "CHE-999.999.99C TVA"
168 # Both old and new format will be accepted till end of 2013
169 # Accepted format are: (spaces are ignored)
177 # CHE-###.###.### MWST
178 # CHE-###.###.### TVA
179 # CHE-###.###.### IVA
181 if self.__check_vat_ch_re1.match(vat):
183 match = self.__check_vat_ch_re2.match(vat)
185 # For new TVA numbers, do a mod11 check
186 num = filter(lambda s: s.isdigit(), match.group(1)) # get the digits only
187 factor = (5,4,3,2,7,6,5,4)
188 csum = sum([int(num[i]) * factor[i] for i in range(8)])
189 check = (11 - (csum % 11)) % 11
190 return check == int(num[8])
193 def _ie_check_char(self, vat):
196 if vat[7] not in ' W':
198 extra = 9 * (ord(vat[7]) - 64)
202 checksum = extra + sum((8-i) * int(x) for i, x in enumerate(vat[:7]))
203 return 'WABCDEFGHIJKLMNOPQRSTUV'[checksum % 23]
205 def check_vat_ie(self, vat):
206 """ Temporary Ireland VAT validation to support the new format
207 introduced in January 2013 in Ireland, until upstream is fixed.
208 TODO: remove when fixed upstream"""
209 if len(vat) not in (8, 9) or not vat[2:7].isdigit():
212 # Normalize pre-2013 numbers: final space or 'W' not significant
214 if vat[:7].isdigit():
215 return vat[7] == self._ie_check_char(vat[:7] + vat[8])
216 elif vat[1] in (string.ascii_uppercase + '+*'):
218 # See http://www.revenue.ie/en/online/third-party-reporting/reporting-payment-details/faqs.html#section3
219 return vat[7] == self._ie_check_char(vat[2:7] + vat[0] + vat[8])
222 # Mexican VAT verification, contributed by <moylop260@hotmail.com>
223 # and Panos Christeas <p_christ@hol.gr>
224 __check_vat_mx_re = re.compile(r"(?P<primeras>[A-Za-z\xd1\xf1&]{3,4})" \
226 r"(?P<ano>[0-9]{2})(?P<mes>[01][0-9])(?P<dia>[0-3][0-9])" \
228 r"(?P<code>[A-Za-z0-9&\xd1\xf1]{3})$")
229 def check_vat_mx(self, vat):
230 ''' Mexican VAT verification
234 # we convert to 8-bit encoding, to help the regex parse only bytes
235 vat = ustr(vat).encode('iso8859-1')
236 m = self.__check_vat_mx_re.match(vat)
241 ano = int(m.group('ano'))
246 datetime.date(ano, int(m.group('mes')), int(m.group('dia')))
250 #Valid format and valid date
254 # Norway VAT validation, contributed by Rolv Råen (adEgo) <rora@adego.no>
255 def check_vat_no(self, vat):
257 Check Norway VAT number.See http://www.brreg.no/english/coordination/number.html
266 sum = (3 * int(vat[0])) + (2 * int(vat[1])) + \
267 (7 * int(vat[2])) + (6 * int(vat[3])) + \
268 (5 * int(vat[4])) + (4 * int(vat[5])) + \
269 (3 * int(vat[6])) + (2 * int(vat[7]))
271 check = 11 -(sum % 11)
275 # 10 is not a valid check digit for an organization number
277 return check == int(vat[8])
280 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: