Merge lp:~therp-nl/new-report-intrastat/8.0-update-l10n_nl_intrastat into lp:new-report-intrastat

[Ronald Portier (Therp)]

Update dutch intrastat report to 8.0

One change to base module:

- In _check_generate_lines: check currency on company object directly.

Maybe the check on currency should be replaced by an another check altoghether.
Not all EU countries use the Euro as currency. For instance: UK.

Of course, for the moment we only have modules for France and the Netherlands, that do use the Euro.
But this might change.

[Alexis de Lattre (alexis-via)]

Thanks for this great work ! It's one step towards the transition to github/OCA

I think that, with the new API, you are not supposed to use
digits_compute=dp.get_precision('Account')

It should be :
digits=dp.get_precision('Account')

By the way, why not use

from openerp.exceptions import Warning

and then:
raise Warning(
_('Cannot generate reports lines in a non-draft state'))

I would also remove
from openerp.tools.translate import _

and update the line:
from openerp import api, models, fields, _

I would also expect @api.model decorators on the methods that set default values... but maybe it works without it ! :)

I'll merge this MP in the main branch and then I'll adapt my MP with the new API for intrastat_base + l10n_fr_*

[Ronald Portier (Therp) (rportier1962)]

@Alexis I made a refreshed proposal taking most of your remarks into account.

The default supplying methods indeed work withouth @api.model decorator. This decorator is also not in the example for a default method on the new api documentation.

=== modified file 'intrastat_base/intrastat_common.py'
--- intrastat_base/intrastat_common.py	2014-04-14 17:41:39 +0000
+++ intrastat_base/intrastat_common.py	2015-02-13 10:30:49 +0000
@@ -73,16 +73,26 @@
         return True
 
     def _check_generate_lines(self, cr, uid, intrastat, context=None):
-        if not intrastat.company_id.country_id:
+        """Check wether all requirements are met for generating lines."""
+        if not intrastat.company_id:
+            # Should not be possible, but just in case:
+            raise orm.except_orm(
+                _('Error :'),
+                _("Company not yet set on intrastat report.")
+            )
+        company_obj = intrastat.company_id  # Simplify references
+        if not company_obj.country_id:
             raise orm.except_orm(
                 _('Error :'),
                 _("The country is not set on the company '%s'.")
-                % intrastat.company_id.name)
-        if not intrastat.currency_id.name == 'EUR':
+                % company_obj.name
+            )
+        if not company_obj.currency_id.name == 'EUR':
             raise orm.except_orm(
                 _('Error :'),
                 _("The company currency must be 'EUR', but is currently '%s'.")
-                % intrastat.currency_id.name)
+                % company_obj.currency_id.name
+            )
         return True
 
     def _check_generate_xml(self, cr, uid, intrastat, context=None):

=== modified file 'l10n_nl_intrastat/model/l10n_nl_intrastat.py'
--- l10n_nl_intrastat/model/l10n_nl_intrastat.py	2013-07-21 14:00:37 +0000
+++ l10n_nl_intrastat/model/l10n_nl_intrastat.py	2015-02-13 10:30:49 +0000
@@ -1,12 +1,14 @@
 # -*- encoding: utf-8 -*-
+"""Define intrastat report (ICP) for dutch tax authorities."""
 ##############################################################################
 #
 #    OpenERP Report intrastat for NL
-#    Copyright (C) 2012 - 2013 Therp BV <http://therp.nl>
+#    Copyright (C) 2012 - 2015 Therp BV <http://therp.nl>
 #
 #    Based on and containing code snippets from lp:new-report-intrastat
 #    by Alexis de Lattre <[e-mail]>,
-#    Copyright (C) 2010-2011 Akretion (http://www.akretion.com). All Rights Reserved
+#    Copyright (C) 2010-2011 Akretion (http://www.akretion.com).
+#    All Rights Reserved
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU Affero General Public License as
@@ -22,189 +24,205 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 ##############################################################################
-
-from openerp.osv import orm, fields
+from openerp import api, models, fields, _
+from openerp.exceptions import Warning
 from datetime import datetime
 from dateutil.relativedelta import relativedelta
-from openerp.tools.translate import _
 from openerp.addons.decimal_precision import decimal_precision as dp
 
 
-class l10n_nl_report_intrastat(orm.Model):
+class ReportIntrastat(models.Model):
+    """Define intrastat report (ICP) for dutch tax authorities."""
     _name = "l10n_nl.report.intrastat"
     _description = "Declaration of intracommunautary transactions (ICP)"
     _order = "period_id desc"
     _rec_name = 'period_id'
 
