[IMP] account: hooks to extend grouping rules on payments

This will allow to define a specific grouping rule for ISR payments

In case of Swiss ISR payments must not be grouped as we want to keep a single transaction
per reference. The ISR payment reference doesn't imply additionnal fees from
the bank.

One transaction per ISR reference is needed in Swiss SEPA payments
to ensure a end-to-end flow that will ease the reconciliation on
the other end.

When ISR reference is detected we also avoid to concatenate the references
to not concatenate the same reference multiple times. In case the
same reference is sent by the supplier on different dates.

Without those hooks it will be very difficult to implement.

Backport from PR 45744

closes odoo/odoo#50548

X-original-commit: 965c0a3e38f8113a10cba20e130c0ae7f6a38cbc
Signed-off-by: oco-odoo <oco-odoo@users.noreply.github.com>

addons/account/models/account_payment.py

@@ -786,6 +786,12 @@ class payment_register(models.TransientModel):
             return {'domain': {'payment_method_id': domain_payment, 'journal_id': domain_journal}}
         return {}
 
+    def _prepare_communication(self, invoices):
+        '''Define the value for communication field
+        Append all invoice's references together.
+        '''
+        " ".join(i.invoice_payment_ref or i.ref or i.name for i in invoices)
+
     def _prepare_payment_vals(self, invoices):
         '''Create the payment values.
 
@@ -799,7 +805,7 @@ class payment_register(models.TransientModel):
             'journal_id': self.journal_id.id,
             'payment_method_id': self.payment_method_id.id,
             'payment_date': self.payment_date,
-            'communication': " ".join(i.invoice_payment_ref or i.ref or i.name for i in invoices),
+            'communication': self._prepare_communication(invoices),
             'invoice_ids': [(6, 0, invoices.ids)],
             'payment_type': ('inbound' if amount > 0 else 'outbound'),
             'amount': abs(amount),
@@ -810,6 +816,12 @@ class payment_register(models.TransientModel):
         }
         return values
 
+    def _get_payment_group_key(self, invoice):
+        """ Returns the grouping key to use for the given invoice when group_payment
+        option has been ticked in the wizard.
+        """
+        return (invoice.commercial_partner_id, invoice.currency_id, invoice.invoice_partner_bank_id, MAP_INVOICE_TYPE_PARTNER_TYPE[invoice.type])
+
     def get_payments_vals(self):
         '''Compute the values for payments.
 
@@ -818,7 +830,7 @@ class payment_register(models.TransientModel):
         grouped = defaultdict(lambda: self.env["account.move"])
         for inv in self.invoice_ids:
             if self.group_payment:
-                grouped[(inv.commercial_partner_id, inv.currency_id, inv.invoice_partner_bank_id, MAP_INVOICE_TYPE_PARTNER_TYPE[inv.type])] += inv
+                grouped[self._get_payment_group_key(inv)] += inv
             else:
                 grouped[inv.id] += inv
         return [self._prepare_payment_vals(invoices) for invoices in grouped.values()]