Join the social network of Tech Nerds, increase skill rank, get work, manage projects...
  • How to get the outstanding residual value in invoice currency in Odoo?

    • 0
    • 0
    • 0
    • 0
    • 0
    • 0
    • 0
    • 0
    • 3.38k
    Comment on it

    If you want to get the outstanding residual value in invoice currency in Odoo then follow the following code in your .py file.

    # -*- coding: utf-8 -*-
    import json
    from lxml import etree
    from datetime import datetime
    from dateutil.relativedelta import relativedelta
    from openerp import api, fields, models, _
    from import float_is_zero
    from import formatLang
    from openerp.exceptions import UserError, RedirectWarning, ValidationError
    import openerp.addons.decimal_precision as dp
    # mapping invoice type to journal type
        'out_invoice': 'sale',
        'in_invoice': 'purchase',
        'out_refund': 'sale',
        'in_refund': 'purchase',
    # mapping invoice type to refund type
        'out_invoice': 'out_refund',        # Customer Invoice
        'in_invoice': 'in_refund',          # Vendor Bill
        'out_refund': 'out_invoice',        # Customer Refund
        'in_refund': 'in_invoice',          # Vendor Refund
    MAGIC_COLUMNS = ('id', 'create_uid', 'create_date', 'write_uid', 'write_date')
    class AccountInvoice(models.Model):
        _name = "account.invoice"
        _inherit = ['mail.thread']
        _description = "Invoice"
        _order = "date_invoice desc, number desc, id desc"
        @api.depends('invoice_line_ids.price_subtotal', 'tax_line_ids.amount', 'currency_id', 'company_id')
        def _compute_amount(self):
            self.amount_untaxed = sum(line.price_subtotal for line in self.invoice_line_ids)
            self.amount_tax = sum(line.amount for line in self.tax_line_ids)
            self.amount_total = self.amount_untaxed + self.amount_tax
            amount_total_company_signed = self.amount_total
            amount_untaxed_signed = self.amount_untaxed
            if self.currency_id and self.currency_id != self.company_id.currency_id:
                amount_total_company_signed = self.currency_id.compute(self.amount_total, self.company_id.currency_id)
                amount_untaxed_signed = self.currency_id.compute(self.amount_untaxed, self.company_id.currency_id)
            sign = self.type in ['in_refund', 'out_refund'] and -1 or 1
            self.amount_total_company_signed = amount_total_company_signed * sign
            self.amount_total_signed = self.amount_total * sign
            self.amount_untaxed_signed = amount_untaxed_signed * sign
        def _default_journal(self):
            if self._context.get('default_journal_id', False):
                return self.env['account.journal'].browse(self._context.get('default_journal_id'))
            inv_type = self._context.get('type', 'out_invoice')
            inv_types = inv_type if isinstance(inv_type, list) else [inv_type]
            company_id = self._context.get('company_id',
            domain = [
                ('type', 'in', filter(None, map(TYPE2JOURNAL.get, inv_types))),
                ('company_id', '=', company_id),
            return self.env['account.journal'].search(domain, limit=1)
        def _default_currency(self):
            journal = self._default_journal()
            return journal.currency_id or journal.company_id.currency_id
        def _get_reference_type(self):
            return [('none', _('Free Reference'))]
            'state', 'currency_id', 'invoice_line_ids.price_subtotal',
        def _compute_residual(self):
            residual = 0.0
            residual_company_signed = 0.0
            sign = self.type in ['in_refund', 'out_refund'] and -1 or 1
            for line in self.sudo().move_id.line_ids:
                if line.account_id.internal_type in ('receivable', 'payable'):
                    residual_company_signed += line.amount_residual * sign
                    if line.currency_id == self.currency_id:
                        residual += line.amount_residual_currency if line.currency_id else line.amount_residual
                        from_currency = (line.currency_id and line.currency_id.with_context( or line.company_id.currency_id.with_context(
                        residual += from_currency.compute(line.amount_residual, self.currency_id)
            self.residual_company_signed = residual_company_signed
            self.residual_signed = abs(residual) * sign
            self.residual = abs(residual)
            digits_rounding_precision = self.currency_id.rounding
            if float_is_zero(self.residual, digits_rounding_precision):
                self.reconciled = True
        def _get_outstanding_info_JSON(self):
            self.outstanding_credits_debits_widget = json.dumps(False)
            if self.state == 'open':
                domain = [('journal_id.type', 'in', ('bank', 'cash')), ('account_id', '=',, ('partner_id', '=', self.env['res.partner']._find_accounting_partner(self.partner_id).id), ('reconciled', '=', False), ('amount_residual', '!=', 0.0)]
                if self.type in ('out_invoice', 'in_refund'):
                    domain.extend([('credit', '>', 0), ('debit', '=', 0)])
                    type_payment = _('Outstanding credits')
                    domain.extend([('credit', '=', 0), ('debit', '>', 0)])
                    type_payment = _('Outstanding debits')
                info = {'title': '', 'outstanding': True, 'content': [], 'invoice_id':}
                lines = self.env['account.move.line'].search(domain)
                if len(lines) != 0:
                    for line in lines:
                        # get the outstanding residual value in invoice currency
                        # get the outstanding residual value in its currency. We don't want to show it
                        # in the invoice currency since the exchange rate between the invoice date and
                        # the payment date might have changed.
                        if line.currency_id:
                            currency_id = line.currency_id
                            amount_to_show = abs(line.amount_residual_currency)
                            currency_id = line.company_id.currency_id
                            amount_to_show = abs(line.amount_residual)
                            'journal_name': line.ref or,
                            'amount': amount_to_show,
                            'currency': currency_id.symbol,
                            'position': currency_id.position,
                            'digits': [69, self.currency_id.decimal_places],
                    info['title'] = type_payment
                    self.outstanding_credits_debits_widget = json.dumps(info)
                    self.has_outstanding = True
        def _get_payment_info_JSON(self):
            self.payments_widget = json.dumps(False)
            if self.payment_move_line_ids:
                info = {'title': _('Less Payment'), 'outstanding': False, 'content': []}
                for payment in self.payment_move_line_ids:
                    #we don't take into account the movement created due to a change difference
                    if payment.currency_id and payment.move_id.rate_diff_partial_rec_id:
                    if self.type in ('out_invoice', 'in_refund'):
                        amount = sum([p.amount for p in payment.matched_debit_ids if p.debit_move_id in self.move_id.line_ids])
                        amount_currency = sum([p.amount_currency for p in payment.matched_debit_ids if p.debit_move_id in self.move_id.line_ids])
                    elif self.type in ('in_invoice', 'out_refund'):
                        amount = sum([p.amount for p in payment.matched_credit_ids if p.credit_move_id in self.move_id.line_ids])
                        amount_currency = sum([p.amount_currency for p in payment.matched_credit_ids if p.credit_move_id in self.move_id.line_ids])
                    # Get the payment value in its currency. We don't want to show it in the invoice
                    # currency since the exchange rate between the invoice date and the payment date
                    # might have changed.
                    if payment.currency_id and amount_currency != 0:
                        currency_id = payment.currency_id
                        amount_to_show = -amount_currency
                        currency_id = payment.company_id.currency_id
                        amount_to_show = -amount
                        'amount': amount_to_show,
                        'currency': currency_id.symbol,
                        'digits': [69, currency_id.decimal_places],
                        'position': currency_id.position,
                        'ref': payment.move_id.ref,
                self.payments_widget = json.dumps(info)
        def _compute_payments(self):
            payment_lines = []
            for line in self.move_id.line_ids:
                payment_lines.extend([ for rp in line.matched_credit_ids])
                payment_lines.extend([ for rp in line.matched_debit_ids])
            self.payment_move_line_ids = self.env['account.move.line'].browse(list(set(payment_lines)))
        name = fields.Char(string='Reference/Description', index=True,
            readonly=True, states={'draft': [('readonly', False)]}, copy=False, help='The name that will be used on account move lines')
        origin = fields.Char(string='Source Document',
            help="Reference of the document that produced this invoice.",
            readonly=True, states={'draft': [('readonly', False)]})
        type = fields.Selection([
                ('out_invoice','Customer Invoice'),
                ('in_invoice','Vendor Bill'),
                ('out_refund','Customer Refund'),
                ('in_refund','Vendor Refund'),
            ], readonly=True, index=True, change_default=True,
            default=lambda self: self._context.get('type', 'out_invoice'),
        number = fields.Char(related='', store=True, readonly=True, copy=False)
        move_name = fields.Char(string='Journal Entry', readonly=True,
            default=False, copy=False,
            help="Technical field holding the number given to the invoice, automatically set when the invoice is validated then stored to set the same number again if the invoice is cancelled, set to draft and re-validated.")
        reference = fields.Char(string='Vendor Reference',
            help="The partner reference of this invoice.", readonly=True, states={'draft': [('readonly', False)]})
        reference_type = fields.Selection('_get_reference_type', string='Payment Reference',
            required=True, readonly=True, states={'draft': [('readonly', False)]},
        comment = fields.Text('Additional Information', readonly=True, states={'draft': [('readonly', False)]})
        state = fields.Selection([
                ('proforma', 'Pro-forma'),
                ('proforma2', 'Pro-forma'),
                ('open', 'Open'),
                ('paid', 'Paid'),
                ('cancel', 'Cancelled'),
            ], string='Status', index=True, readonly=True, default='draft',
            track_visibility='onchange', copy=False,
            help=" * The 'Draft' status is used when a user is encoding a new and unconfirmed Invoice.\n"
                 " * The 'Pro-forma' status is used the invoice does not have an invoice number.\n"
                 " * The 'Open' status is used when user create invoice, an invoice number is generated. Its in open status till user does not pay invoice.\n"
                 " * The 'Paid' status is set automatically when the invoice is paid. Its related journal entries may or may not be reconciled.\n"
                 " * The 'Cancelled' status is used when user cancel invoice.")
        sent = fields.Boolean(readonly=True, default=False, copy=False,
            help="It indicates that the invoice has been sent.")
        date_invoice = fields.Date(string='Invoice Date',
            readonly=True, states={'draft': [('readonly', False)]}, index=True,
            help="Keep empty to use the current date", copy=False)
        date_due = fields.Date(string='Due Date',
            readonly=True, states={'draft': [('readonly', False)]}, index=True, copy=False,
            help="If you use payment terms, the due date will be computed automatically at the generation "
                 "of accounting entries. The payment term may compute several due dates, for example 50% "
                 "now and 50% in one month, but if you want to force a due date, make sure that the payment "
                 "term is not set on the invoice. If you keep the payment term and the due date empty, it "
                 "means direct payment.")
        partner_id = fields.Many2one('res.partner', string='Partner', change_default=True,
            required=True, readonly=True, states={'draft': [('readonly', False)]},
        payment_term_id = fields.Many2one('account.payment.term', string='Payment Term', oldname='payment_term',
            readonly=True, states={'draft': [('readonly', False)]},
            help="If you use payment terms, the due date will be computed automatically at the generation "
                 "of accounting entries. If you keep the payment term and the due date empty, it means direct payment. "
                 "The payment term may compute several due dates, for example 50% now, 50% in one month.")
        date = fields.Date(string='Accounting Date',
            help="Keep empty to use the invoice date.",
            readonly=True, states={'draft': [('readonly', False)]})
        account_id = fields.Many2one('account.account', string='Account',
            required=True, readonly=True, states={'draft': [('readonly', False)]},
            domain=[('deprecated', '=', False)], help="The partner account used for this invoice.")
        invoice_line_ids = fields.One2many('account.invoice.line', 'invoice_id', string='Invoice Lines', oldname='invoice_line',
            readonly=True, states={'draft': [('readonly', False)]}, copy=True)
        tax_line_ids = fields.One2many('', 'invoice_id', string='Tax Lines', oldname='tax_line',
            readonly=True, states={'draft': [('readonly', False)]}, copy=True)
        move_id = fields.Many2one('account.move', string='Journal Entry',
            readonly=True, index=True, ondelete='restrict', copy=False,
            help="Link to the automatically generated Journal Items.")
        amount_untaxed = fields.Monetary(string='Untaxed Amount',
            store=True, readonly=True, compute='_compute_amount', track_visibility='always')
        amount_untaxed_signed = fields.Monetary(string='Untaxed Amount', currency_field='company_currency_id',
            store=True, readonly=True, compute='_compute_amount')
        amount_tax = fields.Monetary(string='Tax',
            store=True, readonly=True, compute='_compute_amount')
        amount_total = fields.Monetary(string='Total',
            store=True, readonly=True, compute='_compute_amount')
        amount_total_signed = fields.Monetary(string='Total', currency_field='currency_id',
            store=True, readonly=True, compute='_compute_amount',
            help="Total amount in the currency of the invoice, negative for credit notes.")
        amount_total_company_signed = fields.Monetary(string='Total', currency_field='company_currency_id',
            store=True, readonly=True, compute='_compute_amount',
            help="Total amount in the currency of the company, negative for credit notes.")
        currency_id = fields.Many2one('res.currency', string='Currency',
            required=True, readonly=True, states={'draft': [('readonly', False)]},
            default=_default_currency, track_visibility='always')
        company_currency_id = fields.Many2one('res.currency', related='company_id.currency_id', readonly=True)
        journal_id = fields.Many2one('account.journal', string='Journal',
            required=True, readonly=True, states={'draft': [('readonly', False)]},
            domain="[('type', 'in', {'out_invoice': ['sale'], 'out_refund': ['sale'], 'in_refund': ['purchase'], 'in_invoice': ['purchase']}.get(type, [])), ('company_id', '=', company_id)]")
        company_id = fields.Many2one('', string='Company', change_default=True,
            required=True, readonly=True, states={'draft': [('readonly', False)]},
            default=lambda self: self.env['']._company_default_get('account.invoice'))
        reconciled = fields.Boolean(string='Paid/Reconciled', store=True, readonly=True, compute='_compute_residual',
            help="It indicates that the invoice has been paid and the journal entry of the invoice has been reconciled with one or several journal entries of payment.")
        partner_bank_id = fields.Many2one('', string='Bank Account',
            help='Bank Account Number to which the invoice will be paid. A Company bank account if this is a Customer Invoice or Vendor Refund, otherwise a Partner bank account number.',
            readonly=True, states={'draft': [('readonly', False)]})
        residual = fields.Monetary(string='Amount Due',
            compute='_compute_residual', store=True, help="Remaining amount due.")
        residual_signed = fields.Monetary(string='Amount Due', currency_field='currency_id',
            compute='_compute_residual', store=True, help="Remaining amount due in the currency of the invoice.")
        residual_company_signed = fields.Monetary(string='Amount Due', currency_field='company_currency_id',
            compute='_compute_residual', store=True, help="Remaining amount due in the currency of the company.")
        payment_ids = fields.Many2many('account.payment', 'account_invoice_payment_rel', 'invoice_id', 'payment_id', string="Payments", copy=False, readonly=True)
        payment_move_line_ids = fields.Many2many('account.move.line', string='Payments', compute='_compute_payments', store=True)
        user_id = fields.Many2one('res.users', string='Salesperson', track_visibility='onchange',
            readonly=True, states={'draft': [('readonly', False)]},
            default=lambda self: self.env.user)
        fiscal_position_id = fields.Many2one('account.fiscal.position', string='Fiscal Position', oldname='fiscal_position',
            readonly=True, states={'draft': [('readonly', False)]})
        commercial_partner_id = fields.Many2one('res.partner', string='Commercial Entity',
            related='partner_id.commercial_partner_id', store=True, readonly=True,
            help="The commercial entity that will be used on Journal Entries for this invoice")
        outstanding_credits_debits_widget = fields.Text(compute='_get_outstanding_info_JSON')
        payments_widget = fields.Text(compute='_get_payment_info_JSON')
        has_outstanding = fields.Boolean(compute='_get_outstanding_info_JSON')
        _sql_constraints = [
            ('number_uniq', 'unique(number, company_id, journal_id, type)', 'Invoice Number must be unique per Company!'),
        def create(self, vals):
            if not vals.get('account_id',False):
                raise UserError(_('Configuration error!\nCould not find any account to create the invoice, are you sure you have a chart of account installed?'))
            return super(AccountInvoice, self.with_context(mail_create_nolog=True)).create(vals)
        def fields_view_get(self, view_id=None, view_type=False, toolbar=False, submenu=False):
            def get_view_id(xid, name):
                    return self.env.ref('account.' + xid)
                except ValueError:
                    view = self.env['ir.ui.view'].search([('name', '=', name)], limit=1)
                    if not view:
                        return False
            context = self._context
            if context.get('active_model') == 'res.partner' and context.get('active_ids'):
                partner = self.env['res.partner'].browse(context['active_ids'])[0]
                if not view_type:
                    view_id = get_view_id('invoice_tree', 'account.invoice.tree')
                    view_type = 'tree'
                elif view_type == 'form':
                    if partner.supplier and not partner.customer:
                        view_id = get_view_id('invoice_supplier_form', 'account.invoice.supplier.form').id
                    elif partner.customer and not partner.supplier:
                        view_id = get_view_id('invoice_form', 'account.invoice.form').id
            return super(AccountInvoice, self).fields_view_get(view_id=view_id, view_type=view_type, toolbar=toolbar, submenu=submenu)
        def invoice_print(self):
            """ Print the invoice and mark it as sent, so that we can see more
                easily the next step of the workflow
            self.sent = True
            return self.env['report'].get_action(self, 'account.report_invoice')
        def action_invoice_sent(self):
            """ Open a window to compose an email, with the edi invoice template
                message loaded by default
            template = self.env.ref('account.email_template_edi_invoice', False)
            compose_form = self.env.ref('mail.email_compose_message_wizard_form', False)
            ctx = dict(
            return {
                'name': _('Compose Email'),
                'type': 'ir.actions.act_window',
                'view_type': 'form',
                'view_mode': 'form',
                'res_model': 'mail.compose.message',
                'views': [(, 'form')],
                'target': 'new',
                'context': ctx,
        def compute_taxes(self):
            """Function used in other module to compute the taxes on a fresh invoice created (onchanges did not applied)"""
            account_invoice_tax = self.env['']
            ctx = dict(self._context)
            for invoice in self:
                # Delete non-manual tax lines
                self._cr.execute("DELETE FROM account_invoice_tax WHERE invoice_id=%s AND manual is False", (,))
                # Generate one tax line per tax, however many invoice lines it's applied to
                tax_grouped = invoice.get_taxes_values()
                # Create new tax lines
                for tax in tax_grouped.values():
            # dummy write on self to trigger recomputations
            return self.with_context(ctx).write({'invoice_line_ids': []})
        def confirm_paid(self):
            return self.write({'state': 'paid'})
        def unlink(self):
            for invoice in self:
                if invoice.state not in ('draft', 'cancel'):
                    raise UserError(_('You cannot delete an invoice which is not draft or cancelled. You should refund it instead.'))
                elif invoice.move_name:
                    raise UserError(_('You cannot delete an invoice after it has been validated (and received a number). You can set it back to "Draft" state and modify its content, then re-confirm it.'))
            return super(AccountInvoice, self).unlink()
        def _onchange_invoice_line_ids(self):
            taxes_grouped = self.get_taxes_values()
            tax_lines = self.tax_line_ids.browse([])
            for tax in taxes_grouped.values():
                tax_lines +=
            self.tax_line_ids = tax_lines
        @api.onchange('partner_id', 'company_id')
        def _onchange_partner_id(self):
            account_id = False
            payment_term_id = False
            fiscal_position = False
            bank_id = False
            p = self.partner_id
            company_id =
            type = self.type
            if p:
                partner_id =
                rec_account = p.property_account_receivable_id
                pay_account = p.property_account_payable_id
                if company_id:
                    if p.property_account_receivable_id.company_id and \
                   != company_id and \
                            p.property_account_payable_id.company_id and \
                   != company_id:
                        prop = self.env['']
                        rec_dom = [('name', '=', 'property_account_receivable_id'), ('company_id', '=', company_id)]
                        pay_dom = [('name', '=', 'property_account_payable_id'), ('company_id', '=', company_id)]
                        res_dom = [('res_id', '=', 'res.partner,%s' % partner_id)]
                        rec_prop = + res_dom) or
                        pay_prop = + res_dom) or
                        rec_account = rec_prop.get_by_record(rec_prop)
                        pay_account = pay_prop.get_by_record(pay_prop)
                        if not rec_account and not pay_account:
                            action = self.env.ref('account.action_account_config')
                            msg = _('Cannot find a chart of accounts for this company, You should configure it. \nPlease go to Account Configuration.')
                            raise RedirectWarning(msg,, _('Go to the configuration panel'))
                if type in ('out_invoice', 'out_refund'):
                    account_id =
                    payment_term_id =
                    account_id =
                    payment_term_id =
                fiscal_position =
                bank_id = p.bank_ids and p.bank_ids.ids[0] or False
            self.account_id = account_id
            self.payment_term_id = payment_term_id
            self.fiscal_position_id = fiscal_position
            if type in ('in_invoice', 'in_refund'):
                self.partner_bank_id = bank_id
        def _onchange_journal_id(self):
            if self.journal_id:
                self.currency_id = or
        @api.onchange('payment_term_id', 'date_invoice')
        def _onchange_payment_term_date_invoice(self):
            date_invoice = self.date_invoice
            if not date_invoice:
                date_invoice = fields.Date.context_today(self)
            if not self.payment_term_id:
                # When no payment term defined
                self.date_due = self.date_due or self.date_invoice
                pterm = self.payment_term_id
                pterm_list = pterm.compute(value=1, date_ref=date_invoice)[0]
                self.date_due = max(line[0] for line in pterm_list)
        def action_cancel_draft(self):
            # go from canceled state to draft state
            self.write({'state': 'draft'})
            return True
        def get_taxes_values(self):
            tax_grouped = {}
            for line in self.invoice_line_ids:
                price_unit = line.price_unit * (1 - ( or 0.0) / 100.0) + line.maintenance_Plan
                taxes = line.invoice_line_tax_ids.compute_all(price_unit, self.currency_id, line.quantity, line.product_id, self.partner_id)['taxes']
                for tax in taxes:
                    val = {
                        'name': tax['name'],
                        'tax_id': tax['id'],
                        'amount': tax['amount'],
                        'manual': False,
                        'sequence': tax['sequence'],
                        'account_analytic_id': tax['analytic'] and or False,
                        'account_id': self.type in ('out_invoice', 'in_invoice') and (tax['account_id'] or or (tax['refund_account_id'] or,
                    # If the taxes generate moves on the same financial account as the invoice line,
                    # propagate the analytic account from the invoice line to the tax line.
                    # This is necessary in situations were (part of) the taxes cannot be reclaimed,
                    # to ensure the tax move is allocated to the proper analytic account.
                    if not val.get('account_analytic_id') and line.account_analytic_id and val['account_id'] ==
                        val['account_analytic_id'] =
                    key = tax['id']
                    if key not in tax_grouped:
                        tax_grouped[key] = val
                        tax_grouped[key]['amount'] += val['amount']
            return tax_grouped
        def register_payment(self, payment_line, writeoff_acc_id=False, writeoff_journal_id=False):
            """ Reconcile payable/receivable lines from the invoice with payment_line """
            line_to_reconcile = self.env['account.move.line']
            for inv in self:
                line_to_reconcile += inv.move_id.line_ids.filtered(lambda r: not r.reconciled and r.account_id.internal_type in ('payable', 'receivable'))
            return (line_to_reconcile + payment_line).reconcile(writeoff_acc_id, writeoff_journal_id)
        def assign_outstanding_credit(self, cr, uid, id, payment_id, context=None):
            return self.browse(cr, uid, id, context).register_payment(self.pool.get('account.move.line').browse(cr, uid, payment_id, context))
        def action_date_assign(self):
            for inv in self:
                # Here the onchange will automatically write to the database
            return True
        def finalize_invoice_move_lines(self, move_lines):
            """ finalize_invoice_move_lines(move_lines) -> move_lines
                Hook method to be overridden in additional modules to verify and
                possibly alter the move lines to be created by an invoice, for
                special cases.
                :param move_lines: list of dictionaries with the account.move.lines (as for create())
                :return: the (possibly updated) final move_lines to create for this invoice
            return move_lines
        def compute_invoice_totals(self, company_currency, invoice_move_lines):
            total = 0
            total_currency = 0
            for line in invoice_move_lines:
                if self.currency_id != company_currency:
                    currency = self.currency_id.with_context(date=self.date_invoice or fields.Date.context_today(self))
                    line['currency_id'] =
                    line['amount_currency'] = currency.round(line['price'])
                    line['price'] = currency.compute(line['price'], company_currency)
                    line['currency_id'] = False
                    line['amount_currency'] = False
                    line['price'] = self.currency_id.round(line['price'])
                if self.type in ('out_invoice', 'in_refund'):
                    total += line['price']
                    total_currency += line['amount_currency'] or line['price']
                    line['price'] = - line['price']
                    total -= line['price']
                    total_currency -= line['amount_currency'] or line['price']
            return total, total_currency, invoice_move_lines
        def invoice_line_move_line_get(self):
            res = []
            for line in self.invoice_line_ids:
                tax_ids = []
                for tax in line.invoice_line_tax_ids:
                    tax_ids.append((4,, None))
                    for child in tax.children_tax_ids:
                        if child.type_tax_use != 'none':
                            tax_ids.append((4,, None))
                move_line_dict = {
                    'type': 'src',
                    'price_unit': line.price_unit,
                    'quantity': line.quantity,
                    'price': line.price_subtotal,
                    'tax_ids': tax_ids,
                if line['account_analytic_id']:
                    move_line_dict['analytic_line_ids'] = [(0, 0, line._get_analytic_line())]
            return res
        def tax_line_move_line_get(self):
            res = []
            for tax_line in self.tax_line_ids:
                    'type': 'tax',
                    'price_unit': tax_line.amount,
                    'quantity': 1,
                    'price': tax_line.amount,
            return res
        def inv_line_characteristic_hashcode(self, invoice_line):
            """Overridable hashcode generation for invoice lines. Lines having the same hashcode
            will be grouped together if the journal has the 'group line' option. Of course a module
            can add fields to invoice lines that would need to be tested too before merging lines
            or not."""
            return "%s-%s-%s-%s-%s" % (
                invoice_line.get('tax_line_id', 'False'),
                invoice_line.get('product_id', 'False'),
                invoice_line.get('analytic_account_id', 'False'),
                invoice_line.get('date_maturity', 'False'),
        def group_lines(self, iml, line):
            """Merge account move lines (and hence analytic lines) if invoice line hashcodes are equals"""
            if self.journal_id.group_invoice_lines:
                line2 = {}
                for x, y, l in line:
                    tmp = self.inv_line_characteristic_hashcode(l)
                    if tmp in line2:
                        am = line2[tmp]['debit'] - line2[tmp]['credit'] + (l['debit'] - l['credit'])
                        line2[tmp]['debit'] = (am > 0) and am or 0.0
                        line2[tmp]['credit'] = (am < 0) and -am or 0.0
                        line2[tmp]['analytic_line_ids'] += l['analytic_line_ids']
                        line2[tmp] = l
                line = []
                for key, val in line2.items():
                    line.append((0, 0, val))
            return line
        def action_move_create(self):
            """ Creates invoice related analytics and financial move lines """
            account_move = self.env['account.move']
            for inv in self:
                if not inv.journal_id.sequence_id:
                    raise UserError(_('Please define sequence on the journal related to this invoice.'))
                if not inv.invoice_line_ids:
                    raise UserError(_('Please create some invoice lines.'))
                if inv.move_id:
                ctx = dict(self._context, lang=inv.partner_id.lang)
                if not inv.date_invoice:
                    inv.with_context(ctx).write({'date_invoice': fields.Date.context_today(self)})
                date_invoice = inv.date_invoice
                company_currency = inv.company_id.currency_id
                # create move lines (one per invoice line + eventual taxes and analytic lines)
                iml = inv.invoice_line_move_line_get()
                iml += inv.tax_line_move_line_get()
                diff_currency = inv.currency_id != company_currency
                # create one move line for the total and possibly adjust the other lines amount
                total, total_currency, iml = inv.with_context(ctx).compute_invoice_totals(company_currency, iml)
                name = or '/'
                if inv.payment_term_id:
                    totlines = inv.with_context(ctx).payment_term_id.compute(total, date_invoice)[0]
                    res_amount_currency = total_currency
                    ctx['date'] = date_invoice
                    for i, t in enumerate(totlines):
                        if inv.currency_id != company_currency:
                            amount_currency = company_currency.with_context(ctx).compute(t[1], inv.currency_id)
                            amount_currency = False
                        # last line: add the diff
                        res_amount_currency -= amount_currency or 0
                        if i + 1 == len(totlines):
                            amount_currency += res_amount_currency
                            'type': 'dest',
                            'name': name,
                            'price': t[1],
                            'date_maturity': t[0],
                            'amount_currency': diff_currency and amount_currency,
                            'currency_id': diff_currency and,
                        'type': 'dest',
                        'name': name,
                        'price': total,
                        'date_maturity': inv.date_due,
                        'amount_currency': diff_currency and total_currency,
                        'currency_id': diff_currency and,
                part = self.env['res.partner']._find_accounting_partner(inv.partner_id)
                line = [(0, 0, self.line_get_convert(l, for l in iml]
                line = inv.group_lines(iml, line)
                journal = inv.journal_id.with_context(ctx)
                line = inv.finalize_invoice_move_lines(line)
                date = or date_invoice
                move_vals = {
                    'ref': inv.reference,
                    'line_ids': line,
                    'date': date,
                    'narration': inv.comment,
                ctx['company_id'] =
                ctx['dont_create_taxes'] = True
                ctx['invoice'] = inv
                ctx_nolang = ctx.copy()
                ctx_nolang.pop('lang', None)
                move = account_move.with_context(ctx_nolang).create(move_vals)
                # Pass invoice in context in method post: used if you want to get the same
                # account move reference when creating the same invoice after a cancelled one:
                # make the invoice point to that move
                vals = {
                    'date': date,
            return True
        def invoice_validate(self):
            for invoice in self:
                #refuse to validate a vendor bill/refund if there already exists one with the same reference for the same partner,
                #because it's probably a double encoding of the same bill/refund
                if invoice.type in ('in_invoice', 'in_refund') and invoice.reference:
                    if[('type', '=', invoice.type), ('reference', '=', invoice.reference), ('company_id', '=',, ('commercial_partner_id', '=',, ('id', '!=',]):
                        raise UserError(_("Duplicated vendor reference detected. You probably encoded twice the same vendor bill/refund."))
            return self.write({'state': 'open'})
        def line_get_convert(self, line, part):
            return {
                'date_maturity': line.get('date_maturity', False),
                'partner_id': part,
                'name': line['name'][:64],
                'debit': line['price'] > 0 and line['price'],
                'credit': line['price'] < 0 and -line['price'],
                'account_id': line['account_id'],
                'analytic_line_ids': line.get('analytic_line_ids', []),
                'amount_currency': line['price'] > 0 and abs(line.get('amount_currency', False)) or -abs(line.get('amount_currency', False)),
                'currency_id': line.get('currency_id', False),
                'quantity': line.get('quantity', 1.00),
                'product_id': line.get('product_id', False),
                'product_uom_id': line.get('uom_id', False),
                'analytic_account_id': line.get('account_analytic_id', False),
                'invoice_id': line.get('invoice_id', False),
                'tax_ids': line.get('tax_ids', False),
                'tax_line_id': line.get('tax_line_id', False),
        def action_cancel(self):
            moves = self.env['account.move']
            for inv in self:
                if inv.move_id:
                    moves += inv.move_id
                if inv.payment_move_line_ids:
                    raise UserError(_('You cannot cancel an invoice which is partially paid. You need to unreconcile related payment entries first.'))
            # First, set the invoices as cancelled and detach the move ids
            self.write({'state': 'cancel', 'move_id': False})
            if moves:
                # second, invalidate the move(s)
                # delete the move this invoice was pointing to
                # Note that the corresponding move_lines and move_reconciles
                # will be automatically deleted too
            return True
        def name_get(self):
            TYPES = {
                'out_invoice': _('Invoice'),
                'in_invoice': _('Vendor Bill'),
                'out_refund': _('Refund'),
                'in_refund': _('Vendor Refund'),
            result = []
            for inv in self:
                result.append((, "%s %s" % (inv.number or TYPES[inv.type], or '')))
            return result
        def name_search(self, name, args=None, operator='ilike', limit=100):
            args = args or []
            recs = self.browse()
            if name:
                recs =[('number', '=', name)] + args, limit=limit)
            if not recs:
                recs =[('name', operator, name)] + args, limit=limit)
            return recs.name_get()
        def _refund_cleanup_lines(self, lines):
            """ Convert records to dict of values suitable for one2many line creation
                :param recordset lines: records to convert
                :return: list of command tuple for one2many line creation [(0, 0, dict of valueis), ...]
            result = []
            for line in lines:
                values = {}
                for name, field in line._fields.iteritems():
                    if name in MAGIC_COLUMNS:
                    elif field.type == 'many2one':
                        values[name] = line[name].id
                    elif field.type not in ['many2many', 'one2many']:
                        values[name] = line[name]
                    elif name == 'invoice_line_tax_ids':
                        values[name] = [(6, 0, line[name].ids)]
                result.append((0, 0, values))
            return result
        def _prepare_refund(self, invoice, date_invoice=None, date=None, description=None, journal_id=None):
            """ Prepare the dict of values to create the new refund from the invoice.
                This method may be overridden to implement custom
                refund generation (making sure to call super() to establish
                a clean extension chain).
                :param record invoice: invoice to refund
                :param string date_invoice: refund creation date from the wizard
                :param integer date: force date from the wizard
                :param string description: description of the refund from the wizard
                :param integer journal_id: account.journal from the wizard
                :return: dict of value to create() the refund
            values = {}
            for field in ['name', 'reference', 'comment', 'date_due', 'partner_id', 'company_id',
                    'account_id', 'currency_id', 'payment_term_id', 'user_id', 'fiscal_position_id']:
                if invoice._fields[field].type == 'many2one':
                    values[field] = invoice[field].id
                    values[field] = invoice[field] or False
            values['invoice_line_ids'] = self._refund_cleanup_lines(invoice.invoice_line_ids)
            tax_lines = filter(lambda l: l.manual, invoice.tax_line_ids)
            values['tax_line_ids'] = self._refund_cleanup_lines(tax_lines)
            if journal_id:
                journal = self.env['account.journal'].browse(journal_id)
            elif invoice['type'] == 'in_invoice':
                journal = self.env['account.journal'].search([('type', '=', 'purchase')], limit=1)
                journal = self.env['account.journal'].search([('type', '=', 'sale')], limit=1)
            values['journal_id'] =
            values['type'] = TYPE2REFUND[invoice['type']]
            values['date_invoice'] = date_invoice or fields.Date.context_today(invoice)
            values['state'] = 'draft'
            values['number'] = False
            values['origin'] = invoice.number
            if date:
                values['date'] = date
            if description:
                values['name'] = description
            return values
        def refund(self, date_invoice=None, date=None, description=None, journal_id=None):
            new_invoices = self.browse()
            for invoice in self:
                # create the new invoice
                values = self._prepare_refund(invoice, date_invoice=date_invoice, date=date,
                                        description=description, journal_id=journal_id)
                new_invoices += self.create(values)
            return new_invoices
        def pay_and_reconcile(self, pay_journal, pay_amount=None, date=None, writeoff_acc=None):
            """ Create and post an account.payment for the invoice self, which creates a journal entry that reconciles the invoice.
                :param pay_journal: journal in which the payment entry will be created
                :param pay_amount: amount of the payment to register, defaults to the residual of the invoice
                :param date: payment date, defaults to fields.Date.context_today(self)
                :param writeoff_acc: account in which to create a writeoff if pay_amount < self.residual, so that the invoice is fully paid
            assert len(self) == 1, "Can only pay one invoice at a time."
            payment_type = self.type in ('out_invoice', 'in_refund') and 'inbound' or 'outbound'
            if payment_type == 'inbound':
                payment_method = self.env.ref('account.account_payment_method_manual_in')
                journal_payment_methods = pay_journal.inbound_payment_method_ids
                payment_method = self.env.ref('account.account_payment_method_manual_out')
                journal_payment_methods = pay_journal.outbound_payment_method_ids
            if payment_method not in journal_payment_methods:
                raise UserError(_('No appropriate payment method enabled on journal %s') %
            payment = self.env['account.payment'].create({
                'invoice_ids': [(6, 0, self.ids)],
                'amount': pay_amount or self.residual,
                'payment_date': date or fields.Date.context_today(self),
                'communication': self.type in ('in_invoice', 'in_refund') and self.reference or self.number,
                'partner_type': self.type in ('out_invoice', 'out_refund') and 'customer' or 'supplier',
                'payment_type': payment_type,
                'payment_difference_handling': writeoff_acc and 'reconcile' or 'open',
                'writeoff_account_id': writeoff_acc and or False,
        def pay_and_reconcile(self, cr, uid, ids, pay_journal_id, pay_amount=None, date=None, writeoff_acc_id=None, context=None):
            recs = self.browse(cr, uid, ids, context)
            pay_journal = self.pool.get('account.journal').browse(cr, uid, pay_journal_id, context=context)
            writeoff_acc = self.pool.get('account.account').browse(cr, uid, writeoff_acc_id, context=context)
            return recs.pay_and_reconcile(pay_journal, pay_amount, date, writeoff_acc)
        def _track_subtype(self, init_values):
            if 'state' in init_values and self.state == 'paid' and self.type in ('out_invoice', 'out_refund'):
                return 'account.mt_invoice_paid'
            elif 'state' in init_values and self.state == 'open' and self.type in ('out_invoice', 'out_refund'):
                return 'account.mt_invoice_validated'
            elif 'state' in init_values and self.state == 'draft' and self.type in ('out_invoice', 'out_refund'):
                return 'account.mt_invoice_created'
            return super(AccountInvoice, self)._track_subtype(init_values)
        def _get_tax_amount_by_group(self):
            res = {}
            currency = self.currency_id or self.company_id.currency_id
            for line in self.tax_line_ids:
                res.setdefault(line.tax_id.tax_group_id, 0.0)
                res[line.tax_id.tax_group_id] += line.amount
            res = sorted(res.items(), key=lambda l: l[0].sequence)
            res = map(lambda l: (l[0].name, formatLang(self.env, l[1], currency_obj=currency)), res)
            return res
    class AccountInvoiceLine(models.Model):
        _name = "account.invoice.line"
        _description = "Invoice Line"
        _order = "invoice_id,sequence,id"
        def _get_analytic_line(self):
            ref = self.invoice_id.number
            return {
                'date': self.invoice_id.date_invoice,
                'unit_amount': self.quantity,
                'amount': self.price_subtotal_signed,
                'ref': ref,
        @api.depends('price_unit', 'discount', 'invoice_line_tax_ids', 'quantity',
            'product_id', 'invoice_id.partner_id', 'invoice_id.currency_id', 'invoice_id.company_id')
        def _compute_price(self):
            currency = self.invoice_id and self.invoice_id.currency_id or None
            price = self.price_unit * (1 - ( or 0.0) / 100.0) + self.maintenance_Plan
            taxes = False
            if self.invoice_line_tax_ids:
                taxes = self.invoice_line_tax_ids.compute_all(price, currency, self.quantity, product=self.product_id, partner=self.invoice_id.partner_id)
            self.price_subtotal = price_subtotal_signed = taxes['total_excluded'] if taxes else self.quantity * price
            if self.invoice_id.currency_id and self.invoice_id.currency_id != self.invoice_id.company_id.currency_id:
                price_subtotal_signed = self.invoice_id.currency_id.compute(price_subtotal_signed, self.invoice_id.company_id.currency_id)
            sign = self.invoice_id.type in ['in_refund', 'out_refund'] and -1 or 1
            self.price_subtotal_signed = price_subtotal_signed * sign
        def _default_account(self):
            if self._context.get('journal_id'):
                journal = self.env['account.journal'].browse(self._context.get('journal_id'))
                if self._context.get('type') in ('out_invoice', 'in_refund'):
        name = fields.Text(string='Description', required=True)
        origin = fields.Char(string='Source Document',
            help="Reference of the document that produced this invoice.")
        sequence = fields.Integer(default=10,
            help="Gives the sequence of this line when displaying the invoice.")
        invoice_id = fields.Many2one('account.invoice', string='Invoice Reference',
            ondelete='cascade', index=True)
        uom_id = fields.Many2one('product.uom', string='Unit of Measure',
            ondelete='set null', index=True, oldname='uos_id')
        product_id = fields.Many2one('product.product', string='Product',
            ondelete='restrict', index=True)
        account_id = fields.Many2one('account.account', string='Account',
            required=True, domain=[('deprecated', '=', False)],
            help="The income or expense account related to the selected product.")
        price_unit = fields.Monetary(string='Unit Price', required=True)
        price_subtotal = fields.Monetary(string='Amount',
            store=True, readonly=True, compute='_compute_price')
        price_subtotal_signed = fields.Monetary(string='Amount Signed', currency_field='company_currency_id',
            store=True, readonly=True, compute='_compute_price',
            help="Total amount in the currency of the company, negative for credit notes.")
        quantity = fields.Float(string='Quantity', digits=dp.get_precision('Product Unit of Measure'),
            required=True, default=1)
        discount = fields.Float(string='Discount (%)', digits=dp.get_precision('Discount'),
        invoice_line_tax_ids = fields.Many2many('',
            'account_invoice_line_tax', 'invoice_line_id', 'tax_id',
            string='Taxes', domain=[('type_tax_use','!=','none')], oldname='invoice_line_tax_id')
        account_analytic_id = fields.Many2one('account.analytic.account',
            string='Analytic Account')
        company_id = fields.Many2one('', string='Company',
            related='invoice_id.company_id', store=True, readonly=True)
        partner_id = fields.Many2one('res.partner', string='Partner',
            related='invoice_id.partner_id', store=True, readonly=True)
        currency_id = fields.Many2one('res.currency', related='invoice_id.currency_id', store=True)
        company_currency_id = fields.Many2one('res.currency', related='invoice_id.company_currency_id', readonly=True)
        def fields_view_get(self, view_id=None, view_type='form', toolbar=False, submenu=False):
            res = super(AccountInvoiceLine, self).fields_view_get(
                view_id=view_id, view_type=view_type, toolbar=toolbar, submenu=submenu)
            if self._context.get('type'):
                doc = etree.XML(res['arch'])
                for node in doc.xpath("//field[@name='product_id']"):
                    if self._context['type'] in ('in_invoice', 'in_refund'):
                        node.set('domain', "[('purchase_ok', '=', True)]")
                        node.set('domain', "[('sale_ok', '=', True)]")
                res['arch'] = etree.tostring(doc)
            return res
        def get_invoice_line_account(self, type, product, fpos, company):
            accounts = product.product_tmpl_id.get_product_accounts(fpos)
            if type in ('out_invoice', 'out_refund'):
                return accounts['income']
            return accounts['expense']
        def _set_taxes(self):
            """ Used in on_change to set taxes """
            if self.invoice_id.type in ('out_invoice', 'out_refund'):
                taxes = self.product_id.taxes_id or self.account_id.tax_ids
                taxes = self.product_id.supplier_taxes_id or self.account_id.tax_ids
            self.invoice_line_tax_ids = self.invoice_id.fiscal_position_id.map_tax(taxes)
        def _onchange_product_id(self):
            domain = {}
            if not self.invoice_id:
            part = self.invoice_id.partner_id
            fpos = self.invoice_id.fiscal_position_id
            company = self.invoice_id.company_id
            currency = self.invoice_id.currency_id
            type = self.invoice_id.type
            if not part:
                warning = {
                        'title': _('Warning!'),
                        'message': _('You must first select a partner!'),
                return {'warning': warning}
            if not self.product_id:
                if type not in ('in_invoice', 'in_refund'):
                    self.price_unit = 0.0
                domain['uom_id'] = []
                if part.lang:
                    product = self.product_id.with_context(lang=part.lang)
                    product = self.product_id
       = product.partner_ref
                account = self.get_invoice_line_account(type, product, fpos, company)
                if account:
                    self.account_id =
                if type in ('in_invoice', 'in_refund'):
                    self.price_unit = self.price_unit or product.standard_price
                    if product.description_purchase:
               += '\n' + product.description_purchase
                    self.price_unit = product.lst_price
                    if product.description_sale:
               += '\n' + product.description_sale
                if not self.uom_id or !=
                    self.uom_id =
                domain['uom_id'] = [('category_id', '=',]
                if company and currency:
                    if company.currency_id != currency:
                        if type in ('in_invoice', 'in_refund'):
                            self.price_unit = product.standard_price
                        self.price_unit = self.price_unit * currency.with_context(dict(self._context or {}, date=self.invoice_id.date_invoice)).rate
                    if self.uom_id and !=
                        self.price_unit = self.env['product.uom']._compute_price(
                  , self.price_unit,
            return {'domain': domain}
        def _onchange_account_id(self):
            if not self.account_id:
            if not self.product_id:
                fpos = self.invoice_id.fiscal_position_id
                self.invoice_line_tax_ids = fpos.map_tax(self.account_id.tax_ids).ids
        def _onchange_uom_id(self):
            warning = {}
            result = {}
            if not self.uom_id:
                self.price_unit = 0.0
            if self.product_id and self.uom_id:
                if !=
                    warning = {
                        'title': _('Warning!'),
                        'message': _('The selected unit of measure is not compatible with the unit of measure of the product.'),
                    self.uom_id =
            if warning:
                result['warning'] = warning
            return result
    class AccountInvoiceTax(models.Model):
        _name = ""
        _description = "Invoice Tax"
        _order = 'sequence'
        invoice_id = fields.Many2one('account.invoice', string='Invoice', ondelete='cascade', index=True)
        name = fields.Char(string='Tax Description', required=True)
        tax_id = fields.Many2one('', string='Tax')
        account_id = fields.Many2one('account.account', string='Tax Account', required=True, domain=[('deprecated', '=', False)])
        account_analytic_id = fields.Many2one('account.analytic.account', string='Analytic account')
        amount = fields.Monetary()
        manual = fields.Boolean(default=True)
        sequence = fields.Integer(help="Gives the sequence order when displaying a list of invoice tax.")
        company_id = fields.Many2one('', string='Company', related='account_id.company_id', store=True, readonly=True)
        currency_id = fields.Many2one('res.currency', related='invoice_id.currency_id', store=True, readonly=True)
    class AccountPaymentTerm(models.Model):
        _name = "account.payment.term"
        _description = "Payment Term"
        _order = "name"
        def _default_line_ids(self):
            return [(0, 0, {'value': 'balance', 'value_amount': 0.0, 'sequence': 9, 'days': 0, 'option': 'day_after_invoice_date'})]
        name = fields.Char(string='Payment Term', translate=True, required=True)
        active = fields.Boolean(default=True, help="If the active field is set to False, it will allow you to hide the payment term without removing it.")
        note = fields.Text(string='Description on the Invoice', translate=True)
        line_ids = fields.One2many('account.payment.term.line', 'payment_id', string='Terms', copy=True, default=_default_line_ids)
        company_id = fields.Many2one('', string='Company', required=True, default=lambda self: self.env.user.company_id)
        def _check_lines(self):
            payment_term_lines = self.line_ids.sorted()
            if payment_term_lines and payment_term_lines[-1].value != 'balance':
                raise ValidationError(_('A Payment Term should have its last line of type Balance.'))
            lines = self.line_ids.filtered(lambda r: r.value == 'balance')
            if len(lines) > 1:
                raise ValidationError(_('A Payment Term should have only one line of type Balance.'))
        def compute(self, value, date_ref=False):
            date_ref = date_ref or
            amount = value
            result = []
            prec = self.company_id.currency_id.decimal_places
            for line in self.line_ids:
                if line.value == 'fixed':
                    amt = round(line.value_amount, prec)
                elif line.value == 'percent':
                    amt = round(value * (line.value_amount / 100.0), prec)
                elif line.value == 'balance':
                    amt = round(amount, prec)
                if amt:
                    next_date = fields.Date.from_string(date_ref)
                    if line.option == 'day_after_invoice_date':
                        next_date += relativedelta(days=line.days)
                    elif line.option == 'fix_day_following_month':
                        next_first_date = next_date + relativedelta(day=1, months=1)  # Getting 1st of next month
                        next_date = next_first_date + relativedelta(days=line.days - 1)
                    elif line.option == 'last_day_following_month':
                        next_date += relativedelta(day=31, months=1)  # Getting last day of next month
                    elif line.option == 'last_day_current_month':
                        next_date += relativedelta(day=31, months=0)  # Getting last day of next month
                    result.append((fields.Date.to_string(next_date), amt))
                    amount -= amt
            amount = reduce(lambda x, y: x + y[1], result, 0.0)
            dist = round(value - amount, prec)
            if dist:
                last_date = result and result[-1][0] or
                result.append((last_date, dist))
            return result
    class AccountPaymentTermLine(models.Model):
        _name = "account.payment.term.line"
        _description = "Payment Term Line"
        _order = "sequence"
        value = fields.Selection([
                ('balance', 'Balance'),
                ('percent', 'Percent'),
                ('fixed', 'Fixed Amount')
            ], string='Type', required=True, default='balance',
            help="Select here the kind of valuation related to this payment term line.")
        value_amount = fields.Float(string='Value', digits=dp.get_precision('Payment Term'), help="For percent enter a ratio between 0-100.")
        days = fields.Integer(string='Number of Days', required=True, default=0)
        option = fields.Se

 0 Comment(s)

Sign In

Sign up using

Forgot Password
Fill out the form below and instructions to reset your password will be emailed to you:
Reset Password
Fill out the form below and reset your password: