[IMP] account_payment_mode_auto_reconcile: Allows to reconcile with same payment mode

Author: rousseldenis

account_payment_mode_auto_reconcile/README.rst

@@ -2,10 +2,13 @@
 Account Payment Mode Auto Reconcile
 ===================================
 
-.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:902d568e59e5a39571d93111bf87a096fdc41ff0866a796d2a15b339d3b0fc85
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
     :target: https://odoo-community.org/page/development-status
@@ -20,10 +23,10 @@ Account Payment Mode Auto Reconcile
     :target: https://translation.odoo-community.org/projects/account-reconcile-16-0/account-reconcile-16-0-account_payment_mode_auto_reconcile
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/webui/builds.html?repo=OCA/account-reconcile&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/account-reconcile&target_branch=16.0
     :alt: Try me on Runboat
 
-|badge1| |badge2| |badge3| |badge4| |badge5| 
+|badge1| |badge2| |badge3| |badge4| |badge5|
 
 This module adds a checkbox `auto_reconcile_outstanding_credits` on account
 payment modes to allow automatic reconciliation on account invoices if it is
@@ -47,7 +50,7 @@ Bug Tracker
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/account-reconcile/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
-If you spotted it first, help us smashing it by providing a detailed and welcomed
+If you spotted it first, help us to smash it by providing a detailed and welcomed
 `feedback <https://github.com/OCA/account-reconcile/issues/new?body=module:%20account_payment_mode_auto_reconcile%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.

account_payment_mode_auto_reconcile/models/account_move.py

@@ -3,6 +3,7 @@
 from operator import itemgetter
 
 from odoo import _, api, fields, models
+from odoo.osv.expression import AND
 
 
 class AccountMove(models.Model):
@@ -62,6 +63,35 @@ def write(self, vals):
                     invoice.auto_unreconcile_credits()
         return res
 
+    def _get_auto_reconcile_credits_domain(self, credits_dict) -> list:
+        """
+        Get the domain to filter outstanding credit lines
+
+        Depends on:
+
+            - auto_reconcile_same_journal
+            - auto_reconcile_same_payment_mode
+
+        Override this to add some filter criteria
+        """
+        self.ensure_one()
+        line_ids = [credit["id"] for credit in credits_dict]
+        domain = [("id", "in", line_ids)]
+        if self.payment_mode_id.auto_reconcile_same_journal:
+            domain = AND([domain, [("journal_id", "=", self.journal_id.id)]])
+        if self.payment_mode_id.auto_reconcile_same_payment_mode:
+            domain = AND(
+                [
+                    domain,
+                    [
+                        "|",
+                        ("payment_mode_id", "=", False),
+                        ("payment_mode_id", "=", self.payment_mode_id.id),
+                    ],
+                ]
+            )
+        return domain
+
     def auto_reconcile_credits(self, partial_allowed=True):
         for invoice in self:
             invoice._compute_payments_widget_to_reconcile_info()
@@ -72,8 +102,7 @@ def auto_reconcile_credits(self, partial_allowed=True):
             # Get outstanding credits in chronological order
             # (using reverse because aml is sorted by date desc as default)
             credits_dict = credits_info.get("content", False)
-            if invoice.payment_mode_id.auto_reconcile_same_journal:
-                credits_dict = invoice._filter_payment_same_journal(credits_dict)
+            credits_dict = self._get_auto_reconcile_credit_lines(credits_dict)
             sorted_credits = self._sort_credits_dict(credits_dict)
             for credit in sorted_credits:
                 if (
@@ -88,12 +117,9 @@ def _sort_credits_dict(self, credits_dict):
         """Sort credits dict according to their id (oldest recs first)"""
         return sorted(credits_dict, key=itemgetter("id"))
 
-    def _filter_payment_same_journal(self, credits_dict):
-        """Keep only credits on the same journal than the invoice."""
-        self.ensure_one()
-        line_ids = [credit["id"] for credit in credits_dict]
+    def _get_auto_reconcile_credit_lines(self, credits_dict):
         lines = self.env["account.move.line"].search(
-            [("id", "in", line_ids), ("journal_id", "=", self.journal_id.id)]
+            self._get_auto_reconcile_credits_domain(credits_dict=credits_dict)
         )
         return [credit for credit in credits_dict if credit["id"] in lines.ids]
 

account_payment_mode_auto_reconcile/models/account_payment_mode.py

@@ -23,3 +23,8 @@ class AccountPaymentMode(models.Model):
         string="Only same journal",
         help="Only reconcile payment in the same journal than the invoice",
     )
+    auto_reconcile_same_payment_mode = fields.Boolean(
+        string="Only same payment mode",
+        help="Only reconcile counterparts that have the same payment mode "
+        "(e.g. Credit notes) if defined.",
+    )

account_payment_mode_auto_reconcile/static/description/index.html

@@ -1,20 +1,19 @@
-<?xml version="1.0" encoding="utf-8" ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
 <title>Account Payment Mode Auto Reconcile</title>
 <style type="text/css">
 
 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
 
-See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
 */
 
@@ -366,8 +365,10 @@ <h1 class="title">Account Payment Mode Auto Reconcile</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! source digest: sha256:902d568e59e5a39571d93111bf87a096fdc41ff0866a796d2a15b339d3b0fc85
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/account-reconcile/tree/16.0/account_payment_mode_auto_reconcile"><img alt="OCA/account-reconcile" src="https://img.shields.io/badge/github-OCA%2Faccount--reconcile-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/account-reconcile-16-0/account-reconcile-16-0-account_payment_mode_auto_reconcile"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runboat.odoo-community.org/webui/builds.html?repo=OCA/account-reconcile&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/account-reconcile/tree/16.0/account_payment_mode_auto_reconcile"><img alt="OCA/account-reconcile" src="https://img.shields.io/badge/github-OCA%2Faccount--reconcile-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/account-reconcile-16-0/account-reconcile-16-0-account_payment_mode_auto_reconcile"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/account-reconcile&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module adds a checkbox <cite>auto_reconcile_outstanding_credits</cite> on account
 payment modes to allow automatic reconciliation on account invoices if it is
 checked.</p>
@@ -380,39 +381,39 @@ <h1 class="title">Account Payment Mode Auto Reconcile</h1>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#bug-tracker" id="id1">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="id2">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="id3">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="id4">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="id5">Maintainers</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-4">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-5">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#id1">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/account-reconcile/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
-If you spotted it first, help us smashing it by providing a detailed and welcomed
+If you spotted it first, help us to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/OCA/account-reconcile/issues/new?body=module:%20account_payment_mode_auto_reconcile%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h1><a class="toc-backref" href="#id2">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#id3">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-3">Authors</a></h2>
 <ul class="simple">
 <li>Camptocamp</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#id4">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
 <ul class="simple">
 <li>Akim Juillerat &lt;<a class="reference external" href="mailto:akim.juillerat&#64;camptocamp.com">akim.juillerat&#64;camptocamp.com</a>&gt;</li>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#id5">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose

account_payment_mode_auto_reconcile/tests/test_partner_auto_reconcile.py

@@ -297,3 +297,87 @@ def test_invoice_auto_reconcile_different_journal(self):
         self.assertTrue(self.payment_mode.auto_reconcile_outstanding_credits)
         self.assertEqual(self.invoice_copy.amount_residual, 1725.0)
         self.assertEqual(auto_rec_invoice.amount_residual, 1150.0)
+
+    def test_invoice_auto_reconcile_same_journal_different_method(self):
+        """
+        Create an invoice with a different partner
+        Create a credit note with a different payment mode for that partner
+
+        Validate the credit note
+        Validate the invoice
+
+        Check that the credit note has not been reconciled with invoice
+        """
+        self.payment_mode.auto_reconcile_same_journal = True
+        self.payment_mode.auto_reconcile_same_payment_mode = True
+
+        partner = self.env["res.partner"].create(
+            {
+                "name": "Partner no reconcile",
+            }
+        )
+
+        invoice = self.invoice.copy(
+            {
+                "payment_mode_id": self.payment_mode.id,
+                "journal_id": self.sale_journal.id,
+                "partner_id": partner.id,
+            }
+        )
+
+        credit_note = self.invoice.copy(
+            {
+                "move_type": "out_refund",
+                "payment_mode_id": self.env.ref(
+                    "account_payment_mode.payment_mode_inbound_ct2"
+                ).id,
+                "journal_id": self.sale_journal.id,
+                "partner_id": partner.id,
+            }
+        )
+
+        credit_note.action_post()
+        invoice.action_post()
+        self.assertTrue(self.payment_mode.auto_reconcile_outstanding_credits)
+        self.assertEqual(invoice.amount_residual, 1150.0)
+
+    def test_invoice_auto_reconcile_same_journal_same_method(self):
+        """
+        Create an invoice with a different partner
+        Create a credit note with a same payment mode for that partner
+
+        Validate the credit note
+        Validate the invoice
+
+        Check that the credit note has been reconciled with invoice
+        """
+        self.payment_mode.auto_reconcile_same_journal = True
+        self.payment_mode.auto_reconcile_same_payment_mode = True
+
+        partner = self.env["res.partner"].create(
+            {
+                "name": "Partner no reconcile",
+            }
+        )
+
+        invoice = self.invoice.copy(
+            {
+                "payment_mode_id": self.payment_mode.id,
+                "journal_id": self.sale_journal.id,
+                "partner_id": partner.id,
+            }
+        )
+
+        credit_note = self.invoice.copy(
+            {
+                "move_type": "out_refund",
+                "payment_mode_id": self.payment_mode.id,
+                "journal_id": self.sale_journal.id,
+                "partner_id": partner.id,
+            }
+        )
+
+        credit_note.action_post()
+        invoice.action_post()
+        self.assertTrue(self.payment_mode.auto_reconcile_outstanding_credits)
+        self.assertEqual(invoice.amount_residual, 0.0)

account_payment_mode_auto_reconcile/views/account_payment_mode.xml

@@ -19,6 +19,10 @@
                         name="auto_reconcile_same_journal"
                         attrs="{'invisible': [('auto_reconcile_outstanding_credits', '=', False)]}"
                     />
+                    <field
+                        name="auto_reconcile_same_payment_mode"
+                        attrs="{'invisible': [('auto_reconcile_outstanding_credits', '=', False)]}"
+                    />
                 </group>
             </group>
         </field>