-    _columns = {
-        'line_ids': fields.one2many(
-            'l10n_nl.report.intrastat.line',
-            'report_id',
-            'ICP line',
-            readonly=True),
-        'period_id': fields.many2one(
-            'account.period',
-            'Period',
-            states={'done': [('readonly', True)]}),
-        'company_id': fields.many2one(
-            'res.company', 'Company', required=True,
-            states={'done': [('readonly',True)]},
-            help="Related company."),
-        'total_amount': fields.float(
-            'Total amount',
-            digits_compute=dp.get_precision('Account'),
-            readonly=True,
-            help="Total amount in company currency of the declaration."),
-        'state' : fields.selection(
-            [
-                ('draft','Draft'),
-                ('done','Done'),
-                ], 'State', select=True, readonly=True,
-            help=("State of the declaration. When the state is set to 'Done', "
-                  "the parameters become read-only.")),
-        'date_done' : fields.date(
-            'Date done', readonly=True,
-            help=("Last date when the intrastat declaration was converted to "
-                  "'Done' state.")),
-        'notes' : fields.text(
-            'Notes',
-            help="You can add some comments here if you want."),
-        }
-
-    def get_period(self, cr, uid, context=None):
+    def _default_period_id(self):
         """
         By default, take the previous period relative to the
         current date. Courtesy of Alexis.
         """
+        period_model = self.env['account.period']
         date = datetime.strftime(
             datetime.today() + relativedelta(day=1, months=-1), '%Y-%m-%d')
-        period_ids = self.pool.get('account.period').find(
-            cr, uid, dt=date, context=context)
+        period_ids = period_model.find(dt=date)
         return period_ids and period_ids[0] or False
 
-    _defaults = {
-        'period_id': get_period,
-        'state': 'draft',
-        'company_id': lambda self, cr, uid, context: \
-            self.pool.get('res.users').browse(
-                cr, uid, uid, context=context).company_id.id,
-        }
-
-    def set_draft(self, cr, uid, ids, context=None):
-        return self.write(
-            cr, uid, ids, {'state': 'draft'}, context=context)
-
-    def generate_lines(self, cr, uid, ids, context=None):
+    def _default_company_id(self):
+        """Default company is active user company."""
+        return self.env.user.company_id.id
+
+    period_id = fields.Many2one(
+        string='Period',
+        comodel_name='account.period',
+        states={'done': [('readonly', True)]},
+        default=_default_period_id,
+    )
+    company_id = fields.Many2one(
+        string='Company',
+        comodel_name='res.company',
+        required=True,
+        states={'done': [('readonly', True)]},
+        help="Related company.",
+        default=_default_company_id,
+    )
+    total_amount = fields.Float(
+        string='Total amount',
+        readonly=True,
+        help="Total amount in company currency of the declaration.",
+        digits=dp.get_precision('Account'),
+    )
+    state = fields.Selection(
+        string='State',
+        selection=[
+            ('draft', 'Draft'),
+            ('done', 'Done'),
+        ],
+        default='draft',
+        readonly=True,
+        help=(
+            "State of the declaration. When the state is set to 'Done', "
+            "the parameters become read-only."
+        ),
+    )
+    date_done = fields.Date(
+        string='Date done',
+        readonly=True,
+        help=(
+            "Last date when the intrastat declaration was converted to "
+            "'Done' state."
+        ),
+    )
+    notes = fields.Text(
+        string='Notes',
+        help="You can add some comments here if you want.",
+    )
+    line_ids = fields.One2many(
+        string='ICP line',
+        comodel_name='l10n_nl.report.intrastat.line',
+        inverse_name='report_id',
+        readonly=True,
+    )
+
+    @api.one
+    def set_draft(self):
+        """
+        Reset report state to draft.
+        """
+        return self.write({'state': 'draft'})
+
+    @api.one
+    def generate_lines(self):
         """
         Collect the data lines for the given report.
         Unlink any existing lines first.
         """
-        report_line_obj = self.pool.get('l10n_nl.report.intrastat.line')
-        currency_obj = self.pool.get('res.currency')
-        invoice_obj = self.pool.get('account.invoice')
-        invoice_line_obj = self.pool.get('account.invoice.line')
+        # Generating lines is only allowed for report in draft state:
+        if self.state != 'draft':
+            raise Warning(_(
+                'Cannot generate reports lines in a non-draft state'))
+        # Other models:
+        report_line_model = self.env['l10n_nl.report.intrastat.line']
+        currency_model = self.env['res.currency']
+        invoice_model = self.env['account.invoice']
+        invoice_line_model = self.env['account.invoice.line']
 
         total_amount = 0.0
         partner_amounts_map = {}
