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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
import re
from stdnum import get_cc_module, ean
from odoo import _, api, fields, models
from odoo.exceptions import ValidationError
from odoo.addons.account.models.company import PEPPOL_LIST
try:
import phonenumbers
except ImportError:
phonenumbers = None
def _cc_checker(country_code, code_type):
return lambda endpoint: get_cc_module(country_code, code_type).is_valid(endpoint)
def _re_sanitizer(expression):
return lambda endpoint: (res.group(0) if (res := re.search(expression, endpoint)) else endpoint)
PEPPOL_ENDPOINT_RULES = {
'0007': _cc_checker('se', 'orgnr'),
'0088': ean.is_valid,
'0184': _cc_checker('dk', 'cvr'),
'0192': _cc_checker('no', 'orgnr'),
'0208': _cc_checker('be', 'vat'),
}
PEPPOL_ENDPOINT_WARNINGS = {
'0151': _cc_checker('au', 'abn'),
'0201': lambda endpoint: bool(re.match('[0-9a-zA-Z]{6}$', endpoint)),
'0210': _cc_checker('it', 'codicefiscale'),
'0211': _cc_checker('it', 'iva'),
'9906': _cc_checker('it', 'iva'),
'9907': _cc_checker('it', 'codicefiscale'),
}
PEPPOL_ENDPOINT_SANITIZERS = {
'0007': _re_sanitizer(r'\d{10}'),
'0184': _re_sanitizer(r'\d{8}'),
'0192': _re_sanitizer(r'\d{9}'),
'0208': _re_sanitizer(r'\d{10}'),
}
class ResCompany(models.Model):
_inherit = 'res.company'
account_peppol_contact_email = fields.Char(
string='Primary contact email',
compute='_compute_account_peppol_contact_email', store=True, readonly=False,
help='Primary contact email for Peppol-related communication',
)
account_peppol_migration_key = fields.Char(string="Migration Key")
account_peppol_phone_number = fields.Char(
string='Mobile number',
compute='_compute_account_peppol_phone_number', store=True, readonly=False,
help='You will receive a verification code to this mobile number',
)
account_peppol_proxy_state = fields.Selection(
selection=[
('not_registered', 'Not registered'),
('in_verification', 'In verification'),
('sender', 'Can send but not receive'),
('smp_registration', 'Can send, pending registration to receive'),
('receiver', 'Can send and receive'),
('rejected', 'Rejected'),
],
string='PEPPOL status', required=True, default='not_registered',
)
peppol_eas = fields.Selection(related='partner_id.peppol_eas', readonly=False)
peppol_endpoint = fields.Char(related='partner_id.peppol_endpoint', readonly=False)
peppol_purchase_journal_id = fields.Many2one(
comodel_name='account.journal',
string='PEPPOL Purchase Journal',
domain=[('type', '=', 'purchase')],
compute='_compute_peppol_purchase_journal_id', store=True, readonly=False,
inverse='_inverse_peppol_purchase_journal_id',
)
# -------------------------------------------------------------------------
# HELPER METHODS
# -------------------------------------------------------------------------
def _sanitize_peppol_phone_number(self, phone_number=None):
self.ensure_one()
error_message = _(
"Please enter the mobile number in the correct international format.\n"
"For example: +32123456789, where +32 is the country code.\n"
"Currently, only European countries are supported.")
if not phonenumbers:
raise ValidationError(_("Please install the phonenumbers library."))
phone_number = phone_number or self.account_peppol_phone_number
if not phone_number:
return
if not phone_number.startswith('+'):
phone_number = f'+{phone_number}'
try:
phone_nbr = phonenumbers.parse(phone_number)
except phonenumbers.phonenumberutil.NumberParseException:
raise ValidationError(error_message)
country_code = phonenumbers.phonenumberutil.region_code_for_number(phone_nbr)
if country_code not in PEPPOL_LIST or not phonenumbers.is_valid_number(phone_nbr):
raise ValidationError(error_message)
def _check_peppol_endpoint_number(self, warning=False):
self.ensure_one()
peppol_dict = PEPPOL_ENDPOINT_WARNINGS if warning else PEPPOL_ENDPOINT_RULES
return True if (endpoint_rule := peppol_dict.get(self.peppol_eas)) is None else endpoint_rule(self.peppol_endpoint)
# -------------------------------------------------------------------------
# CONSTRAINTS
# -------------------------------------------------------------------------
@api.constrains('account_peppol_phone_number')
def _check_account_peppol_phone_number(self):
for company in self:
if company.account_peppol_phone_number:
company._sanitize_peppol_phone_number()
@api.constrains('peppol_endpoint')
def _check_peppol_endpoint(self):
for company in self:
if not company.peppol_endpoint:
continue
if not company._check_peppol_endpoint_number(PEPPOL_ENDPOINT_RULES):
raise ValidationError(_("The Peppol endpoint identification number is not correct."))
@api.constrains('peppol_purchase_journal_id')
def _check_peppol_purchase_journal_id(self):
for company in self:
if company.peppol_purchase_journal_id and company.peppol_purchase_journal_id.type != 'purchase':
raise ValidationError(_("A purchase journal must be used to receive Peppol documents."))
# -------------------------------------------------------------------------
# COMPUTE METHODS
# -------------------------------------------------------------------------
@api.depends('account_peppol_proxy_state')
def _compute_peppol_purchase_journal_id(self):
for company in self:
if not company.peppol_purchase_journal_id and company.account_peppol_proxy_state not in ('not_registered', 'rejected'):
company.peppol_purchase_journal_id = self.env['account.journal'].search([
*self.env['account.journal']._check_company_domain(company),
('type', '=', 'purchase'),
], limit=1)
company.peppol_purchase_journal_id.is_peppol_journal = True
else:
company.peppol_purchase_journal_id = company.peppol_purchase_journal_id
def _inverse_peppol_purchase_journal_id(self):
for company in self:
# This avoid having 2 or more journals from the same company with
# `is_peppol_journal` set to True (which could occur after changes).
journals_to_reset = self.env['account.journal'].search([
('company_id', '=', company.id),
('is_peppol_journal', '=', True),
])
journals_to_reset.is_peppol_journal = False
company.peppol_purchase_journal_id.is_peppol_journal = True
@api.depends('email')
def _compute_account_peppol_contact_email(self):
for company in self:
if not company.account_peppol_contact_email:
company.account_peppol_contact_email = company.email
@api.depends('phone')
def _compute_account_peppol_phone_number(self):
for company in self:
if not company.account_peppol_phone_number:
try:
# precompute only if it's a valid phone number
company._sanitize_peppol_phone_number(company.phone)
company.account_peppol_phone_number = company.phone
except ValidationError:
continue
# -------------------------------------------------------------------------
# LOW-LEVEL METHODS
# -------------------------------------------------------------------------
@api.model
def _sanitize_peppol_endpoint(self, vals, eas=False, endpoint=False):
if not (peppol_eas := vals.get('peppol_eas', eas)) or not (peppol_endpoint := vals.get('peppol_endpoint', endpoint)):
return vals
if sanitizer := PEPPOL_ENDPOINT_SANITIZERS.get(peppol_eas):
vals['peppol_endpoint'] = sanitizer(peppol_endpoint)
return vals
@api.model_create_multi
def create(self, vals_list):
for vals in vals_list:
vals = self._sanitize_peppol_endpoint(vals)
res = super().create(vals_list)
if res:
for company in res:
self.env['ir.default'].sudo().set(
'res.partner',
'peppol_verification_state',
'not_verified',
company_id=company.id,
)
return res
def write(self, vals):
for company in self:
vals = self._sanitize_peppol_endpoint(vals, company.peppol_eas, company.peppol_endpoint)
return super().write(vals)
# -------------------------------------------------------------------------
# PEPPOL PARTICIPANT MANAGEMENT
# -------------------------------------------------------------------------
def _peppol_modules_document_types(self):
"""Override this function to add supported document types as modules are installed.
:returns: dictionary of the form: {module_name: [(document identifier, document_name)]}
"""
return {
'default': {
"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1":
"Peppol BIS Billing UBL Invoice V3",
"urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1":
"Peppol BIS Billing UBL CreditNote V3",
"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:nen.nl:nlcius:v1.0::2.1":
"SI-UBL 2.0 Invoice",
"urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:fdc:nen.nl:nlcius:v1.0::2.1":
"SI-UBL 2.0 CreditNote",
"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#conformant#urn:fdc:peppol.eu:2017:poacc:billing:international:sg:3.0::2.1":
"SG Peppol BIS Billing 3.0 Invoice",
"urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#conformant#urn:fdc:peppol.eu:2017:poacc:billing:international:sg:3.0::2.1":
"SG Peppol BIS Billing 3.0 Credit Note",
"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0::2.1":
"XRechnung UBL Invoice V2.0",
"urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0::2.1":
"XRechnung UBL CreditNote V2.0",
"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#conformant#urn:fdc:peppol.eu:2017:poacc:billing:international:aunz:3.0::2.1":
"AU-NZ Peppol BIS Billing 3.0 Invoice",
"urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2::CreditNote##urn:cen.eu:en16931:2017#conformant#urn:fdc:peppol.eu:2017:poacc:billing:international:aunz:3.0::2.1":
"AU-NZ Peppol BIS Billing 3.0 CreditNote",
}
}
def _peppol_supported_document_types(self):
"""Returns a flattened dictionary of all supported document types."""
return {
identifier: document_name
for module, identifiers in self._peppol_modules_document_types().items()
for identifier, document_name in identifiers.items()
}
|
