[ADD] Rental Deposit: Configure and Display Deposit for Rental Products

In this commit:

- Added option to set a deposit product from configuration
- Introduced checkbox to enable deposit for rental products
- Added a field to specify the deposit amount
- Inherited sale order line to auto-add deposit line when rental product added
- Synced deposit quantity with rental product quantity
- Displayed deposit amount on the product page in the website
- Shown deposit details with amount in the shopping cart

Author: amas-odoo

deposit_in_rental_app/__init__.py

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

deposit_in_rental_app/__manifest__.py

@@ -0,0 +1,12 @@
+{
+    'name': 'Rental Deposit',
+    'installable': True,
+    'license': 'LGPL-3',
+    'depends': ['sale_renting', 'website_sale_renting'],
+    'data': [
+        'views/res_config_settings_views.xml',
+        'views/product_template_views.xml',
+        'views/templates.xml',
+    ],
+
+}

deposit_in_rental_app/models/__init__.py

@@ -0,0 +1,3 @@
+from . import res_config_settings
+from . import product_template
+from . import sale_order_line

deposit_in_rental_app/models/product_template.py

@@ -0,0 +1,8 @@
+from odoo import fields, models
+
+
+class ProductTemplate(models.Model):
+    _inherit = 'product.template'
+
+    require_deposit = fields.Boolean(string='Require Deposit', default=False)
+    deposit_amount = fields.Float(string='Amount')

deposit_in_rental_app/models/res_config_settings.py

@@ -0,0 +1,7 @@
+from odoo import fields, models
+
+
+class ResConfigSettings(models.TransientModel):
+    _inherit = 'res.config.settings'
+
+    deposit_product_id = fields.Many2one('product.product', string='Deposit', config_parameter='deposit_in_rental_app.deposit_product_id')

deposit_in_rental_app/models/sale_order_line.py

@@ -0,0 +1,50 @@
+from odoo import api, fields, models
+from odoo.exceptions import UserError
+
+
+class SaleOrderLine(models.Model):
+    _inherit = 'sale.order.line'
+
+    is_deposit_line = fields.Boolean(default=False)
+    parent_id = fields.Many2one(comodel_name="sale.order.line", ondelete='cascade', copy=False)
+    child_ids = fields.One2many(comodel_name="sale.order.line", inverse_name="parent_id", copy=False)
+
+    @api.model_create_multi
+    def create(self, vals_list):
+        res = super().create(vals_list)
+        # fetch deposit product name from ip.config.setting
+        deposit_product_id = self.env["ir.config_parameter"].sudo().get_param("deposit_in_rental_app.deposit_product_id")
+
+        if not deposit_product_id:
+            raise UserError("Set deposit product from setting")
+
+        for line in res:
+            # If product line product is deposit enable create new deposit line
+            if line.product_id.require_deposit and line.product_id.deposit_amount:
+                deposit_order_line = self.env['sale.order.line'].create({
+                    "order_id": line.order_id.id,
+                    "product_id": int(deposit_product_id),
+                    "name": f"Deposit for {line.product_id.name}",
+                    "product_uom_qty": line.product_uom_qty,
+                    "price_unit": line.product_template_id.deposit_amount,
+                    "parent_id": line.id,
+                    "sequence": line.sequence + 1,
+                    "is_deposit_line": True,
+                })
+
+                if not deposit_order_line:
+                    raise UserError("Something went wrong!!")
+
+        return res
+
+    def write(self, vals):
+        res = super().write(vals)
+        # Update quantity if deposit order line is already created
+        if 'product_uom_qty' in vals:
+            for line in self:
+                if line.child_ids:
+                    line.child_ids.write({
+                        "product_uom_qty": vals['product_uom_qty'],
+                        "price_unit": line.child_ids.price_unit
+                    })
+        return res

deposit_in_rental_app/security/ir.model.access.csv

@@ -0,0 +1 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink

deposit_in_rental_app/tests/__init__.py

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

deposit_in_rental_app/tests/test_deposit_rental.py

@@ -0,0 +1,64 @@
+from odoo.tests import tagged
+from odoo.tests.common import TransactionCase
+from odoo.fields import Command
+from odoo.exceptions import UserError
+
+@tagged('post_install', '-at_install')
+class RentalDepositTestCase(TransactionCase):
+    def setUp(self):
+        super(RentalDepositTestCase, self).setUp()
+
+        self.partner = self.env['res.partner'].create({
+            'name': 'Test Partner',
+        })
+
+        self.deposit_product = self.env['product.product'].create({
+            'name': 'Deposit Product',
+            'rent_ok': True
+        })
+
+        self.rental_product = self.env['product.product'].create({
+            'name': 'Music System',
+            'type': 'consu',
+            'require_deposit': True,
+            'deposit_amount': 100.0
+        })
+
+        self.sale_order = self.env['sale.order'].create({'partner_id': self.partner.id})
+
+    def test_configure_deposit_product(self):
+
+        with self.assertRaises(UserError, msg="Should raise error if deposit product is not configured"):
+            self.sale_order.write({
+                "order_line": [
+                    Command.create({'product_id': self.rental_product.id, 'product_uom_qty': 2}),
+                ]
+            })
+    
+    def test_deposit_line(self):
+
+        self.env['ir.config_parameter'].sudo().set_param('deposit_in_rental_app.deposit_product_id', self.deposit_product.id)
+
+        self.sale_order.write({
+            "order_line": [
+                Command.create({'product_id': self.rental_product.id, 'product_uom_qty': 2}),
+            ]
+        })
+
+        main_line = self.sale_order.order_line.filtered(lambda l: not l.is_deposit_line)
+        deposit_line = self.sale_order.order_line.filtered(lambda l: l.is_deposit_line)
+
+        # Check deposit line is created or not
+        self.assertTrue(deposit_line, "Deposit line was not created.")
+
+        # Check deposit line is correctly linked
+        self.assertIn(deposit_line[0], main_line.child_ids, "Deposit line is not in child_ids of main line.")
+        self.assertEqual(deposit_line[0].parent_id, main_line[0], "Deposit line's parent_id does not point to the main line.")
+
+        main_line.write({'product_uom_qty': 5})
+
+        # Check deposit line quantity is also updated
+        self.assertEqual(
+            deposit_line.product_uom_qty, 5,
+            "Deposit line quantity should update when main line quantity changes"
+        )

deposit_in_rental_app/views/product_template_views.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<odoo>
+
+    <record id="product_template_form_view" model="ir.ui.view">
+        <field name="name">product.template.form.view.inherit.deposit.in.rental.app</field>
+        <field name="model">product.template</field>
+        <field name="inherit_id" ref="product.product_template_form_view" />
+        <field name="arch" type="xml">
+            <xpath expr="//group[@name='extra_rental']" position="inside">
+                <field name="require_deposit" />
+                <field name="deposit_amount" invisible="not require_deposit" widget="monetary" />
+            </xpath>
+        </field>
+    </record>
+
+</odoo>