odoo-addon-account-dashboard-banner 16.0.1.0.1.1__py3-none-any.whl

odoo/addons/account_dashboard_banner/models/account_dashboard_banner_cell.py

@@ -0,0 +1,331 @@
+# Copyright 2025 Akretion France (https://www.akretion.com/)
+# @author: Alexis de Lattre <alexis.delattre@akretion.com>
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from dateutil.relativedelta import relativedelta
+
+from odoo import _, api, fields, models
+from odoo.exceptions import ValidationError
+from odoo.tools import date_utils
+from odoo.tools.misc import format_amount, format_date
+
+
+class AccountDashboardBannerCell(models.Model):
+    _name = "account.dashboard.banner.cell"
+    _description = "Accounting Dashboard Banner Cell"
+    _order = "sequence, id"
+
+    sequence = fields.Integer()
+    cell_type = fields.Selection(
+        [
+            ("income_fiscalyear", "Fiscal Year-to-date Income"),
+            ("income_year", "Year-to-date Income"),
+            ("income_quarter", "Quarter-to-date Income"),
+            ("income_month", "Month-to-date Income"),
+            ("liquidity", "Liquidity"),
+            ("customer_debt", "Customer Debt"),
+            ("customer_overdue", "Customer Overdue"),
+            ("supplier_debt", "Supplier Debt"),
+            # for lock dates, the key matches exactly the field name on res.company
+            ("tax_lock_date", "Tax Return Lock Date"),
+            ("period_lock_date", "Journals Entries Lock Date"),
+            ("fiscalyear_lock_date", "All Users Lock Date"),
+        ],
+        required=True,
+    )
+    custom_label = fields.Char()
+    custom_tooltip = fields.Char()
+    warn = fields.Boolean(string="Warning")
+    warn_lock_date_days = fields.Integer(
+        compute="_compute_warn_fields", store=True, readonly=False, precompute=True
+    )
+    warn_min = fields.Float(string="Minimum")
+    warn_max = fields.Float(string="Maximum")
+    warn_type_show = fields.Boolean(
+        compute="_compute_warn_fields", store=True, precompute=True
+    )
+    warn_type = fields.Selection(
+        [
+            ("under", "Under Minimum"),
+            ("above", "Above Maximum"),
+            ("outside", "Under Minimum or Above Maximum"),
+            ("inside", "Between Minimum and Maximum"),
+        ],
+        default="under",
+    )
+
+    _sql_constraints = [
+        (
+            "warn_lock_date_days_positive",
+            "CHECK(warn_lock_date_days >= 0)",
+            "Warn if lock date is older than N days must be positive or null.",
+        )
+    ]
+
+    @api.constrains("warn_min", "warn_max", "warn_type", "warn", "cell_type")
+    def _check_warn_config(self):
+        for cell in self:
+            if (
+                cell.cell_type
+                and not cell.cell_type.endswith("_lock_date")
+                and cell.warn
+                and cell.warn_type in ("outside", "inside")
+                and cell.warn_max <= cell.warn_min
+            ):
+                cell_type2label = dict(
+                    self.fields_get("cell_type", "selection")["cell_type"]["selection"]
+                )
+                raise ValidationError(
+                    _(
+                        "On cell '%(cell_type)s' with warning enabled, "
+                        "the minimum (%(warn_min)s) must be under "
+                        "the maximum (%(warn_max)s).",
+                        cell_type=cell_type2label[cell.cell_type],
+                        warn_min=cell.warn_min,
+                        warn_max=cell.warn_max,
+                    )
+                )
+
+    @api.model
+    def _default_warn_lock_date_days(self, cell_type):
+        defaultmap = {
+            "tax_lock_date": 61,  # 2 months
+            "period_lock_date": 61,  # 2 months
+            "fiscalyear_lock_date": 520,  # FY final closing, 1 year + 5 months
+        }
+        return defaultmap.get(cell_type)
+
+    @api.depends("cell_type", "warn")
+    def _compute_warn_fields(self):
+        for cell in self:
+            warn_type_show = False
+            warn_lock_date_days = 0
+            if cell.cell_type and cell.warn:
+                if cell.cell_type.endswith("_lock_date"):
+                    warn_lock_date_days = self._default_warn_lock_date_days(
+                        cell.cell_type
+                    )
+                else:
+                    warn_type_show = True
+            cell.warn_type_show = warn_type_show
+            cell.warn_lock_date_days = warn_lock_date_days
+
+    @api.model
+    def get_banner_data(self):
+        """This is the method called by the JS code that displays the banner"""
+        company = self.env.company
+        return self._prepare_banner_data(company)
+
+    def _prepare_speedy(self, company):
+        lock_date_fields = [
+            "tax_lock_date",
+            "period_lock_date",
+            "fiscalyear_lock_date",
+        ]
+        speedy = {
+            "cell_type2label": dict(
+                self.fields_get("cell_type", "selection")["cell_type"]["selection"]
+            ),
+            "lock_date2help": {
+                key: value["help"]
+                for (key, value) in company.fields_get(lock_date_fields, "help").items()
+            },
+            "today": fields.Date.context_today(self),
+        }
+        return speedy
+
+    @api.model
+    def _prepare_banner_data(self, company):
+        # The order in this list will be the display order in the banner
+        # In fact, it's not a list but a dict. I tried to make it work by returning
+        # a list but it seems OWL only accepts dicts (I always get errors on lists)
+        cells = self.search([])
+        speedy = cells._prepare_speedy(company)
+        res = {}
+        seq = 0
+        for cell in cells:
+            seq += 1
+            cell_data = cell._prepare_cell_data(company, speedy)
+            cell._update_cell_warn(cell_data)
+            res[seq] = cell_data
+        # from pprint import pprint
+        # pprint(res)
+        return res
+
+    def _prepare_cell_data_liquidity(self, company, speedy):
+        self.ensure_one()
+        journals = self.env["account.journal"].search(
+            [
+                ("company_id", "=", company.id),
+                ("type", "in", ("bank", "cash", "credit")),
+                ("default_account_id", "!=", False),
+            ]
+        )
+        accounts = journals.default_account_id
+        return (accounts, 1, False, False, False)
+
+    def _prepare_cell_data_supplier_debt(self, company, speedy):
+        accounts = self.env["ir.property"]._get(
+            "property_account_payable_id", "res.partner"
+        )
+        return (accounts, -1, False, False, False)
+
+    def _prepare_cell_data_income(self, company, speedy):
+        cell_type = self.cell_type
+        accounts = self.env["account.account"].search(
+            [
+                ("company_id", "=", company.id),
+                ("account_type", "in", ("income", "income_other")),
+            ]
+        )
+        if cell_type == "income_fiscalyear":
+            start_date, end_date = date_utils.get_fiscal_year(
+                speedy["today"],
+                day=company.fiscalyear_last_day,
+                month=int(company.fiscalyear_last_month),
+            )
+        elif cell_type == "income_month":
+            start_date = speedy["today"] + relativedelta(day=1)
+        elif cell_type == "income_year":
+            start_date = speedy["today"] + relativedelta(day=1, month=1)
+        elif cell_type == "income_quarter":
+            month_start_quarter = 3 * ((speedy["today"].month - 1) // 3) + 1
+            start_date = speedy["today"] + relativedelta(
+                day=1, month=month_start_quarter
+            )
+        specific_domain = [("date", ">=", start_date)]
+        specific_tooltip = _(
+            "Balance of account(s) {account_codes} since %s.",
+            format_date(self.env, start_date),
+        )
+        return (accounts, -1, specific_domain, False, specific_tooltip)
+
+    def _prepare_cell_data_customer_debt(self, company, speedy):
+        accounts = self.env["ir.property"]._get(
+            "property_account_receivable_id", "res.partner"
+        )
+        if (
+            hasattr(company, "account_default_pos_receivable_account_id")
+            and company.account_default_pos_receivable_account_id
+        ):
+            accounts |= company.account_default_pos_receivable_account_id
+        return (accounts, 1, False, False, False)
+
+    def _prepare_cell_data_customer_overdue(self, company, speedy):
+        (
+            accounts,
+            sign,
+            specific_domain,
+            specific_aggregate,
+            specific_tooltip,
+        ) = self._prepare_cell_data_customer_debt(company, speedy)
+        specific_domain = [("date_maturity", "<", speedy["today"])]
+        specific_aggregate = "amount_residual:sum"
+        specific_tooltip = _(
+            "Residual amount of account(s) {account_codes} with due date in the past."
+        )
+        return (accounts, sign, specific_domain, specific_aggregate, specific_tooltip)
+
+    def _prepare_cell_data(self, company, speedy):
+        """Inherit this method to change the computation of a cell type"""
+        self.ensure_one()
+        cell_type = self.cell_type
+        value = raw_value = tooltip = warn = False
+        if cell_type.endswith("lock_date"):
+            raw_value = company[cell_type]
+            value = raw_value and format_date(self.env, raw_value)
+            tooltip = speedy["lock_date2help"][cell_type]
+            if self.warn:
+                if not raw_value:
+                    warn = True
+                elif raw_value < speedy["today"] - relativedelta(
+                    days=self.warn_lock_date_days
+                ):
+                    warn = True
+        else:
+            accounts = False
+            if hasattr(self, f"_prepare_cell_data_{cell_type}"):
+                specific_method = getattr(self, f"_prepare_cell_data_{cell_type}")
+                (
+                    accounts,
+                    sign,
+                    specific_domain,
+                    specific_aggregate,
+                    specific_tooltip,
+                ) = specific_method(company, speedy)
+            elif cell_type.startswith("income_"):
+                (
+                    accounts,
+                    sign,
+                    specific_domain,
+                    specific_aggregate,
+                    specific_tooltip,
+                ) = self._prepare_cell_data_income(company, speedy)
+            if accounts:
+                domain = (specific_domain or []) + [
+                    ("company_id", "=", company.id),
+                    ("account_id", "in", accounts.ids),
+                    ("date", "<=", speedy["today"]),
+                    ("parent_state", "=", "posted"),
+                ]
+                aggregate = specific_aggregate or "balance:sum"
+                rg_res = self.env["account.move.line"]._read_group(
+                    domain, [aggregate], []
+                )
+                assert sign in (1, -1)
+                raw_value = (
+                    rg_res and rg_res[0].get(aggregate.split(":")[0]) or 0
+                ) * sign
+                value = format_amount(self.env, raw_value, company.currency_id)
+                tooltip_src = specific_tooltip or _(
+                    "Balance of account(s) {account_codes}."
+                )
+                tooltip = tooltip_src.format(
+                    account_codes=", ".join(accounts.mapped("code"))
+                )
+        res = {
+            "cell_type": cell_type,
+            "label": self.custom_label or speedy["cell_type2label"][cell_type],
+            "raw_value": raw_value,
+            "value": value or _("None"),
+            "tooltip": self.custom_tooltip or tooltip,
+            "warn": warn,
+        }
+        return res
+
+    def _update_cell_warn(self, cell_data):
+        self.ensure_one()
+        if (
+            not cell_data.get("warn")
+            and self.warn
+            and self.warn_type
+            and isinstance(cell_data["raw_value"], (int | float))
+        ):
+            raw_value = cell_data["raw_value"]
+            if (
+                (self.warn_type == "under" and raw_value < self.warn_min)
+                or (self.warn_type == "above" and raw_value > self.warn_max)
+                or (
+                    self.warn_type == "outside"
+                    and (raw_value < self.warn_min or raw_value > self.warn_max)
+                )
+                or (
+                    self.warn_type == "inside"
+                    and raw_value > self.warn_min
+                    and raw_value < self.warn_max
+                )
+            ):
+                cell_data["warn"] = True
+
+    @api.depends("cell_type", "custom_label")
+    def _compute_display_name(self):
+        type2name = dict(
+            self.fields_get("cell_type", "selection")["cell_type"]["selection"]
+        )
+        for cell in self:
+            display_name = "-"
+            if cell.custom_label:
+                display_name = cell.custom_label
+            elif cell.cell_type:
+                display_name = type2name[cell.cell_type]
+            cell.display_name = display_name

odoo/addons/account_dashboard_banner/post_install.py

@@ -0,0 +1,28 @@
+# Copyright 2025 Akretion France (https://www.akretion.com/)
+# @author: Alexis de Lattre <alexis.delattre@akretion.com>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+# I create default cells via post-install script instead of
+# data/account_dashboard_banner_cell.xml
+# to avoid the problem when a user deletes a cell that has an XMLID
+# and Odoo would re-create the cells when the module is reloaded
+
+from odoo import SUPERUSER_ID, api
+
+
+def create_default_account_dashboard_cells(cr, registry):
+    env = api.Environment(cr, SUPERUSER_ID, {})
+    vals_list = [
+        {"cell_type": "fiscalyear_lock_date", "sequence": 10, "warn": True},
+        {"cell_type": "income_fiscalyear", "sequence": 20},
+        {"cell_type": "customer_overdue", "sequence": 30},
+        {"cell_type": "customer_debt", "sequence": 40},
+        {"cell_type": "supplier_debt", "sequence": 50},
+        {
+            "cell_type": "liquidity",
+            "sequence": 60,
+            "warn": True,
+            "warn_type": "under",
+        },
+    ]
+    env["account.dashboard.banner.cell"].create(vals_list)

odoo/addons/account_dashboard_banner/readme/CONFIGURE.md

@@ -0,0 +1,33 @@
+Go to the menu **Invoicing \> Configuration \> Dashboard \> Dashboard
+Banner Cells**: in this menu, you can add or remove cells from the
+banner, change the cell type, modify the order via drag-and-drop,
+customize the labels if necessary.
+
+![Cell configuration menu](../static/description/banner_cell_config.png)
+
+Many cell types are available:
+
+- **Income** with 4 options: *Fiscal Year-to-date Income*, *Year-to-date
+  Income*, *Quarter-to-date Income* and *Month-to-date Income*. It
+  displays the period balance of the accounts with type *Income* and
+  *Other Income*.
+- **Liquidity**: it display the ending balance of the accounts linked to
+  a bank or cash or credit journal.
+- **Customer Debt**: it displays the ending balance of the default
+  *Account Receivable* and, if the point of sale is installed, the
+  intermediary account used for unidentified customers.
+- **Customer Overdue**: same as the *Customer Debt*, but limited to
+  journal items with a due date in the past.
+- **Supplier Debt**: it displays the ending balance of the default
+  *Account Payable*.
+- **Lock dates**: all the lock dates are available: *Tax Return Lock
+  Date*, *Journals Entries Lock Date* and *All Users Lock Date*.
+
+The module is designed to allow the modification of the computation of
+the different cell types by inheriting the method
+*\_prepare_cell_data_<cell_type>()* or *\_prepare_cell_data()*.
+It is also easy for a developper to add more cell types.
+
+It is possible to display a cell as a warning cell (yellow background color instead of light grey): click on the *Warning* option and customize the conditions to trigger the warning.
+
+![Cell form with warning](../static/description/cell_form_with_warning.png)

odoo/addons/account_dashboard_banner/readme/CONTRIBUTORS.md

@@ -0,0 +1 @@
+- Alexis de Lattre \<<alexis.delattre@akretion.com>\>

odoo/addons/account_dashboard_banner/readme/DESCRIPTION.md

@@ -0,0 +1,13 @@
+The development of this module started with a simple analysis: accountants
+tend to forget to update the lock dates. Part of the problem lies in the
+fact that the lock dates can be seen in the wizard to update the lock
+dates, but accountants have no incentive to start this wizard regularly
+to check the lock dates. The idea was to display the lock dates in a
+banner at the top of the accounting dashboard, so that accountants
+have the value of the lock dates in front of their eyes.
+
+With such a banner in the accounting dashboard to display the lock
+dates, there was a great temptation to display other interesting
+information in that banner, such as some key figures of the accounting:
+liquidity, turnover, customer overdue, etc. It gave birth to the idea to
+have a configurable banner in the accounting dashboard!

odoo/addons/account_dashboard_banner/readme/USAGE.md

@@ -0,0 +1,3 @@
+Enjoy the accounting dashboard with the banner at the top:
+
+![Accounting dashboard with banner](../static/description/account_dashboard_banner.png)

odoo/addons/account_dashboard_banner/security/ir.model.access.csv

@@ -0,0 +1,4 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_account_dashboard_banner_cell_manager,Full access on account.dashboard.banner.cell,model_account_dashboard_banner_cell,account.group_account_manager,1,1,1,1
+access_account_dashboard_banner_cell_user,Read access on account.dashboard.banner.cell,model_account_dashboard_banner_cell,account.group_account_user,1,0,0,0
+access_account_dashboard_banner_cell_auditor,Read access on account.dashboard.banner.cell,model_account_dashboard_banner_cell,account.group_account_readonly,1,0,0,0