[ADD] purchase_budget_oca_validation

Author: cvinh

purchase_budget_oca_validation/README.rst

@@ -0,0 +1,71 @@
+==========================
+Purchase Budget Validation
+==========================
+
+.. |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-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+
+|badge1| |badge2| 
+
+This module checks the purchase order lines amount against their related budgets and
+prevents you from going over budget.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+* Create a budget with either a budgetary position, an analytic account or analytic tag
+* Confirm it
+
+Usage
+=====
+
+* Create a purchase order and select a product, analytic account or tag that matches one of your budget lines.
+* Check for message in the chatter if you are over a budget.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/ursais/14.0/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
+`feedback <https://github.com/ursais/14.0/issues/new?body=module:%20purchase_budget_validation%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Open Source Integrators
+* Serpent Consulting Services
+
+Contributors
+~~~~~~~~~~~~
+
+* Maxime Chambreuil <mchambreuil@opensourceintegrators.com>
+* Hardik Suthar <hsuthar@opensourceintegrators.com>
+
+Other credits
+~~~~~~~~~~~~~
+
+The development of this module has been financially supported by:
+
+* Casai
+
+Maintainers
+~~~~~~~~~~~
+
+.. |maintainer-max3903| image:: https://github.com/max3903.png?size=40px
+    :target: https://github.com/max3903
+    :alt: max3903
+
+|maintainer-max3903|

purchase_budget_oca_validation/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (c) 2022 Open Source Integrators
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+from . import models

purchase_budget_oca_validation/__manifest__.py

@@ -0,0 +1,20 @@
+# Copyright (c) 2022 Open Source Integrators
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+{
+    "name": "Purchase Budget OCA Validation",
+    "version": "14.0.1.0.0",
+    "author": "Open Source Integrators, Odoo Community Association (OCA)",
+    "summary": "Check purchase orders against budgets",
+    "license": "AGPL-3",
+    "category": "Purchase",
+    "maintainer": "Open Source Integrators",
+    "website": "https://github.com/OCA/account-budgeting",
+    "depends": ["purchase", "account_budget_oca_analytic_tag"],
+    "installable": True,
+    "maintainers": ["max3903"],
+    "development_status": "Beta",
+    "data": [
+        "views/crossovered_budget_lines_view.xml",
+        "views/purchase_order_view.xml",
+    ],
+}

purchase_budget_oca_validation/models/__init__.py

@@ -0,0 +1,6 @@
+# Copyright (c) 2022 Open Source Integrators
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+from . import crossovered_budget
+from . import crossovered_budget_lines
+from . import purchase_order
+from . import purchase_order_line

purchase_budget_oca_validation/models/crossovered_budget.py

@@ -0,0 +1,11 @@
+# Copyright (c) 2022 Open Source Integrators
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+from odoo import fields, models
+
+
+class CrossoveredBudget(models.Model):
+    _inherit = "crossovered.budget"
+
+    amount_include_tax = fields.Boolean(
+        "Include Taxes in Amount", default=False, copy=False
+    )

purchase_budget_oca_validation/models/crossovered_budget_lines.py

@@ -0,0 +1,92 @@
+# Copyright (c) 2022 Open Source Integrators
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+from odoo import fields, models
+
+
+class CrossoveredBudgetLines(models.Model):
+    _inherit = "crossovered.budget.lines"
+
+    committed_amount = fields.Float(
+        compute="_compute_committ_uncommitt_amount", string="Committed Amount"
+    )
+    uncommitted_amount = fields.Float(
+        compute="_compute_committ_uncommitt_amount", string="Uncommitted Amount"
+    )
+    over_budget = fields.Boolean(compute="_compute_over_budget", string="Over Budget")
+
+    def _compute_committ_uncommitt_amount(self):
+        purchase_line_obj = self.env["purchase.order.line"]
+        for budget_line in self:
+            commit_domain = [
+                ("date_order", ">=", budget_line.date_from),
+                ("date_order", "<=", budget_line.date_to),
+                ("order_id.state", "in", ("purchase", "done")),
+                "|",
+                ("account_analytic_id", "=", budget_line.analytic_account_id.id),
+                ("analytic_tag_ids", "in", budget_line.analytic_tag_id.ids),
+                "|",
+                (
+                    "product_id.property_account_expense_id",
+                    "in",
+                    budget_line.general_budget_id.account_ids.ids,
+                ),
+                (
+                    "product_id.categ_id.property_account_expense_categ_id",
+                    "in",
+                    budget_line.general_budget_id.account_ids.ids,
+                ),
+            ]
+            po_lines_commimt = purchase_line_obj.search(commit_domain)
+            if budget_line.crossovered_budget_id.amount_include_tax:
+                budget_line.committed_amount = -sum(
+                    [
+                        line.price_unit * (line.product_qty - line.qty_invoiced)
+                        + line.price_tax
+                        for line in po_lines_commimt
+                    ]
+                )
+            else:
+                budget_line.committed_amount = -sum(
+                    [
+                        line.price_unit * (line.product_qty - line.qty_invoiced)
+                        for line in po_lines_commimt
+                    ]
+                )
+            uncommit_domain = [
+                ("date_order", ">=", budget_line.date_from),
+                ("date_order", "<=", budget_line.date_to),
+                ("order_id.state", "not in", ("purchase", "done", "cancel")),
+                "|",
+                ("account_analytic_id", "=", budget_line.analytic_account_id.id),
+                ("analytic_tag_ids", "in", budget_line.analytic_tag_id.ids),
+                "|",
+                (
+                    "product_id.property_account_expense_id",
+                    "in",
+                    budget_line.general_budget_id.account_ids.ids,
+                ),
+                (
+                    "product_id.categ_id.property_account_expense_categ_id",
+                    "in",
+                    budget_line.general_budget_id.account_ids.ids,
+                ),
+            ]
+            po_lines_uncommit = purchase_line_obj.search(uncommit_domain)
+            if budget_line.crossovered_budget_id.amount_include_tax:
+                budget_line.uncommitted_amount = -sum(
+                    [line.price_subtotal + line.price_tax for line in po_lines_uncommit]
+                )
+            else:
+                budget_line.uncommitted_amount = -sum(
+                    [line.price_subtotal for line in po_lines_uncommit]
+                )
+
+    def _compute_over_budget(self):
+        for rec in self:
+            rec.over_budget = False
+            if (
+                abs(rec.practical_amount)
+                + abs(rec.committed_amount)
+                + abs(rec.uncommitted_amount)
+            ) > abs(rec.planned_amount):
+                rec.over_budget = True

purchase_budget_oca_validation/models/purchase_order.py

@@ -0,0 +1,74 @@
+# Copyright (c) 2022 Open Source Integrators
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from odoo import _, api, fields, models
+from odoo.exceptions import ValidationError
+
+
+class PurchaseOrder(models.Model):
+    _inherit = "purchase.order"
+
+    over_budget = fields.Boolean(
+        compute="_compute_over_budget_po", string="Over Budget"
+    )
+
+    def _compute_over_budget_po(self):
+        for rec in self:
+            rec.over_budget = rec.check_budget(notify=False)
+
+    def check_budget(self, notify=False):
+        message = ""
+        users = self.env["res.users"]
+        over_budget = False
+        for po_line in self.order_line:
+            budget_lines = po_line._get_budget_lines()
+            for b_line in budget_lines:
+                if b_line.over_budget:
+                    users += b_line.crossovered_budget_id.creating_user_id
+                    message += _(
+                        "This order is over budget %s / %s (%s):"
+                        "<br/>%s + %s + %s = %s > %s.<br/>"
+                        % (
+                            b_line.crossovered_budget_id.name,
+                            b_line.general_budget_id.name,
+                            b_line.crossovered_budget_id.creating_user_id.name,
+                            abs(b_line.uncommitted_amount),
+                            abs(b_line.committed_amount),
+                            abs(b_line.practical_amount),
+                            abs(b_line.practical_amount)
+                            + abs(b_line.committed_amount)
+                            + abs(b_line.uncommitted_amount),
+                            abs(b_line.planned_amount),
+                        )
+                    )
+        if message:
+            over_budget = True
+        if notify:
+            self.message_subscribe(partner_ids=users.partner_id.ids)
+            self.message_post(body=message)
+        return over_budget
+
+    def button_confirm(self):
+        for rec in self:
+            if rec.over_budget:
+                raise ValidationError(
+                    _(
+                        "You cannot confirm the purchase order "
+                        "as one budget would go over the planned amount. "
+                        "Please check the chatter for more details."
+                    )
+                )
+            else:
+                super(PurchaseOrder, rec).button_confirm()
+
+    @api.model
+    def create(self, vals):
+        res = super().create(vals)
+        res.check_budget(notify=True)
+        return res
+
+    def write(self, vals):
+        res = super().write(vals)
+        for po in self:
+            po.check_budget(notify=True)
+        return res

purchase_budget_oca_validation/models/purchase_order_line.py

@@ -0,0 +1,30 @@
+# Copyright (c) 2022 Open Source Integrators
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+from odoo import models
+
+
+class PurchaseOrderLine(models.Model):
+    _inherit = "purchase.order.line"
+
+    def _get_budget_lines(self):
+        return self.env["crossovered.budget.lines"].search(
+            [
+                ("date_from", "<=", self.date_order),
+                ("date_to", ">=", self.date_order),
+                ("crossovered_budget_id.state", "=", "validate"),
+                "|",
+                ("analytic_account_id", "=", self.account_analytic_id.id),
+                ("analytic_tag_id", "in", self.analytic_tag_ids.ids),
+                "|",
+                (
+                    "general_budget_id.account_ids",
+                    "in",
+                    self.product_id.property_account_expense_id.ids,
+                ),
+                (
+                    "general_budget_id.account_ids",
+                    "in",
+                    self.product_id.categ_id.property_account_expense_categ_id.ids,
+                ),
+            ]
+        )

purchase_budget_oca_validation/static/description/icon.png

@@ -0,0 +1,3 @@
+# Copyright (C) 2022 Open Source Integrators (https://www.opensourceintegrators.com)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+from . import test_purchase_budget_validation