From 6b2e6600ab2d7d6eab9585b363b2b362fc147121 Mon Sep 17 00:00:00 2001 From: "Robin (robal)" Date: Mon, 15 Dec 2025 13:55:27 +0100 Subject: [PATCH] [ADD] estate: add new real estate module Framework 101 tutorial - add estate module - add estate_account module for integration with invoicing --- estate/__init__.py | 1 + estate/__manifest__.py | 18 +++ estate/models/__init__.py | 5 + estate/models/estate_property.py | 113 +++++++++++++++++ estate/models/estate_property_offer.py | 72 +++++++++++ estate/models/estate_property_tag.py | 16 +++ estate/models/estate_property_type.py | 28 +++++ estate/models/res_users.py | 7 ++ estate/security/ir.model.access.csv | 5 + estate/views/estate_menus.xml | 12 ++ estate/views/estate_property_offer_views.xml | 42 +++++++ estate/views/estate_property_tag_views.xml | 32 +++++ estate/views/estate_property_type_views.xml | 58 +++++++++ estate/views/estate_property_views.xml | 124 +++++++++++++++++++ estate/views/res_users_views.xml | 26 ++++ estate_account/__init__.py | 1 + estate_account/__manifest__.py | 8 ++ estate_account/models/__init__.py | 1 + estate_account/models/estate_property.py | 21 ++++ 19 files changed, 590 insertions(+) create mode 100644 estate/__init__.py create mode 100644 estate/__manifest__.py create mode 100644 estate/models/__init__.py create mode 100644 estate/models/estate_property.py create mode 100644 estate/models/estate_property_offer.py create mode 100644 estate/models/estate_property_tag.py create mode 100644 estate/models/estate_property_type.py create mode 100644 estate/models/res_users.py create mode 100644 estate/security/ir.model.access.csv create mode 100644 estate/views/estate_menus.xml create mode 100644 estate/views/estate_property_offer_views.xml create mode 100644 estate/views/estate_property_tag_views.xml create mode 100644 estate/views/estate_property_type_views.xml create mode 100644 estate/views/estate_property_views.xml create mode 100644 estate/views/res_users_views.xml create mode 100644 estate_account/__init__.py create mode 100644 estate_account/__manifest__.py create mode 100644 estate_account/models/__init__.py create mode 100644 estate_account/models/estate_property.py diff --git a/estate/__init__.py b/estate/__init__.py new file mode 100644 index 00000000000..0650744f6bc --- /dev/null +++ b/estate/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/estate/__manifest__.py b/estate/__manifest__.py new file mode 100644 index 00000000000..e56db262b88 --- /dev/null +++ b/estate/__manifest__.py @@ -0,0 +1,18 @@ +{ + "name": "Real Estate", + "description": "Real Estate Advertising", + "author": "Odoo S.A.", + "license": "LGPL-3", + "depends": ["base"], + "application": True, + "data": [ + "security/ir.model.access.csv", + + "views/estate_property_views.xml", + "views/estate_property_offer_views.xml", + "views/estate_property_type_views.xml", + "views/estate_property_tag_views.xml", + "views/estate_menus.xml", + "views/res_users_views.xml", + ], +} diff --git a/estate/models/__init__.py b/estate/models/__init__.py new file mode 100644 index 00000000000..031221b4eae --- /dev/null +++ b/estate/models/__init__.py @@ -0,0 +1,5 @@ +from . import estate_property_offer +from . import estate_property_tag +from . import estate_property_type +from . import estate_property +from . import res_users diff --git a/estate/models/estate_property.py b/estate/models/estate_property.py new file mode 100644 index 00000000000..89ba897c0f0 --- /dev/null +++ b/estate/models/estate_property.py @@ -0,0 +1,113 @@ +from dateutil.relativedelta import relativedelta +from odoo import api, fields, models +from odoo.exceptions import UserError, ValidationError +from odoo.tools.float_utils import float_compare, float_is_zero + + +class EstateProperty(models.Model): + _name = "estate.property" + _description = "Estate property" + _order = "id desc" + + name = fields.Char(string="Title", required=True) + description = fields.Text() + postcode = fields.Char() + date_availability = fields.Date(string="Available From", default=lambda self: fields.Date.context_today(self) + relativedelta(months=3), copy=False) + expected_price = fields.Float(required=True) + selling_price = fields.Float(readonly=True, copy=False) + bedrooms = fields.Integer(default=2) + living_area = fields.Integer(string="Living Area (sqm)") + facades = fields.Integer() + garage = fields.Boolean() + garden = fields.Boolean() + garden_area = fields.Integer(string="Garden Area (sqm)") + garden_orientation = fields.Selection( + selection=[("north", "North"), ("south", "South"), ("east", "East"), ("west", "West")], + ) + + # Reserved fields + active = fields.Boolean(default=True) + state = fields.Selection( + required=True, + selection=[("new", "New"), ("offer_received", "Offer Received"), ("offer_accepted", "Offer Accepted"), ("sold", "Sold"), ("cancelled", "Cancelled")], + default="new", + copy=False, + string="Status", + ) + + # Relations + property_type_id = fields.Many2one("estate.property.type", string="Property Type") + salesman_id = fields.Many2one("res.users", default=lambda self: self.env.user) + buyer_id = fields.Many2one("res.partner", copy=False) + tag_ids = fields.Many2many("estate.property.tag") + offer_ids = fields.One2many("estate.property.offer", "property_id") + + # Computed + total_area = fields.Integer(compute="_compute_total_area", string="Total Area (sqm)") + best_price = fields.Float(compute="_compute_best_price", string="Best Offer") + + @api.depends("living_area", "garden_area") + def _compute_total_area(self) -> None: + for record in self: + record.total_area = record.living_area + record.garden_area + + @api.depends("offer_ids.price") + def _compute_best_price(self) -> None: + for record in self: + record.best_price = max(record.offer_ids.mapped("price"), default=0) + + # Methods that trigger on changes + @api.onchange("garden") + def _onchange_garden_defaults(self) -> None: + if self.garden: + self.garden_area = 10 + self.garden_orientation = "north" + else: + self.garden_area = None + self.garden_orientation = None + + @api.ondelete(at_uninstall=False) + def _unlink_except_new_or_cancelled(self) -> None: + if any(record.state not in {"new", "cancelled"} for record in self): + raise UserError(self.env._("Cannot delete properties unless they are new or cancelled.")) + + # Public methods + def action_set_sold(self) -> bool: + for record in self: + if record.state == "sold": + continue + + if record.state == "cancelled": + raise UserError(record.env._("Cancelled properties cannot be sold.")) + + record.state = "sold" + return True + + def action_set_cancelled(self) -> bool: + for record in self: + if record.state == "cancelled": + continue + + if record.state == "sold": + raise UserError(record.env._("Sold properties cannot be cancelled.")) + + record.state = "cancelled" + return True + + # Constraints + _check_expected_price_strict_positive = models.Constraint( + "CHECK(expected_price > 0)", + "A property's expected price must be strictly greater than 0.", + ) + + _check_selling_price_positive = models.Constraint( + "CHECK(selling_price >= 0)", + "A property's selling price must be equal to or greater than 0.", + ) + + @api.constrains("expected_price", "selling_price") + def _check_selling_price_percentage(self) -> None: + for record in self: + # Selling price is zero when no offer has been accepted + if not float_is_zero(record.selling_price, precision_digits=2) and float_compare(record.selling_price, 0.9 * record.expected_price, precision_digits=2) < 0: + raise ValidationError(record.env._("A property's selling price cannot be lower than 90 percent of its expected price.")) diff --git a/estate/models/estate_property_offer.py b/estate/models/estate_property_offer.py new file mode 100644 index 00000000000..a3aeb84efee --- /dev/null +++ b/estate/models/estate_property_offer.py @@ -0,0 +1,72 @@ +from dateutil.relativedelta import relativedelta +from odoo import api, fields, models +from odoo.exceptions import UserError +from odoo.tools.float_utils import float_compare + + +class EstatePropertyOffer(models.Model): + _name = "estate.property.offer" + _description = "Estate property offer" + _order = "price desc" + + price = fields.Float() + status = fields.Selection( + selection=[("accepted", "Accepted"), ("refused", "Refused")], + copy=False, + ) + validity = fields.Integer(default=7, string="Validity (days)") + + # Relations + partner_id = fields.Many2one("res.partner", required=True) + property_id = fields.Many2one("estate.property", required=True) + property_type_id = fields.Many2one(related="property_id.property_type_id", store=True) + + # Computed + date_deadline = fields.Date(compute="_compute_deadline", inverse="_inverse_deadline", string="Deadline") + + @api.depends("create_date", "validity") + def _compute_deadline(self) -> None: + for record in self: + ref_date = fields.Date.context_today(self) if not record.create_date else record.create_date.date() + record.date_deadline = ref_date + relativedelta(days=record.validity) + + def _inverse_deadline(self) -> None: + for record in self: + ref_date = fields.Date.context_today(self) if not record.create_date else record.create_date.date() + record.validity = (record.date_deadline - ref_date).days + + # CRUD overrides + @api.model + def create(self, vals): + for val in vals: + estate_property = self.env["estate.property"].browse(val["property_id"]) + best_price = estate_property.best_price or 0.0 + if float_compare(val["price"], best_price, precision_digits=2) < 0: + raise UserError(self.env._("A new offer must match or exceed the price of the current best offer.")) + estate_property.state = "offer_received" + return super().create(vals) + + # Public methods + def action_accept(self) -> bool: + # TODO double check validation + for record in self: + if record.property_id.offer_ids.filtered(lambda r: r.status == "accepted"): + raise UserError(record.env._("Cannot accept this offer because another offer has already been accepted for the property.")) + + record.status = "accepted" + record.property_id.selling_price = record.price + record.property_id.buyer_id = record.partner_id + record.property_id.state = "offer_accepted" + return True + + def action_refuse(self) -> bool: + # TODO double check validation + for record in self: + record.status = "refused" + return True + + # Constraints + _check_price_strict_positive = models.Constraint( + "CHECK(price > 0)", + "An offer's price must be strictly greater than 0.", + ) diff --git a/estate/models/estate_property_tag.py b/estate/models/estate_property_tag.py new file mode 100644 index 00000000000..2fb3bfc45ba --- /dev/null +++ b/estate/models/estate_property_tag.py @@ -0,0 +1,16 @@ +from odoo import fields, models + + +class EstatePropertyTag(models.Model): + _name = "estate.property.tag" + _description = "Estate property tag" + _order = "name" + + name = fields.Char(required=True) + color = fields.Integer() + + # Constraints + _uniq_name = models.Constraint( + "UNIQUE(name)", + "A property tag's name must be unique.", + ) diff --git a/estate/models/estate_property_type.py b/estate/models/estate_property_type.py new file mode 100644 index 00000000000..6c28cfbecfc --- /dev/null +++ b/estate/models/estate_property_type.py @@ -0,0 +1,28 @@ +from odoo import api, fields, models + + +class EstatePropertyType(models.Model): + _name = "estate.property.type" + _description = "Estate property type" + _order = "name" + + name = fields.Char(required=True) + sequence = fields.Integer(default=1) + + # Relations + property_ids = fields.One2many("estate.property", "property_type_id") + offer_ids = fields.One2many("estate.property.offer", "property_type_id") + + # Computed + offer_count = fields.Integer(compute="_compute_offer_count") + + @api.depends("offer_ids") + def _compute_offer_count(self) -> None: + for record in self: + record.offer_count = len(record.offer_ids) + + # Constraints + _uniq_name = models.Constraint( + "UNIQUE(name)", + "A property type's name must be unique.", + ) diff --git a/estate/models/res_users.py b/estate/models/res_users.py new file mode 100644 index 00000000000..8673bd5c30a --- /dev/null +++ b/estate/models/res_users.py @@ -0,0 +1,7 @@ +from odoo import fields, models + + +class User(models.Model): + _inherit = "res.users" + + property_ids = fields.One2many("estate.property", "salesman_id", domain=[("state", "in", ["new", "offer_received"])]) diff --git a/estate/security/ir.model.access.csv b/estate/security/ir.model.access.csv new file mode 100644 index 00000000000..4c593ed42e4 --- /dev/null +++ b/estate/security/ir.model.access.csv @@ -0,0 +1,5 @@ +id,name,model_id/id,group_id/id,perm_read,perm_write,perm_create,perm_unlink +access_estate_property,access_estate_property,model_estate_property,base.group_user,1,1,1,1 +access_estate_property_type,access_estate_property_type,model_estate_property_type,base.group_user,1,1,1,1 +access_estate_property_tag,access_estate_property_tag,model_estate_property_tag,base.group_user,1,1,1,1 +access_estate_property_offer,access_estate_property_offer,model_estate_property_offer,base.group_user,1,1,1,1 \ No newline at end of file diff --git a/estate/views/estate_menus.xml b/estate/views/estate_menus.xml new file mode 100644 index 00000000000..1f5c7d82841 --- /dev/null +++ b/estate/views/estate_menus.xml @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/estate/views/estate_property_offer_views.xml b/estate/views/estate_property_offer_views.xml new file mode 100644 index 00000000000..2cd7f3caed1 --- /dev/null +++ b/estate/views/estate_property_offer_views.xml @@ -0,0 +1,42 @@ + + + + estate.property.offer.list + estate.property.offer + + + + + + + + + +

+ +

+ + + + + + + + + + + + + + + + + + + Property Types + estate.property.type + list,form + + diff --git a/estate/views/estate_property_views.xml b/estate/views/estate_property_views.xml new file mode 100644 index 00000000000..3c6fc6f6b0d --- /dev/null +++ b/estate/views/estate_property_views.xml @@ -0,0 +1,124 @@ + + + + estate.property.list + estate.property + + + + + + + + + + + + + + + estate.property.form + estate.property + +
+
+
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + estate.property.search + estate.property + + + + + + + + + + + + + + + + + estate.property.kanban + estate.property + + + + + +
+

+

Expected price:

+

+ Best offer: + Selling price: +

+

+
+ + + + + + + + Properties + estate.property + list,form,kanban + {'search_default_available': True} + + diff --git a/estate/views/res_users_views.xml b/estate/views/res_users_views.xml new file mode 100644 index 00000000000..1046ecd407e --- /dev/null +++ b/estate/views/res_users_views.xml @@ -0,0 +1,26 @@ + + + + view.users.form.inherit.estate_properties_page + res.users + + + + + + + + + + + + + + + + + + + + + diff --git a/estate_account/__init__.py b/estate_account/__init__.py new file mode 100644 index 00000000000..0650744f6bc --- /dev/null +++ b/estate_account/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/estate_account/__manifest__.py b/estate_account/__manifest__.py new file mode 100644 index 00000000000..d77d9c0990b --- /dev/null +++ b/estate_account/__manifest__.py @@ -0,0 +1,8 @@ +{ + "name": "Real Estate Accounting", + "description": "Real Estate Accounting (link module)", + "author": "Odoo S.A.", + "license": "LGPL-3", + "depends": ["estate", "account"], + "data": [], +} diff --git a/estate_account/models/__init__.py b/estate_account/models/__init__.py new file mode 100644 index 00000000000..5e1963c9d2f --- /dev/null +++ b/estate_account/models/__init__.py @@ -0,0 +1 @@ +from . import estate_property diff --git a/estate_account/models/estate_property.py b/estate_account/models/estate_property.py new file mode 100644 index 00000000000..2f0eff1122e --- /dev/null +++ b/estate_account/models/estate_property.py @@ -0,0 +1,21 @@ +from odoo import Command, models + + +class EstateProperty(models.Model): + _inherit = "estate.property" + + def action_set_sold(self) -> bool: + percent_description = "6 percent of selling price" + admin_fee_description = "Administrative fees" + # Note: does not work if fiscal localization is not set + for record in self: + account_move = { + "partner_id": record.buyer_id.id, + "move_type": "out_invoice", + "invoice_line_ids": [ + Command.create({"name": percent_description, "quantity": 1, "price_unit": 0.06 * record.selling_price}), + Command.create({"name": admin_fee_description, "quantity": 1, "price_unit": 100.0}), + ], + } + self.env["account.move"].create(account_move) + return super().action_set_sold()