-        localcontext = context and context.copy() or {}
+        # Check wether all configuration done to generate report
+        self.env['report.intrastat.common']._check_generate_lines(self)
 
         # Remove existing lines
-        line_ids = report_line_obj.search(
-            cr, uid, [('report_id', '=', ids[0])], context=context)
-        report_line_obj.unlink(cr, uid, line_ids, context=context)
-        report = self.browse(cr, uid, ids[0], context=context)
-
-        if report.state != 'draft':
-            raise orm.except_orm(
-                _('Error'),
-                _('Cannot generate reports lines in a non-draft state'))
-
+        for line_obj in self.line_ids:
+            line_obj.unlink()
+        # Define search for invoices for period and company:
+        company_obj = self.company_id  # simplify access
         invoice_domain = [
-                ('type', 'in', ('out_invoice', 'out_refund')),
-                ('period_id', '=', report.period_id.id),
-                ('state', 'in', ('open', 'paid')),
-                ('company_id', '=', report.company_id.id),
-                ('partner_id.country_id.id', '!=',
-                 report.company_id.country_id.id),
-                ]
-
+            ('type', 'in', ('out_invoice', 'out_refund')),
+            ('period_id', '=', self.period_id.id),
+            ('state', 'in', ('open', 'paid')),
+            ('company_id', '=', company_obj.id),
+        ]
         # Signal invoices without a country
-        invalid_invoice_ids = invoice_obj.search(
-            cr, uid, 
-            invoice_domain + [
-                ('partner_id.country_id', '=', False)],
-            context=context)
-        if invalid_invoice_ids:
-            invoices = invoice_obj.read(
-                cr, uid,
-                invalid_invoice_ids, ['partner_id'],
-                context=context)
-            raise orm.except_orm(
-                _('Error'), 
-                _("Missing country on the invoice addresses of the following "
-                  "partners:\n%s") % (
-                        "\n".join([inv['partner_id'][1] for inv in invoices])
-                        ))
-
-        invoice_ids = invoice_obj.search(
-            cr, uid,
-            invoice_domain + [
-                ('partner_id.country_id.intrastat', '=', True)],
-            context=context)
-        invoice_line_ids = invoice_line_obj.search(
-            cr, uid, [('invoice_id', 'in', invoice_ids)], context=context)
+        # (Should not happen, as country_id on parter is set to required)
+        invalid_invoices = invoice_model.search_read(
+            domain=invoice_domain + [('partner_id.country_id', '=', False)],
+            fields=['partner_id']
+        )
+        if invalid_invoices:
+            raise Warning(
+                _(
+                    "Missing country on the invoice addresses of the"
+                    " following partners:\n%s"
+                ) % "\n".join(
+                    inv['partner_id'][1] for inv in invalid_invoices)
+            )
+        # Search invoices that need intrastat reporting:
+        invoice_records = invoice_model.search(
+            invoice_domain + [
+                ('partner_id.country_id.intrastat', '=', True),
+                ('partner_id.country_id.id', '!=', company_obj.country_id.id),
+            ]
+        )
+        invoice_ids = [inv['id'] for inv in invoice_records]
+        invoice_line_records = invoice_line_model.search(
+            [('invoice_id', 'in', invoice_ids)])
 
         # Gather amounts from invoice lines
-        for line in invoice_line_obj.browse(
-            cr, uid, invoice_line_ids, context=context):
+        for line in invoice_line_records:
+            # Ignore invoiceline if taxes should not be included in intrastat:
             if any(
-                tax.exclude_from_intrastat_if_present
-                for tax in line.invoice_line_tax_id):
-                continue           
-            localcontext['date'] = line.invoice_id.date_invoice
-            commercial_partner_id = line.invoice_id.partner_id.commercial_partner_id.id
+                    tax.exclude_from_intrastat_if_present
+                    for tax in line.invoice_line_tax_id):
+                continue
+            # Report is per commercial partner:
+            commercial_partner_id = (
+                line.invoice_id.partner_id.commercial_partner_id.id)
             if commercial_partner_id not in partner_amounts_map:
                 partner_amounts_map[commercial_partner_id] = {
                     'amount_product': 0.0,
                     'amount_service': 0.0,
-                    }
+                }
             amounts = partner_amounts_map[commercial_partner_id]
-            if line.product_id and (
-                line.product_id.type == 'service'
-                or line.product_id.is_accessory_cost):
+            # Determine product or service:
+            if (line.product_id
+                    and (
+                        line.product_id.type == 'service'
+                        or line.product_id.is_accessory_cost)):
                 amount_type = 'amount_service'
             else:
                 amount_type = 'amount_product'
             sign = line.invoice_id.type == 'out_refund' and -1 or 1
             amount = sign * line.price_subtotal
