[ADD] account_payment_return_revoke_ mandate

account_payment_return_revoke_mandate/README.rst

@@ -0,0 +1,86 @@
+=====================================
+Account Payment Return Revoke Mandate
+=====================================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:25ba2eeb30287a53f7a54aa47cf20c00a33b607dc41e8a3a557cd3808b402056
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Faccount--payment-lightgray.png?logo=github
+    :target: https://github.com/OCA/account-payment/tree/18.0/account_payment_return_revoke_mandate
+    :alt: OCA/account-payment
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/account-payment-18-0/account-payment-18-0-account_payment_return_revoke_mandate
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/account-payment&target_branch=18.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module adds an option on return codes in order to cancel mandates
+associated.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+1. Check 'Revoke mandates' on payment return reasons that should revoke
+   mandates.
+2. When a payment return line is received with such a reason,
+   automatically cancel mandates linked to concerned invoices.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/account-payment/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/account-payment/issues/new?body=module:%20account_payment_return_revoke_mandate%0Aversion:%2018.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.
+
+Credits
+=======
+
+Authors
+-------
+
+* ACSONE SA/NV
+
+Contributors
+------------
+
+- Quentin Groulard <[email protected]>
+- Hughes Damry <[email protected]>
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/account-payment <https://github.com/OCA/account-payment/tree/18.0/account_payment_return_revoke_mandate>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

account_payment_return_revoke_mandate/__init__.py

@@ -0,0 +1 @@
+from . import models

account_payment_return_revoke_mandate/__manifest__.py

@@ -0,0 +1,15 @@
+# Copyright 2020 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Account Payment Return Revoke Mandate",
+    "summary": """
+        This addon adds an option on return codes
+        in order to cancel mandates associated.""",
+    "version": "18.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/account-payment",
+    "depends": ["account_banking_mandate", "account_payment_return"],
+    "installable": True,
+}

account_payment_return_revoke_mandate/models/__init__.py

@@ -0,0 +1,2 @@
+from . import payment_return_reason
+from . import account_move

account_payment_return_revoke_mandate/models/account_move.py

@@ -0,0 +1,38 @@
+# Copyright 2020 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+import logging
+
+from odoo import _, models
+from odoo.exceptions import UserError
+
+_logger = logging.getLogger(__name__)
+
+
+class AccountMoveLine(models.Model):
+    _inherit = "account.move"
+
+    def _payment_returned(self, return_line):
+        res = super()._payment_returned(return_line)
+        if return_line.reason_id.revoke_mandates:
+            self._revoke_mandate(return_line)
+        return res
+
+    def _revoke_mandate(self, return_line):
+        for rec in self:
+            if rec.mandate_id:
+                try:
+                    rec.mandate_id.cancel()
+                    msg = _(
+                        "Mandate revoked in payment return %s",
+                        return_line.return_id.name,
+                    )
+                    rec.mandate_id.message_post(body=msg)
+                except UserError:
+                    # May happen if the mandate is not draft or valid
+                    _logger.error(
+                        "Trying to revoke mandate %s from payment return %s but it"
+                        " has the state %s.",
+                        rec.mandate_id.unique_mandate_reference,
+                        return_line.return_id.name,
+                        rec.mandate_id.state,
+                    )

account_payment_return_revoke_mandate/models/payment_return_reason.py

@@ -0,0 +1,10 @@
+# Copyright 2020 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class PaymentReturnReason(models.Model):
+    _inherit = "payment.return.reason"
+
+    revoke_mandates = fields.Boolean(company_dependent=True)

account_payment_return_revoke_mandate/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

account_payment_return_revoke_mandate/readme/CONTRIBUTORS.md

@@ -0,0 +1,2 @@
+- Quentin Groulard \<[email protected]\>
+- Hughes Damry \<[email protected]\>

account_payment_return_revoke_mandate/readme/DESCRIPTION.md

@@ -0,0 +1,2 @@
+This module adds an option on return codes in order to cancel mandates
+associated.

account_payment_return_revoke_mandate/readme/USAGE.md

@@ -0,0 +1,4 @@
+1.  Check 'Revoke mandates' on payment return reasons that should revoke
+    mandates.
+2.  When a payment return line is received with such a reason,
+    automatically cancel mandates linked to concerned invoices.