[17.0][ADD] product_margin_report_sale_margin

product_margin_report_sale_margin/README.rst

@@ -0,0 +1,123 @@
+==========================
+Product report sale margin
+==========================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:5b02242f5dbe90213a92d0d2632daa7f4c6b7553a8057302a5ab4f1f79657f90
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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%2Fmargin--analysis-lightgray.png?logo=github
+    :target: https://github.com/OCA/margin-analysis/tree/17.0/product_margin_report_sale_margin
+    :alt: OCA/margin-analysis
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/margin-analysis-17-0/margin-analysis-17-0-product_margin_report_sale_margin
+    :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/margin-analysis&target_branch=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module adds 2 new fields to the Product Margins report: Sales
+margin and Sales margin rate.
+
+The report's Total Margin compares every sale with every purchase
+invoiced in the selected period, so purchases of units not yet sold also
+reduce it. For example, if 100 units were purchased but only 10 have
+been sold, the Total Margin can be negative. The Sales margin only
+charges the cost of the units invoiced to customers, valued at the
+average purchase price of the period.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+Sales margin fields
+-------------------
+
+1. Go to *Invoicing* > *Reporting* -> Product Margins
+
+2. Select the values you want to filter by.
+
+3. Click on the *Open margins* button.
+
+4. When the new view is displayed, the two new fields are visible;
+   similarly, if you select an element, they will be visible in the form
+   view.
+
+   |FIELDS_VIEW_TREE|
+
+   |FIELDS_VIEW_FORM|
+
+Field calculations
+------------------
+
+- Sales margin = Turnover - (# Invoiced in Sale \* Avg. Unit Price
+  [Purchases])
+- Sales margin rate = (Sales margin \* 100) / Turnover
+
+Avg. Unit Price [Purchases] is the average unit price of the vendor
+bills invoiced in the selected period, as computed by the Product
+Margins report. Sales margin is therefore an estimate based on purchase
+invoices, not the actual cost of goods sold from stock valuation. When
+the product has no vendor bills matching the report filters, that
+average is 0 and the sales margin equals the turnover.
+
+.. |FIELDS_VIEW_TREE| image:: https://raw.githubusercontent.com/OCA/margin-analysis/17.0/product_margin_report_sale_margin/static/img/readme/FIELDS_VIEW_TREE.png
+.. |FIELDS_VIEW_FORM| image:: https://raw.githubusercontent.com/OCA/margin-analysis/17.0/product_margin_report_sale_margin/static/img/readme/FIELDS_VIEW_FORM.png
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/margin-analysis/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/margin-analysis/issues/new?body=module:%20product_margin_report_sale_margin%0Aversion:%2017.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
+-------
+
+* Binhex
+
+Contributors
+------------
+
+- [Binhex Cloud] (https://www.binhex.cloud):
+
+  - Edilio Escalona Almira e.escalona@binhex.cloud
+
+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/margin-analysis <https://github.com/OCA/margin-analysis/tree/17.0/product_margin_report_sale_margin>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

product_margin_report_sale_margin/__init__.py

@@ -0,0 +1,4 @@
+# Copyright 2025 Binhex <https://www.binhex.cloud>
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from . import models

product_margin_report_sale_margin/__manifest__.py

@@ -0,0 +1,15 @@
+# Copyright 2025 Binhex <https://www.binhex.cloud>
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Product report sale margin",
+    "summary": """Add new fields for sales margin in the Product Margins report.""",
+    "version": "17.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "Binhex,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/margin-analysis",
+    "depends": [
+        "product_margin",
+    ],
+    "data": ["views/product_product_views.xml"],
+}

product_margin_report_sale_margin/models/__init__.py

@@ -0,0 +1,5 @@
+# Copyright 2025 Binhex <https://www.binhex.cloud>
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+
+from . import product_product

product_margin_report_sale_margin/models/product_product.py

@@ -0,0 +1,25 @@
+# Copyright 2025 Binhex <https://www.binhex.cloud>
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class ProductProduct(models.Model):
+    _inherit = "product.product"
+
+    sales_margin = fields.Float(compute="_compute_product_margin_fields_values")
+    sales_margin_rate = fields.Float(compute="_compute_product_margin_fields_values")
+
+    def _compute_product_margin_fields_values(self):
+        res = super()._compute_product_margin_fields_values()
+        for product in self:
+            product_values = res[product.id]
+            product_values["sales_margin"] = product_values["turnover"] - (
+                product_values["sale_num_invoiced"]
+                * product_values["purchase_avg_price"]
+            )
+            product_values["sales_margin_rate"] = (
+                product_values["sales_margin"] * 100
+            ) / (product_values["turnover"] or 1)
+            product.update(res[product.id])
+        return res

product_margin_report_sale_margin/pyproject.toml

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

product_margin_report_sale_margin/readme/CONTRIBUTORS.md

@@ -0,0 +1,2 @@
+- [Binhex Cloud] (https://www.binhex.cloud):
+  - Edilio Escalona Almira <e.escalona@binhex.cloud>

product_margin_report_sale_margin/readme/DESCRIPTION.md

@@ -0,0 +1,9 @@
+This module adds 2 new fields to the Product Margins report: Sales margin
+and Sales margin rate.
+
+The report's Total Margin compares every sale with every purchase invoiced
+in the selected period, so purchases of units not yet sold also reduce it.
+For example, if 100 units were purchased but only 10 have been sold, the
+Total Margin can be negative. The Sales margin only charges the cost of the
+units invoiced to customers, valued at the average purchase price of the
+period.

product_margin_report_sale_margin/readme/USAGE.md

@@ -0,0 +1,25 @@
+Sales margin fields
+------------------
+
+1. Go to *Invoicing* > *Reporting* -> Product Margins
+2. Select the values you want to filter by.
+3. Click on the *Open margins* button.
+4. When the new view is displayed, the two new fields are visible; similarly,
+   if you select an element, they will be visible in the form view.
+
+     ![FIELDS_VIEW_TREE](../static/img/readme/FIELDS_VIEW_TREE.png)
+
+     ![FIELDS_VIEW_FORM](../static/img/readme/FIELDS_VIEW_FORM.png)
+
+
+Field calculations
+------------------
+* Sales margin = Turnover - (# Invoiced in Sale * Avg. Unit Price [Purchases])
+* Sales margin rate = (Sales margin * 100) / Turnover
+
+Avg. Unit Price [Purchases] is the average unit price of the vendor bills
+invoiced in the selected period, as computed by the Product Margins report.
+Sales margin is therefore an estimate based on purchase invoices, not the
+actual cost of goods sold from stock valuation. When the product has no
+vendor bills matching the report filters, that average is 0 and the sales
+margin equals the turnover.