diff --git a/mypy.ini b/mypy.ini index 6758a36..53e114f 100644 --- a/mypy.ini +++ b/mypy.ini @@ -3,3 +3,10 @@ # duplicate module name errors when multiple addons include scripts with the # same filename. exclude = .*/migrations/.* + +# Ignore missing imports from Odoo modules +[mypy-odoo.*] +ignore_missing_imports = True + +[mypy-odoo] +ignore_missing_imports = True diff --git a/product_pricelist_total_margin/README.md b/product_pricelist_total_margin/README.md new file mode 100644 index 0000000..bf220a9 --- /dev/null +++ b/product_pricelist_total_margin/README.md @@ -0,0 +1,280 @@ +# Product Pricelist Total Margin + +## Overview + +This module solves the problem of **compounded margins** when using chained pricelists in Odoo. By default, Odoo applies each pricelist rule's margin on top of the previous result, leading to compounded percentages. This module provides an option to calculate margins **additively** instead. + +## Problem Description + +### Standard Odoo Behavior (Compound Margins) + +When you chain pricelists (Pricelist A → Pricelist B), Odoo applies margins in cascade: + +``` +Base price: 4.68€ +Pricelist A: -5% discount → 4.68 × 0.95 = 4.446€ +Pricelist B: 25% markup → 4.446 × 1.25 = 5.5575€ +``` + +**Result:** 5.56€ (effective margin: 18.8%) + +### Desired Behavior (Total/Additive Margins) + +With this module, you can calculate the **total margin** by summing percentages: + +``` +Base price: 4.68€ +Total margin: -5% + 25% = 20% +Final price: 4.68 × 1.20 = 5.616€ +``` + +**Result:** 5.62€ (effective margin: 20%) + +## Features + +- ✅ **Additive margin calculation** across chained pricelists +- ✅ **Opt-in via checkbox** - doesn't affect existing pricelists +- ✅ **Compatible with custom bases** (`last_purchase_price` from `product_sale_price_from_pricelist`) +- ✅ **Supports all formula extras** (price_round, price_surcharge, price_min/max_margin) +- ✅ **Multi-level chains** - works with 2+ pricelists in sequence +- ✅ **Currency conversion** - handles multi-currency scenarios +- ✅ **Detailed logging** - debug pricing calculations easily + +## Installation + +1. **Install dependencies:** + ```bash + # Ensure these modules are installed: + - product + - product_price_category + - product_sale_price_from_pricelist + ``` + +2. **Install module:** + ```bash + docker-compose exec odoo odoo -d odoo -u product_pricelist_total_margin --stop-after-init + ``` + +3. **Restart Odoo:** + ```bash + docker-compose restart odoo + ``` + +## Configuration + +### Step 1: Create Base Pricelist + +Create a pricelist that defines your base pricing logic: + +1. Go to **Sales > Configuration > Pricelists** +2. Create a new pricelist: "Base Pricelist - Last Purchase Price" +3. Add a rule: + - **Apply On:** All Products + - **Based on:** Last Purchase Price (or List Price, Standard Price, etc.) + - **Price Computation:** Formula + - **Discount:** 5% (for "cesta básica" category example) + +### Step 2: Create Chained Pricelist + +Create a pricelist that chains to the base one: + +1. Create a new pricelist: "Category Margin - Repostería" +2. Add a rule: + - **Apply On:** All Products (or specific category) + - **Based on:** Other Pricelist → Select "Base Pricelist - Last Purchase Price" + - **Price Computation:** Formula + - **Discount:** -25% (negative = 25% markup) + - **☑️ Use Total Margin:** Check this box! + +### Step 3: Assign to Products + +- For automatic price calculation, configure the pricelist in **Settings > Sales > Automatic Price Configuration** +- Or assign the pricelist to specific customers/partners + +## Usage Example + +### Scenario: Cooperative Pricing System + +Your cooperative has two margin rules: + +1. **Price Category Discount:** "Cesta Básica" products get -5% (to make them affordable) +2. **Product Category Markup:** "Repostería" products get +25% (higher margin category) + +**Without this module (compound):** +``` +Product: Flour (cesta básica, repostería) +Purchase price: 4.68€ +After price category (-5%): 4.446€ +After product category (+25%): 5.5575€ ❌ Wrong effective margin: 18.8% +``` + +**With this module (total margin enabled):** +``` +Product: Flour (cesta básica, repostería) +Purchase price: 4.68€ +Total margin: -5% + 25% = 20% +Final price: 5.616€ ✅ Correct effective margin: 20% +``` + +## Technical Details + +### New Field + +- **Model:** `product.pricelist.item` +- **Field:** `use_total_margin` (Boolean) +- **Default:** False (opt-in) +- **Visibility:** Only shown when: + - `compute_price = 'formula'` + - `base = 'pricelist'` (chained pricelist) + +### Methods + +#### `_get_base_price_and_margins(product, quantity, uom, date, currency)` + +Traverses the pricelist chain backwards to: +1. Find the original base price (before any margins) +2. Collect all margin percentages along the chain + +Returns: `(base_price: float, margins: list[float])` + +#### `_compute_original_base_price(item, product, quantity, uom, date, currency)` + +Computes the base price from the bottom item of the chain, supporting: +- `last_purchase_price` (custom from `product_sale_price_from_pricelist`) +- `list_price` (standard) +- `standard_price` (cost) +- Currency conversions + +#### `_apply_formula_extras(price, base_price, currency)` + +Applies additional formula options: +- `price_round`: Round to nearest value +- `price_surcharge`: Add fixed amount +- `price_min_margin`: Enforce minimum margin +- `price_max_margin`: Enforce maximum margin + +#### `_compute_price(product, quantity, uom, date, currency)` [OVERRIDE] + +Main override that: +1. Checks if `use_total_margin=True` and conditions are met +2. Calls helper methods to get base price and margins +3. Sums margins additively: `total_margin = sum(margins)` +4. Applies total margin: `price = base_price * (1 + total_margin / 100)` +5. Applies formula extras +6. Falls back to standard behavior if conditions not met + +### Logging + +All calculations are logged with `[TOTAL MARGIN]` prefix for easy debugging: + +```python +_logger.info("[TOTAL MARGIN] Item %s: base=%s, margin=%.2f%%", ...) +_logger.info("[TOTAL MARGIN] Margins: ['5.0%', '25.0%'] = 20.0% total") +_logger.info("[TOTAL MARGIN] Base price 4.68 * (1 + 20.0%) = 5.616") +``` + +View logs: +```bash +docker-compose logs -f odoo | grep "TOTAL MARGIN" +``` + +## Testing + +### Run Tests + +```bash +docker-compose run odoo odoo -d odoo --test-enable --stop-after-init -u product_pricelist_total_margin +``` + +### Test Coverage + +- ✅ Compound margin (default behavior preserved) +- ✅ Total margin (additive calculation) +- ✅ Formula extras (round, surcharge, min/max) +- ✅ 3-level pricelist chains +- ✅ Different base types (last_purchase_price, list_price) +- ✅ Currency conversions + +## Compatibility + +- **Odoo Version:** 18.0 +- **Python Version:** 3.10+ +- **Dependencies:** + - `product` (core) + - `product_price_category` (OCA) + - `product_sale_price_from_pricelist` (custom) + +## Limitations + +1. **Only works with `compute_price='formula'`**: Fixed prices and percentage-based rules are not affected +2. **Circular references**: The module detects and breaks circular pricelist chains, but logs a warning +3. **Performance**: Traversing long pricelist chains may impact performance (though minimal in practice) + +## Troubleshooting + +### Margins still compound even with checkbox enabled + +**Check:** +1. Is `compute_price` set to "Formula"? +2. Is `base` set to "Other Pricelist"? +3. Is the checkbox actually checked and saved? +4. Check logs for `[TOTAL MARGIN]` entries to see if logic is being triggered + +### Price is incorrect + +**Debug:** +1. Enable developer mode +2. Check logs: `docker-compose logs -f odoo | grep "TOTAL MARGIN"` +3. Verify: + - Base price is correct + - All margins are collected + - Currency conversions are applied + - Formula extras (round, surcharge) are expected + +### Checkbox not visible + +**Possible causes:** +- `compute_price` is not "Formula" (must be formula-based) +- `base` is not "Other Pricelist" (no chain to traverse) +- View not properly loaded (try reloading page or clearing browser cache) + +## Development + +### File Structure + +``` +product_pricelist_total_margin/ +├── __init__.py +├── __manifest__.py +├── README.md +├── models/ +│ ├── __init__.py +│ └── product_pricelist_item.py +├── tests/ +│ ├── __init__.py +│ └── test_total_margin.py +└── views/ + └── product_pricelist_item_views.xml +``` + +### Contributing + +Follow OCA guidelines and project conventions defined in `.github/copilot-instructions.md`. + +## License + +AGPL-3.0 or later + +## Author + +**Kidekoop** - 2026 + +## Changelog + +### 18.0.1.0.0 (2026-02-21) + +- Initial implementation +- Support for additive margin calculation in chained pricelists +- Compatible with `last_purchase_price` custom base +- Comprehensive test suite +- Detailed logging for debugging diff --git a/product_pricelist_total_margin/__init__.py b/product_pricelist_total_margin/__init__.py new file mode 100644 index 0000000..068aff6 --- /dev/null +++ b/product_pricelist_total_margin/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2026 - Today Kidekoop +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from . import models # noqa: F401 diff --git a/product_pricelist_total_margin/__manifest__.py b/product_pricelist_total_margin/__manifest__.py new file mode 100644 index 0000000..adb3e30 --- /dev/null +++ b/product_pricelist_total_margin/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2026 - Today Kidekoop +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +{ # noqa: B018 + "name": "Product Pricelist Total Margin", + "version": "18.0.1.0.0", + "category": "Sales/Products", + "summary": "Calculate total margin additively instead of compounding in chained pricelists", + "author": "Odoo Community Association (OCA), Kidekoop", + "website": "https://github.com/kidekoop", + "license": "AGPL-3", + "depends": [ + "product", + "product_price_category", + "product_sale_price_from_pricelist", + ], + "data": [ + "views/product_pricelist_item_views.xml", + "views/res_config_settings_views.xml", + ], +} diff --git a/product_pricelist_total_margin/models/__init__.py b/product_pricelist_total_margin/models/__init__.py new file mode 100644 index 0000000..32427fe --- /dev/null +++ b/product_pricelist_total_margin/models/__init__.py @@ -0,0 +1,5 @@ +# Copyright 2026 - Today Kidekoop +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from . import product_pricelist_item # noqa: F401 +from . import res_config_settings # noqa: F401 diff --git a/product_pricelist_total_margin/models/product_pricelist_item.py b/product_pricelist_total_margin/models/product_pricelist_item.py new file mode 100644 index 0000000..6f1f218 --- /dev/null +++ b/product_pricelist_total_margin/models/product_pricelist_item.py @@ -0,0 +1,386 @@ +# Copyright 2026 - Today Kidekoop +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +import logging + +from odoo import fields # type: ignore +from odoo import models # type: ignore +from odoo.tools import float_round # type: ignore + +_logger = logging.getLogger(__name__) + + +class ProductPricelistItem(models.Model): + _inherit = "product.pricelist.item" + + use_total_margin = fields.Boolean( + string="Total Margin Mode", + default=False, + help="If checked, margins will be accumulated additively across the pricelist " + "chain instead of being compounded.\n\n" + "Example: Base price 100€, Margin1 -5%, Margin2 25%\n" + "- Compound (default): 100 * 0.95 * 1.25 = 118.75€\n" + "- Total (this option): 100 * (1 + 0.20) = 120€", + ) + + def _get_base_price_and_margins(self, product, quantity, uom, date, currency): + """ + Traverse the pricelist chain to get the original base price and collect + all margins in the chain. + + Returns: + tuple: (base_price: float, margins: list of floats) + """ + margins = [] + current_item = self + visited_items = set() + + _logger.info( + "[TOTAL MARGIN] Starting chain traversal for product %s [%s]", + product.default_code or product.name, + product.id, + ) + + # Traverse the chain backwards to collect all margins + while current_item: + # Prevent infinite loops + if current_item.id in visited_items: + _logger.warning( + "[TOTAL MARGIN] Circular reference detected in pricelist chain at item %s", + current_item.id, + ) + break + visited_items.add(current_item.id) + + # Collect this item's margin + if current_item.compute_price == "formula": + if current_item.base == "standard_price": + # For standard_price, use price_markup (inverted) + margin = current_item.price_markup or 0.0 + else: + # For other bases, use price_discount (negative = markup) + margin = -(current_item.price_discount or 0.0) + + margins.append(margin) + _logger.info( + "[TOTAL MARGIN] Item %s: base=%s, margin=%.2f%%", + current_item.id, + current_item.base, + margin, + ) + + # Move to next item in chain + if current_item.base == "pricelist" and current_item.base_pricelist_id: + # Get the applicable rule from the base pricelist + base_pricelist = current_item.base_pricelist_id + rules = base_pricelist._get_applicable_rules( + products=product, + date=date, + quantity=quantity, + uom=uom, + ) + if rules: + # Get the first (highest priority) rule + current_item = rules[0] + else: + _logger.warning( + "[TOTAL MARGIN] No applicable rules found in base pricelist %s", + base_pricelist.id, + ) + current_item = None + else: + # We've reached the base of the chain + break + + # Now get the original base price (without any margins) + if current_item: + # Use the last item's base to compute the original price + base_price = self._compute_original_base_price( + current_item, product, quantity, uom, date, currency + ) + _logger.info( + "[TOTAL MARGIN] Original base price: %.2f (from item %s, base=%s)", + base_price, + current_item.id, + current_item.base, + ) + else: + # Fallback to product list price + base_price = product.lst_price + _logger.warning( + "[TOTAL MARGIN] Could not find base item, using product.lst_price: %.2f", + base_price, + ) + + # Reverse margins list since we collected them backwards + margins.reverse() + + return base_price, margins + + def _compute_original_base_price( + self, item, product, quantity, uom, date, currency + ): + """ + Compute the original base price from a pricelist item without applying + any margin formula. + + Args: + item: The pricelist item at the base of the chain + product: The product to price + quantity: Quantity + uom: Unit of measure + date: Date for pricing + currency: Target currency + + Returns: + float: The base price before any margins + """ + rule_base = item.base or "list_price" + + # Handle custom base from product_sale_price_from_pricelist + if rule_base == "last_purchase_price": + src_currency = product.currency_id + price = product.last_purchase_price_received or 0.0 + _logger.info("[TOTAL MARGIN] Using last_purchase_price: %.2f", price) + + elif rule_base == "standard_price": + src_currency = product.cost_currency_id + price = product.standard_price or 0.0 + _logger.info("[TOTAL MARGIN] Using standard_price: %.2f", price) + + elif rule_base == "pricelist" and item.base_pricelist_id: + # This shouldn't happen if we traversed correctly, but handle it + _logger.warning( + "[TOTAL MARGIN] Unexpected pricelist base at bottom of chain" + ) + src_currency = item.base_pricelist_id.currency_id + price = item.base_pricelist_id._get_product_price( + product=product, + quantity=quantity, + currency=src_currency, + uom=uom, + date=date, + ) + + else: # list_price (default) + src_currency = product.currency_id + price = product.lst_price or 0.0 + _logger.info("[TOTAL MARGIN] Using list_price: %.2f", price) + + # Convert currency if needed + if src_currency and currency and src_currency != currency: + company = self.env.company + price = src_currency._convert( + price, + currency, + company, + date or fields.Date.today(), + ) + _logger.info( + "[TOTAL MARGIN] Converted price from %s to %s: %.2f", + src_currency.name, + currency.name, + price, + ) + + return price + + def _apply_formula_extras(self, price, base_price, currency): + """ + Apply price_round, price_surcharge, and min/max margins to the calculated price. + + Args: + price: The price after margin is applied + base_price: The original base price (for min/max margin calculation) + currency: Currency for conversions + + Returns: + float: The final price with all extras applied + """ + # Rounding + if self.price_round: + price = float_round(price, precision_rounding=self.price_round) + _logger.info("[TOTAL MARGIN] After rounding: %.2f", price) + + # Surcharge + if self.price_surcharge: + surcharge = self.price_surcharge + if self.currency_id and currency and self.currency_id != currency: + company = self.env.company + surcharge = self.currency_id._convert( + surcharge, + currency, + company, + fields.Date.today(), + ) + price += surcharge + _logger.info( + "[TOTAL MARGIN] After surcharge (+%.2f): %.2f", surcharge, price + ) + + # Min margin + if self.price_min_margin: + min_margin = self.price_min_margin + if self.currency_id and currency and self.currency_id != currency: + company = self.env.company + min_margin = self.currency_id._convert( + min_margin, + currency, + company, + fields.Date.today(), + ) + min_price = base_price + min_margin + if price < min_price: + _logger.info( + "[TOTAL MARGIN] Applying min_margin: %.2f -> %.2f", + price, + min_price, + ) + price = min_price + + # Max margin + if self.price_max_margin: + max_margin = self.price_max_margin + if self.currency_id and currency and self.currency_id != currency: + company = self.env.company + max_margin = self.currency_id._convert( + max_margin, + currency, + company, + fields.Date.today(), + ) + max_price = base_price + max_margin + if price > max_price: + _logger.info( + "[TOTAL MARGIN] Applying max_margin: %.2f -> %.2f", + price, + max_price, + ) + price = max_price + + return price + + def _apply_global_margin_limits(self, total_margin, base_price): + """ + Apply global minimum and maximum margin limits from configuration. + + Args: + total_margin: The calculated total margin percentage + base_price: The base price (for logging) + + Returns: + float: The adjusted margin percentage + """ + # Get global margin limits from configuration + IrConfigParam = self.env["ir.config_parameter"].sudo() + min_margin = float( + IrConfigParam.get_param( + "product_pricelist_total_margin.min_percent", default="0.0" + ) + ) + max_margin = float( + IrConfigParam.get_param( + "product_pricelist_total_margin.max_percent", default="0.0" + ) + ) + + original_margin = total_margin + + # Apply minimum margin if configured (> 0) + if min_margin > 0.0 and total_margin < min_margin: + total_margin = min_margin + _logger.info( + "[TOTAL MARGIN] Applied global minimum margin: %.2f%% -> %.2f%% " + "(configured min: %.2f%%)", + original_margin, + total_margin, + min_margin, + ) + + # Apply maximum margin if configured (> 0) + if max_margin > 0.0 and total_margin > max_margin: + total_margin = max_margin + _logger.info( + "[TOTAL MARGIN] Applied global maximum margin: %.2f%% -> %.2f%% " + "(configured max: %.2f%%)", + original_margin, + total_margin, + max_margin, + ) + + return total_margin + + def _compute_price( + self, + product, + quantity, + uom, + date, + currency=None, + ): + """ + Override to implement total margin calculation when use_total_margin is True. + + Instead of compounding margins (applying each margin on top of the previous + result), this method: + 1. Traverses the pricelist chain to collect all margins + 2. Sums them additively + 3. Applies the total margin to the original base price + 4. Enforces global min/max margin limits if configured + + Example: + Base price: 100€ + Pricelist 1: -5% discount + Pricelist 2: 25% markup + + Standard Odoo (compound): 100 * 0.95 * 1.25 = 118.75€ + This module (total): 100 * (1 + 0.20) = 120€ + """ + # Only apply total margin logic if: + # 1. use_total_margin is True + # 2. compute_price is 'formula' (not 'fixed' or 'percentage') + # 3. We're in a pricelist chain (base='pricelist') + if ( + self.use_total_margin + and self.compute_price == "formula" + and self.base == "pricelist" + ): + _logger.info( + "[TOTAL MARGIN] Computing total margin for product %s [%s]", + product.default_code or product.name, + product.id, + ) + + # Get base price and all margins in the chain + base_price, margins = self._get_base_price_and_margins( + product, quantity, uom, date, currency + ) + + # Sum margins additively + total_margin = sum(margins) + _logger.info( + "[TOTAL MARGIN] Margins: %s = %.2f%% total", + [f"{m:.2f}%" for m in margins], + total_margin, + ) + + # Apply global min/max margin limits + total_margin = self._apply_global_margin_limits(total_margin, base_price) + + # Apply total margin to base price + price = base_price * (1 + total_margin / 100) + _logger.info( + "[TOTAL MARGIN] Base price %.2f * (1 + %.2f%%) = %.2f", + base_price, + total_margin, + price, + ) + + # Apply formula extras (round, surcharge, min/max margins) + price = self._apply_formula_extras(price, base_price, currency) + + _logger.info("[TOTAL MARGIN] Final price: %.2f", price) + return price + + # Standard behavior for all other cases + return super()._compute_price(product, quantity, uom, date, currency) diff --git a/product_pricelist_total_margin/models/res_config_settings.py b/product_pricelist_total_margin/models/res_config_settings.py new file mode 100644 index 0000000..76d720a --- /dev/null +++ b/product_pricelist_total_margin/models/res_config_settings.py @@ -0,0 +1,33 @@ +# Copyright 2026 - Today Kidekoop +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import fields # type: ignore +from odoo import models # type: ignore + + +class ResConfigSettings(models.TransientModel): + _inherit = "res.config.settings" + + total_margin_min_percent = fields.Float( + string="Minimum Total Margin (%)", + default=0.0, + help="Minimum total margin percentage allowed for pricelist items using " + "Total Margin Mode. If the calculated margin is below this value, " + "the price will be adjusted to meet the minimum.\n\n" + "Example: If set to 10%, a product with base price 100€ will have " + "a minimum final price of 110€, regardless of calculated margins.\n\n" + "Set to 0 to disable minimum margin control.", + config_parameter="product_pricelist_total_margin.min_percent", + ) + + total_margin_max_percent = fields.Float( + string="Maximum Total Margin (%)", + default=0.0, + help="Maximum total margin percentage allowed for pricelist items using " + "Total Margin Mode. If the calculated margin exceeds this value, " + "the price will be adjusted to meet the maximum.\n\n" + "Example: If set to 50%, a product with base price 100€ will have " + "a maximum final price of 150€, regardless of calculated margins.\n\n" + "Set to 0 to disable maximum margin control.", + config_parameter="product_pricelist_total_margin.max_percent", + ) diff --git a/product_pricelist_total_margin/tests/__init__.py b/product_pricelist_total_margin/tests/__init__.py new file mode 100644 index 0000000..4712589 --- /dev/null +++ b/product_pricelist_total_margin/tests/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2026 - Today Kidekoop +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from . import test_total_margin # noqa: F401 diff --git a/product_pricelist_total_margin/tests/test_total_margin.py b/product_pricelist_total_margin/tests/test_total_margin.py new file mode 100644 index 0000000..06128f1 --- /dev/null +++ b/product_pricelist_total_margin/tests/test_total_margin.py @@ -0,0 +1,353 @@ +# Copyright 2026 - Today Kidekoop +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo.tests import tagged +from odoo.tests.common import TransactionCase + + +@tagged("post_install", "-at_install") +class TestTotalMargin(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + + # Create a product with last_purchase_price + cls.product = cls.env["product.product"].create( + { + "name": "Test Product Total Margin", + "default_code": "TEST-MARGIN-001", + "list_price": 100.0, + "last_purchase_price_received": 4.68, + } + ) + + # Create tax (required for some price calculations) + cls.tax = cls.env["account.tax"].create( + { + "name": "Test Tax 21%", + "amount": 21.0, + "amount_type": "percent", + "type_tax_use": "sale", + } + ) + cls.product.taxes_id = [(6, 0, [cls.tax.id])] + + # Create base pricelist with last_purchase_price + cls.pricelist_base = cls.env["product.pricelist"].create( + { + "name": "Base Pricelist (Last Purchase Price)", + "currency_id": cls.env.company.currency_id.id, + } + ) + + # Create rule with -5% discount (simulating "cesta básica") + cls.item_base = cls.env["product.pricelist.item"].create( + { + "pricelist_id": cls.pricelist_base.id, + "applied_on": "3_global", + "base": "last_purchase_price", + "compute_price": "formula", + "price_discount": 5.0, # 5% discount + } + ) + + # Create chained pricelist with 25% markup (simulating category margin) + cls.pricelist_chained = cls.env["product.pricelist"].create( + { + "name": "Chained Pricelist (Category Margin)", + "currency_id": cls.env.company.currency_id.id, + } + ) + + cls.item_chained = cls.env["product.pricelist.item"].create( + { + "pricelist_id": cls.pricelist_chained.id, + "applied_on": "3_global", + "base": "pricelist", + "base_pricelist_id": cls.pricelist_base.id, + "compute_price": "formula", + "price_discount": -25.0, # 25% markup (negative discount) + "use_total_margin": False, # Will be toggled in tests + } + ) + + def test_compound_margin_default_behavior(self): + """Test that without use_total_margin, margins are compounded (standard Odoo).""" + # Ensure use_total_margin is False + self.item_chained.use_total_margin = False + + # Get price through chained pricelist + price = self.pricelist_chained._get_product_price( + product=self.product, + quantity=1.0, + ) + + # Expected calculation (compound): + # Base: 4.68 + # After -5% discount: 4.68 * 0.95 = 4.446 + # After 25% markup: 4.446 * 1.25 = 5.5575 + expected_price = 4.68 * 0.95 * 1.25 + self.assertAlmostEqual( + price, + expected_price, + places=2, + msg=f"Compound margin should be {expected_price}, got {price}", + ) + + def test_total_margin_additive_behavior(self): + """Test that with use_total_margin=True, margins are added instead of compounded.""" + # Enable total margin + self.item_chained.use_total_margin = True + + # Get price through chained pricelist + price = self.pricelist_chained._get_product_price( + product=self.product, + quantity=1.0, + ) + + # Expected calculation (total/additive): + # Base: 4.68 + # Total margin: -5% + 25% = 20% + # Final: 4.68 * 1.20 = 5.616 + expected_price = 4.68 * 1.20 + self.assertAlmostEqual( + price, + expected_price, + places=2, + msg=f"Total margin should be {expected_price}, got {price}", + ) + + def test_total_margin_with_price_round(self): + """Test that price_round is applied correctly with total margin.""" + # Enable total margin and set rounding + self.item_chained.use_total_margin = True + self.item_chained.price_round = 0.05 # Round to nearest 0.05 + + price = self.pricelist_chained._get_product_price( + product=self.product, + quantity=1.0, + ) + + # Base calculation: 4.68 * 1.20 = 5.616 + # Rounded to nearest 0.05 = 5.60 + expected_price = 5.60 + self.assertAlmostEqual( + price, + expected_price, + places=2, + msg=f"Rounded total margin should be {expected_price}, got {price}", + ) + + def test_total_margin_with_surcharge(self): + """Test that price_surcharge is applied correctly with total margin.""" + # Enable total margin and set surcharge + self.item_chained.use_total_margin = True + self.item_chained.price_surcharge = 1.0 # Add 1€ + + price = self.pricelist_chained._get_product_price( + product=self.product, + quantity=1.0, + ) + + # Base calculation: 4.68 * 1.20 = 5.616 + # Plus surcharge: 5.616 + 1.0 = 6.616 + expected_price = 5.616 + 1.0 + self.assertAlmostEqual( + price, + expected_price, + places=2, + msg=f"Total margin with surcharge should be {expected_price}, got {price}", + ) + + def test_total_margin_three_level_chain(self): + """Test total margin with 3 pricelists in chain.""" + # Create a third pricelist in the chain + pricelist_3rd = self.env["product.pricelist"].create( + { + "name": "Third Level Pricelist", + "currency_id": self.env.company.currency_id.id, + } + ) + + _item_3rd = self.env["product.pricelist.item"].create( # noqa: F841 + { + "pricelist_id": pricelist_3rd.id, + "applied_on": "3_global", + "base": "pricelist", + "base_pricelist_id": self.pricelist_chained.id, + "compute_price": "formula", + "price_discount": -10.0, # 10% markup + "use_total_margin": True, + } + ) + + # Also enable on chained + self.item_chained.use_total_margin = True + + price = pricelist_3rd._get_product_price( + product=self.product, + quantity=1.0, + ) + + # Expected calculation (3-level total): + # Base: 4.68 + # Total margin: -5% + 25% + 10% = 30% + # Final: 4.68 * 1.30 = 6.084 + expected_price = 4.68 * 1.30 + self.assertAlmostEqual( + price, + expected_price, + places=2, + msg=f"3-level total margin should be {expected_price}, got {price}", + ) + + def test_total_margin_with_list_price_base(self): + """Test total margin when base is list_price instead of last_purchase_price.""" + # Create new base pricelist with list_price + pricelist_list = self.env["product.pricelist"].create( + { + "name": "List Price Base Pricelist", + "currency_id": self.env.company.currency_id.id, + } + ) + + _item_list = self.env["product.pricelist.item"].create( # noqa: F841 + { + "pricelist_id": pricelist_list.id, + "applied_on": "3_global", + "base": "list_price", + "compute_price": "formula", + "price_discount": 10.0, # 10% discount + } + ) + + # Create chained pricelist + pricelist_chained_list = self.env["product.pricelist"].create( + { + "name": "Chained from List Price", + "currency_id": self.env.company.currency_id.id, + } + ) + + _item_chained_list = self.env["product.pricelist.item"].create( # noqa: F841 + { + "pricelist_id": pricelist_chained_list.id, + "applied_on": "3_global", + "base": "pricelist", + "base_pricelist_id": pricelist_list.id, + "compute_price": "formula", + "price_discount": -20.0, # 20% markup + "use_total_margin": True, + } + ) + + price = pricelist_chained_list._get_product_price( + product=self.product, + quantity=1.0, + ) + + # Expected calculation: + # Base: 100.0 (list_price) + # Total margin: -10% + 20% = 10% + # Final: 100.0 * 1.10 = 110.0 + expected_price = 100.0 * 1.10 + self.assertAlmostEqual( + price, + expected_price, + places=2, + msg=f"Total margin from list_price should be {expected_price}, got {price}", + ) + + def test_total_margin_with_global_minimum(self): + """Test that global minimum margin is enforced.""" + # Set global minimum margin to 25% + self.env["ir.config_parameter"].sudo().set_param( + "product_pricelist_total_margin.min_percent", "25.0" + ) + + # Enable total margin (calculated: -5% + 25% = 20%, below min 25%) + self.item_chained.use_total_margin = True + + price = self.pricelist_chained._get_product_price( + product=self.product, + quantity=1.0, + ) + + # Expected: Base 4.68 * (1 + 25%) = 5.85 (forced to minimum) + # Not the calculated 20%: 4.68 * 1.20 = 5.616 + expected_price = 4.68 * 1.25 + self.assertAlmostEqual( + price, + expected_price, + places=2, + msg=f"Global minimum margin should force price to {expected_price}, got {price}", + ) + + # Clean up + self.env["ir.config_parameter"].sudo().set_param( + "product_pricelist_total_margin.min_percent", "0.0" + ) + + def test_total_margin_with_global_maximum(self): + """Test that global maximum margin is enforced.""" + # Set global maximum margin to 15% + self.env["ir.config_parameter"].sudo().set_param( + "product_pricelist_total_margin.max_percent", "15.0" + ) + + # Enable total margin (calculated: -5% + 25% = 20%, above max 15%) + self.item_chained.use_total_margin = True + + price = self.pricelist_chained._get_product_price( + product=self.product, + quantity=1.0, + ) + + # Expected: Base 4.68 * (1 + 15%) = 5.382 (capped at maximum) + # Not the calculated 20%: 4.68 * 1.20 = 5.616 + expected_price = 4.68 * 1.15 + self.assertAlmostEqual( + price, + expected_price, + places=2, + msg=f"Global maximum margin should cap price at {expected_price}, got {price}", + ) + + # Clean up + self.env["ir.config_parameter"].sudo().set_param( + "product_pricelist_total_margin.max_percent", "0.0" + ) + + def test_total_margin_with_both_limits(self): + """Test that both min and max limits can work together.""" + # Set both limits: min 10%, max 30% + self.env["ir.config_parameter"].sudo().set_param( + "product_pricelist_total_margin.min_percent", "10.0" + ) + self.env["ir.config_parameter"].sudo().set_param( + "product_pricelist_total_margin.max_percent", "30.0" + ) + + # Test within range (calculated: -5% + 25% = 20%, within [10%, 30%]) + self.item_chained.use_total_margin = True + price = self.pricelist_chained._get_product_price( + product=self.product, + quantity=1.0, + ) + + # Should use calculated margin: 4.68 * 1.20 = 5.616 + expected_price = 4.68 * 1.20 + self.assertAlmostEqual( + price, + expected_price, + places=2, + msg=f"Margin within limits should not be adjusted: {expected_price}, got {price}", + ) + + # Clean up + self.env["ir.config_parameter"].sudo().set_param( + "product_pricelist_total_margin.min_percent", "0.0" + ) + self.env["ir.config_parameter"].sudo().set_param( + "product_pricelist_total_margin.max_percent", "0.0" + ) diff --git a/product_pricelist_total_margin/views/product_pricelist_item_views.xml b/product_pricelist_total_margin/views/product_pricelist_item_views.xml new file mode 100644 index 0000000..2a7d19d --- /dev/null +++ b/product_pricelist_total_margin/views/product_pricelist_item_views.xml @@ -0,0 +1,17 @@ + + + + product.pricelist.item.form.inherit.total.margin + product.pricelist.item + + + + + + + + + diff --git a/product_pricelist_total_margin/views/res_config_settings_views.xml b/product_pricelist_total_margin/views/res_config_settings_views.xml new file mode 100644 index 0000000..2139c57 --- /dev/null +++ b/product_pricelist_total_margin/views/res_config_settings_views.xml @@ -0,0 +1,33 @@ + + + + res.config.settings.view.form.inherit.total.margin + res.config.settings + + + + + +
+
+
+
+
+
+ + + + + diff --git a/product_sale_price_from_pricelist/models/product_product.py b/product_sale_price_from_pricelist/models/product_product.py index 20fde1d..2458633 100644 --- a/product_sale_price_from_pricelist/models/product_product.py +++ b/product_sale_price_from_pricelist/models/product_product.py @@ -138,6 +138,7 @@ class ProductProduct(models.Model): old_price = product.lst_price product.lst_price = product.list_price_theoritical + product.standard_price = product.last_purchase_price_received product.last_purchase_price_updated = False _logger.info( "[PRICE] Product %s [%s]: List price updated from %.2f to %.2f",