-            if (line.invoice_id.currency_id
-                and line.invoice_id.currency_id.id !=
-                report.company_id.currency_id.id):
-                amount = currency_obj.compute(
-                    cr, uid, line.invoice_id.currency_id.id,
-                    report.company_id.currency_id.id,
-                    amount, context=localcontext)
-            amounts[amount_type] += amount
-            total_amount += amount
-            
+            # Convert currency amount if necessary:
+            line_currency_obj = line.invoice_id.currency_id  # simplify
+            invoice_date = line.invoice_id.date_invoice
+            if (line_currency_obj
+                    and line_currency_obj.id != company_obj.currency_id.id):
+                amount = (
+                    line_currency_obj.with_context(date=invoice_date).compute(
+                        amount, company_obj.currency_id, round=True)
+                )
+            # Accumulate totals:
+            amounts[amount_type] += amount  # per partner and type
+            total_amount += amount  # grand total
+
         # Create report lines
         for (partner_id, vals) in partner_amounts_map.items():
             if not (vals['amount_service'] or vals['amount_product']):
                 continue
             vals.update({
-                    'partner_id': partner_id,
-                    'report_id': report.id
-                    })
-            report_line_obj.create(
-                cr, uid, vals, context=context)
+                'partner_id': partner_id,
+                'report_id': self.id
+            })
+            report_line_model.create(vals)
 
-        return self.write(
-            cr, uid, report.id, {
-                'total_amount': total_amount,
-                'date_done': fields.date.context_today(
-                    self, cr, uid, context=context),
-                'state': 'done',
-                }, context=context)
+        return self.write({
+            'total_amount': total_amount,
+            'date_done': fields.Date.today(),
+            'state': 'done',
+        })
 
     def unlink(self, cr, uid, ids, context=None):
         """
@@ -214,53 +232,58 @@
             return True
         if isinstance(ids, (int, long)):
             ids = [ids]
-        if self.search(
+        non_draft_ids = self.search(
             cr, uid,
             [('id', 'in', ids), ('state', '!=', 'draft')],
-            context=context):
-            raise orm.except_orm(
-                _('Error'),
-                _('Cannot remove IPC reports in a non-draft state'))
-        return super(l10n_nl_report_intrastat, self).unlink(
+            context=context
+        )
+        if non_draft_ids:
+            raise Warning(_('Cannot remove IPC reports in a non-draft state'))
+        return super(ReportIntrastat, self).unlink(
             cr, uid, ids, context=context)
 
 
-class l10n_nl_report_intrastat_line(orm.Model):
+class ReportIntrastatLine(models.Model):
+    """Lines for dutch ICP report."""
     _name = "l10n_nl.report.intrastat.line"
     _description = "ICP report line"
     _order = "report_id, country_code"
     _rec_name = 'partner_id'
 
-    _columns = {
-        'report_id': fields.many2one(
-            'l10n_nl.report.intrastat',
-            'ICP report',
-            readonly=True,
-            required=True,
-            ondelete="CASCADE"),
-        'partner_id': fields.many2one(
-            'res.partner', 'Partner',
-            readonly=True,
-            required=True),
-        'vat': fields.related(
-            'partner_id', 'vat',
-            type='char', size=32,
-            string='VAT',
-            store=True,
-            readonly=True),
-        'country_code': fields.related(
-            'partner_id', 'country', 'code',
-            type='char', size=2,
-            string='Country Code',
-            store=True,
-            readonly=True,
-            ),
-        'amount_product': fields.float(
-            'Amount products',
-            digits_compute=dp.get_precision('Account'),
-            readonly=True),
-        'amount_service': fields.float(
-            'Amount services',
-            digits_compute=dp.get_precision('Account'),
-            readonly=True),
-        }
+    report_id = fields.Many2one(
+        string='ICP report',
+        comodel_name='l10n_nl.report.intrastat',
+        readonly=True,
+        required=True,
+        ondelete="CASCADE"
+    )
+    partner_id = fields.Many2one(
+        string='Partner',
+        comodel_name='res.partner',
+        readonly=True,
+        required=True,
+    )
+    vat = fields.Char(
+        string='VAT',
+        related='partner_id.vat',
+        store=True,
+        readonly=True,
+    )
+    country_code = fields.Char(
+        string='Country Code',
+        related='partner_id.country_id.code',
+        store=True,
+        readonly=True,
+    )
+    amount_product = fields.Float(
+        string='Amount products',
+        readonly=True,
+        digits=dp.get_precision('Account'),
+    )
+    amount_service = fields.Float(
+        string='Amount services',
+        readonly=True,
+        digits=dp.get_precision('Account'),
+    )
+
+# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: