CybroAddons/advanced_property_management/models/property_sale.py

# -*- coding: utf-8 -*-
#############################################################################
#
#    Cybrosys Technologies Pvt. Ltd.
#
#    Copyright (C) 2024-TODAY Cybrosys Technologies(<https://www.cybrosys.com>)
#    Author: Mohammed Dilshad Tk  (odoo@cybrosys.com)
#
#    You can modify it under the terms of the GNU LESSER
#    GENERAL PUBLIC LICENSE (LGPL v3), Version 3.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU LESSER GENERAL PUBLIC LICENSE (LGPL v3) for more details.
#
#    You should have received a copy of the GNU LESSER GENERAL PUBLIC LICENSE
#    (LGPL v3) along with this program.
#    If not, see <http://www.gnu.org/licenses/>.
#
#############################################################################
from odoo import api, fields, models, _
from odoo.exceptions import ValidationError


class PropertySale(models.Model):
    """A class for the model property sale to represent
    the sale order of a property"""
    _name = 'property.sale'
    _description = 'Sale of the Property'
    _inherit = ['mail.thread', 'mail.activity.mixin']
    _order = 'name desc'

    name = fields.Char(string='Reference', readonly=True,
                       copy=False, default='New',
                       help='The reference code/sequence of the property sale')
    property_id = fields.Many2one(
        'property.property', required=True,
        domain="[('state', '=', 'available'), ('sale_rent', '=', 'for_sale')]",
        string="Property Name",
        help='The property to be sold')
    partner_id = fields.Many2one('res.partner', string="Customer",
                                 required=True,
                                 help='The customer who is buying the property')
    order_date = fields.Date(string="Order Date",
                             help='The order date of property')
    state = fields.Selection([('draft', 'Draft'), ('confirm', 'Confirm')],
                             default='draft', string="State", tracking=True)
    invoice_id = fields.Many2one('account.move', readonly=True,
                                 string="Invoice",
                                 help='The invoice reference for the property')
    invoiced = fields.Boolean(string='Invoiced',
                              help='Is the property sale invoiced')
    billed = fields.Boolean(string='Commission Billed',
                            help='Is the commission given for this property '
                                 'sale')
    sale_price = fields.Monetary(string="Sale Price", readonly=False,
                                 related='property_id.unit_price',
                                 help='The price of the property')
    any_broker = fields.Boolean(string='Any Broker',
                                help="Enable if this sale have a Broker")
    broker_id = fields.Many2one('res.partner', string="Broker name",
                                help='The broker for this property sale')
    commission_plan_id = fields.Many2one('property.commission',
                                         string="Commission Plan",
                                         help="Select the Commission Plan for "
                                              "the broker")
    commission_type = fields.Char(
        compute='_compute_commission_and_commission_type',
        string="Commission Type",
        help='The type of the commission')
    commission = fields.Monetary(
        string='Commission', compute='_compute_commission_and_commission_type',
        help='THe amount of commission')
    company_id = fields.Many2one('res.company',
                                 string="Property Management Company",
                                 default=lambda self: self.env.company)
    currency_id = fields.Many2one('res.currency', 'Currency',
                                  related='company_id.currency_id',
                                  required=True)

    @api.model
    def create(self, vals):
        """Generate Reference for the sale order"""
        if vals.get('name', _('New')) == _('New'):
            vals['name'] = self.env['ir.sequence'].next_by_code(
                'property.sale') or 'New'
        res = super(PropertySale, self).create(vals)
        return res

    @api.depends('commission_plan_id', 'sale_price')
    def _compute_commission_and_commission_type(self):
        """Calculate commission based on commission plan and sale price"""
        for rec in self:
            rec.commission_type = rec.commission_plan_id.commission_type
            if rec.commission_plan_id.commission_type == 'fixed':
                rec.commission = rec.commission_plan_id.commission
            else:
                rec.commission = (rec.sale_price *
                                  rec.commission_plan_id.commission / 100)

    def create_invoice(self):
        """Generate Invoice Based on the Monetary Values and return
        Invoice Form View"""
        self.invoiced = True
        invoice = self.env['account.move'].create({
            'company_id': self.env.user.company_id.id,
            'partner_id': self.partner_id.id,
            'move_type': 'out_invoice',
            'property_order_id': self.id,
            'invoice_line_ids': [fields.Command.create({
                'name': self.property_id.name,
                'price_unit': self.sale_price,
                'currency_id': self.env.user.company_id.currency_id.id,
            })]
        })
        return {
            'name': _('Invoice'),
            'view_mode': 'form',
            'res_model': 'account.move',
            'target': 'current',
            'res_id': invoice.id,
            'type': 'ir.actions.act_window',
        }

    def commission_bill(self):
        """Generate Bills Based on the Monetary Values and return
            Bills Form View"""
        self.billed = True
        invoice = self.env['account.move'].create({
            'company_id': self.env.user.company_id.id,
            'partner_id': self.broker_id.id,
            'move_type': 'in_invoice',
            'property_order_id': self.id,
            'invoice_line_ids': [fields.Command.create({
                'name': self.property_id.name,
                'price_unit': self.commission,
                'currency_id': self.env.user.company_id.currency_id.id,
            })]
        })
        return {
            'name': _('Commission Bill'),
            'view_mode': 'form',
            'res_model': 'account.move',
            'target': 'current',
            'res_id': invoice.id,
            'type': 'ir.actions.act_window',
        }

    def action_view_invoice(self):
        """Return Invoices Tree View"""
        return {
            'name': _('Invoices'),
            'view_mode': 'tree,form',
            'res_model': 'account.move',
            'target': 'current',
            'context': {'create': False},
            'type': 'ir.actions.act_window',
            'domain': [('property_order_id', '=', self.id),
                       ('move_type', '=', 'out_invoice')]
        }

    def action_view_commission_bill(self):
        """Return Bills Tree View"""
        return {
            'name': _('Commission Bills'),
            'view_mode': 'tree,form',
            'res_model': 'account.move',
            'target': 'current',
            'context': {'create': False},
            'type': 'ir.actions.act_window',
            'domain': [('property_order_id', '=', self.id),
                       ('move_type', '=', 'in_invoice')]
        }

    def action_confirm(self):
        """Confirm the sale order and Change necessary fields"""
        if self.partner_id.blacklisted:
            raise ValidationError(
                _('The Customer %r is Blacklisted.', self.partner_id.name))
        self.state = 'confirm'
        self.property_id.state = 'sold'
        self.property_id.sale_id = self.id