odoo-addon-l10n-br-fiscal 16.0.2.17.0__py3-none-any.whl → 16.0.19.4.0__py3-none-any.whl

odoo/addons/l10n_br_fiscal/models/data_abstract.py

@@ -12,6 +12,23 @@ from odoo.osv import expression
 
 
 class DataAbstract(models.AbstractModel):
+    """
+    Abstract base model for fiscal master data in Brazilian localization.
+
+    This model provides common structure and functionality for fiscal
+    data entities (NCM, CFOP, CST, etc.). It includes:
+    - Standard fields: `code`, `name`, `active`, and a computed
+      `code_unmasked` (for searching codes without punctuation).
+    - Default ordering by `code`.
+    - Enhanced search: Modifies search views and `_name_search`
+      to allow searching by `code`, `code_unmasked`, and `name`
+      simultaneously.
+    - Standardized display name format in `name_get`
+      (`<code> - <name>`).
+    - Permission control for archiving/unarchanging, restricted
+      to users in 'l10n_br_fiscal.group_manager' group.
+    """
+
     _name = "l10n_br_fiscal.data.abstract"
     _description = "Fiscal Data Abstract"
     _order = "code"
@@ -46,6 +63,15 @@ class DataAbstract(models.AbstractModel):
     def fields_view_get(
         self, view_id=None, view_type="form", toolbar=False, submenu=False
     ):
+        """
+        Modify search view architecture to enhance 'code' field filtering.
+
+        Intercept the search view definition, altering `filter_domain`
+        for the 'code' field. This lets users search by raw 'code',
+        'code_unmasked' (code without punctuation), or 'name' of the
+        record when typing into the 'code' filter in the search panel.
+        """
+
         model_view = super().fields_view_get(view_id, view_type, toolbar, submenu)
 
         if view_type == "search":

odoo/addons/l10n_br_fiscal/models/data_ncm_nbs_abstract.py

@@ -89,7 +89,7 @@ class DataNcmNbsAbstract(models.AbstractModel):
 
                 config = DeOlhoNoImposto(
                     company.ibpt_token,
-                    misc.punctuation_rm(company.cnpj_cpf),
+                    misc.punctuation_rm(company.vat),
                     company.state_id.code,
                     odooconfig.get("ibpt_request_timeout")
                     or self.env["ir.config_parameter"]

odoo/addons/l10n_br_fiscal/models/document.py

@@ -10,17 +10,21 @@ from odoo import _, api, fields, models
 from odoo.exceptions import ValidationError
 
 from ..constants.fiscal import (
-    DOCUMENT_ISSUER,
+    COMMENT_TYPE_COMMERCIAL,
+    COMMENT_TYPE_FISCAL,
     DOCUMENT_ISSUER_COMPANY,
     DOCUMENT_ISSUER_DICT,
     DOCUMENT_ISSUER_PARTNER,
     EDOC_PURPOSE,
     EDOC_PURPOSE_NORMAL,
+    EDOC_REFUND_CREDIT_TYPE,
+    EDOC_REFUND_DEBIT_TYPE,
     FISCAL_IN_OUT_DICT,
     MODELO_FISCAL_CTE,
     MODELO_FISCAL_NFCE,
     MODELO_FISCAL_NFE,
     MODELO_FISCAL_NFSE,
+    PUBLIC_ENTIRY_TYPE,
     SITUACAO_EDOC,
     SITUACAO_EDOC_AUTORIZADA,
     SITUACAO_EDOC_CANCELADA,
@@ -32,29 +36,37 @@ from ..constants.fiscal import (
 
 
 class Document(models.Model):
-    """Implementação base dos documentos fiscais
-
-    Devemos sempre ter em mente que o modelo que vai usar este módulo abstrato
-     tem diversos metodos importantes e a intenção que os módulos da OCA que
-     extendem este modelo, funcionem se possível sem a necessidade de
-     codificação extra.
-
-    É preciso também estar atento que o documento fiscal tem dois estados:
-
-    - Estado do documento eletrônico / não eletônico: state_edoc
-    - Estado FISCAL: state_fiscal
-
-    O estado fiscal é um campo que é alterado apenas algumas vezes pelo código
-    e é de responsabilidade do responsável fiscal pela empresa de manter a
-    integridade do mesmo, pois ele não tem um fluxo realmente definido e
-    interfere no lançamento do registro no arquivo do SPED FISCAL.
+    """
+    Base implementation for Brazilian fiscal documents.
+
+    This model serves as the foundational structure for various fiscal
+    documents within the Brazilian localization. It's designed to be
+    extensible, allowing other OCA modules to build upon it, ideally
+    minimizing the need for additional custom coding for common fiscal
+    document functionalities.
+
+    Key aspects to note:
+    - The fiscal document manages two primary states:
+        - Electronic Document State (`state_edoc`): Reflects the status
+          of the document in its electronic lifecycle (e.g., Draft,
+          Authorized, Cancelled).
+        - Fiscal State (`state_fiscal`): Represents the document's status
+          from a purely fiscal accounting perspective (e.g., Regular,
+          Cancelled for fiscal purposes). This state is less automated
+          and often managed by the fiscal responsible to ensure correct
+          reporting, such as in SPED Fiscal.
+
+    This model inherits common fields and methods from
+    `l10n_br_fiscal.document.mixin` and includes features for document
+    numbering, key validation, partner and company fiscal details, line
+    items and returns.
     """
 
     _name = "l10n_br_fiscal.document"
     _inherit = [
-        "l10n_br_fiscal.document.mixin.fields",
-        "l10n_br_fiscal.document.move.mixin",
+        "l10n_br_fiscal.document.mixin",
         "mail.thread",
+        "mail.activity.mixin",
     ]
     _description = "Fiscal Document"
     _check_company_auto = True
@@ -85,9 +97,9 @@ class Document(models.Model):
     )
 
     fiscal_operation_id = fields.Many2one(
-        domain="[('state', '=', 'approved'), "
-        "'|', ('fiscal_operation_type', '=', fiscal_operation_type),"
-        " ('fiscal_operation_type', '=', 'all')]",
+        "l10n_br_fiscal.operation",
+        string="Fiscal Operation",
+        domain="[('state', '=', 'approved')]",
     )
 
     fiscal_operation_type = fields.Selection(
@@ -112,10 +124,6 @@ class Document(models.Model):
         default=lambda self: self.env.user,
     )
 
-    operation_name = fields.Char(
-        copy=False,
-    )
-
     document_electronic = fields.Boolean(
         related="document_type_id.electronic",
         string="Electronic?",
@@ -136,8 +144,16 @@ class Document(models.Model):
     partner_id = fields.Many2one(
         comodel_name="res.partner",
         string="Partner",
+        inverse="_inverse_partner_id",
     )
 
+    @api.onchange("partner_id")
+    def _inverse_partner_id(self):
+        for doc in self:
+            for line in doc.fiscal_line_ids:
+                if line.partner_id != doc.partner_id:
+                    line.partner_id = doc.partner_id
+
     partner_shipping_id = fields.Many2one(
         comodel_name="res.partner",
         string="Shipping Address",
@@ -161,6 +177,24 @@ class Document(models.Model):
         selection=EDOC_PURPOSE,
         string="Finalidade",
         default=EDOC_PURPOSE_NORMAL,
+        compute="_compute_edoc_purpose",
+        store=True,
+        precompute=True,
+    )
+
+    edoc_refund_debit_type = fields.Selection(
+        selection=EDOC_REFUND_DEBIT_TYPE,
+        string="Tipo de Nota de Débito",
+    )
+
+    edoc_refund_credit_type = fields.Selection(
+        selection=EDOC_REFUND_CREDIT_TYPE,
+        string="Tipo de Nota de Crédito",
+    )
+
+    public_entity_type = fields.Selection(
+        selection=PUBLIC_ENTIRY_TYPE,
+        string="Tipo de Entidade Governamental",
     )
 
     document_type = fields.Char(
@@ -178,9 +212,9 @@ class Document(models.Model):
     )
 
     currency_id = fields.Many2one(
+        related="company_id.currency_id",
         comodel_name="res.currency",
         string="Currency",
-        compute="_compute_currency_id",
     )
 
     # this related "state" field is required for the status bar widget
@@ -188,23 +222,6 @@ class Document(models.Model):
     # of objects where the fiscal mixin might be injected.
     state = fields.Selection(related="state_edoc", string="State")
 
-    issuer = fields.Selection(
-        selection=DOCUMENT_ISSUER,
-        default=DOCUMENT_ISSUER_COMPANY,
-    )
-
-    document_subsequent_ids = fields.One2many(
-        comodel_name="l10n_br_fiscal.subsequent.document",
-        inverse_name="source_document_id",
-        copy=True,
-    )
-
-    document_subsequent_generated = fields.Boolean(
-        string="Subsequent documents generated?",
-        compute="_compute_document_subsequent_generated",
-        default=False,
-    )
-
     transport_modal = fields.Selection(
         selection=[
             ("01", "Rodoviário"),
@@ -227,6 +244,29 @@ class Document(models.Model):
         ],
         string="Tomador do Serviço",
     )
+    partner_legal_name = fields.Char(
+        string="Legal Name",
+        related="partner_id.legal_name",
+    )
+    partner_cnpj_cpf = fields.Char(
+        string="CNPJ",
+        related="partner_id.vat",
+    )
+    partner_l10n_br_ie_code = fields.Char(
+        string="State Tax Number",
+        related="partner_id.l10n_br_ie_code",
+    )
+
+    processador_edoc = fields.Selection(
+        related="company_id.processador_edoc",
+    )
+    company_l10n_br_ie_code_st = fields.Char(
+        string="Company ST State Tax Number",
+    )
+
+    fiscal_additional_data = fields.Text()
+
+    customer_additional_data = fields.Text()
 
     @api.constrains("document_key")
     def _check_key(self):
@@ -256,9 +296,9 @@ class Document(models.Model):
 
             if documents:
                 raise ValidationError(
-                    _(
-                        "There is already a fiscal document with this " "key: {} !"
-                    ).format(record.document_key)
+                    _("There is already a fiscal document with this key: {} !").format(
+                        record.document_key
+                    )
                 )
             else:
                 ChaveEdoc(chave=record.document_key, validar=True)
@@ -299,10 +339,18 @@ class Document(models.Model):
                     )
                 )
 
-    @api.depends("company_id")
-    def _compute_currency_id(self):
-        for doc in self:
-            doc.currency_id = doc.company_id.currency_id or self.env.company.currency_id
+    @api.onchange("fiscal_operation_type")
+    def _onchange_fiscal_operation_type(self):
+        domain = [("state", "=", "approved")]
+        if self.fiscal_operation_type:
+            domain.append(("fiscal_operation_type", "=", self.fiscal_operation_type))
+        if (
+            self.fiscal_operation_id
+            and self.fiscal_operation_id.fiscal_operation_type
+            != self.fiscal_operation_type
+        ):
+            self.fiscal_operation_id = False
+        return {"domain": {"fiscal_operation_id": domain}}
 
     def _compute_document_name(self):
         self.ensure_one()
@@ -323,19 +371,19 @@ class Document(models.Model):
             name += "/" + type_serie_number
             if self.document_date:
                 name += " - " + self.document_date.strftime("%d/%m/%Y")
-            if not self.partner_cnpj_cpf:
+            if not self.partner_id.vat:
                 name += " - " + _("Unidentified Consumer")
-            elif self.partner_legal_name:
-                name += " - " + self.partner_legal_name
-                name += " - " + self.partner_cnpj_cpf
+            elif self.partner_id.legal_name:
+                name += " - " + self.partner_id.legal_name
+                name += " - " + self.partner_id.vat
             else:
-                name += " - " + self.partner_name
-                name += " - " + self.partner_cnpj_cpf
+                name += " - " + self.partner_id.name
+                name += " - " + self.partner_id.vat
         elif self._context.get("fiscal_document_no_company"):
             name += type_serie_number
         else:
             name += "{name}/{type_serie_number}".format(
-                name=self.company_name or "",
+                name=self.company_id.name or "",
                 type_serie_number=type_serie_number,
             )
         return name
@@ -359,22 +407,9 @@ class Document(models.Model):
         for r in self:
             r.name = r._compute_document_name()
 
-    @api.depends(
-        "fiscal_line_ids.estimate_tax",
-        "fiscal_line_ids.price_gross",
-        "fiscal_line_ids.amount_untaxed",
-        "fiscal_line_ids.amount_tax",
-        "fiscal_line_ids.amount_taxed",
-        "fiscal_line_ids.amount_total",
-        "fiscal_line_ids.financial_total",
-        "fiscal_line_ids.financial_total_gross",
-        "fiscal_line_ids.financial_discount_value",
-        "fiscal_line_ids.amount_tax_included",
-        "fiscal_line_ids.amount_tax_not_included",
-        "fiscal_line_ids.amount_tax_withholding",
-    )
-    def _compute_fiscal_amount(self):
-        return super()._compute_fiscal_amount()
+    @api.model
+    def _get_fiscal_lines_field_name(self):
+        return "fiscal_line_ids"
 
     def unlink(self):
         forbidden_states_unlink = [
@@ -403,14 +438,12 @@ class Document(models.Model):
             if not fsc_op:
                 raise ValidationError(
                     _(
-                        "The fiscal operation {} has no return Fiscal "
-                        "Operation defined"
+                        "The fiscal operation {} has no return Fiscal Operation defined"
                     ).format(record.fiscal_operation_id)
                 )
 
             new_doc = record.copy()
             new_doc.fiscal_operation_id = fsc_op
-            new_doc._onchange_fiscal_operation_id()
 
             for line in new_doc.fiscal_line_ids:
                 fsc_op_line = line.fiscal_operation_id.return_fiscal_operation_id
@@ -422,9 +455,6 @@ class Document(models.Model):
                         ).format(line.fiscal_operation_id)
                     )
                 line.fiscal_operation_id = fsc_op_line
-                line._onchange_fiscal_operation_id()
-                line._onchange_fiscal_operation_line_id()
-
             return_docs |= new_doc
         return return_docs
 
@@ -469,152 +499,31 @@ class Document(models.Model):
         # see https://github.com/OCA/l10n-brazil/pull/3272
         pass
 
-    def _get_email_template(self, state):
-        self.ensure_one()
-        return self.document_type_id.document_email_ids.search(
-            [
-                "|",
-                ("state_edoc", "=", False),
-                ("state_edoc", "=", state),
-                ("issuer", "=", self.issuer),
-                "|",
-                ("document_type_id", "=", False),
-                ("document_type_id", "=", self.document_type_id.id),
-            ],
-            limit=1,
-            order="state_edoc, document_type_id",
-        ).mapped("email_template_id")
-
-    def send_email(self, state):
-        self.ensure_one()
-        email_template = self._get_email_template(state)
-        if email_template:
-            email_template.with_context(
-                default_attachment_ids=self._get_mail_attachment()
-            ).send_mail(self.id)
-
-    def _after_change_state(self, old_state, new_state):
-        self.ensure_one()
-        result = super()._after_change_state(old_state, new_state)
-        self.send_email(new_state)
-        return result
-
-    @api.onchange("fiscal_operation_id")
-    def _onchange_fiscal_operation_id(self):
-        result = super()._onchange_fiscal_operation_id()
-        if self.fiscal_operation_id:
-            self.fiscal_operation_type = self.fiscal_operation_id.fiscal_operation_type
-            self.edoc_purpose = self.fiscal_operation_id.edoc_purpose
-
-        if self.issuer == DOCUMENT_ISSUER_COMPANY and not self.document_type_id:
-            self.document_type_id = self.company_id.document_type_id
-
-        subsequent_documents = [(6, 0, {})]
-        for subsequent_id in self.fiscal_operation_id.mapped(
-            "operation_subsequent_ids"
-        ):
-            subsequent_documents.append(
-                (
-                    0,
-                    0,
-                    {
-                        "source_document_id": self.id,
-                        "subsequent_operation_id": subsequent_id.id,
-                        "fiscal_operation_id": subsequent_id.subsequent_operation_id.id,
-                    },
-                )
-            )
-        self.document_subsequent_ids = subsequent_documents
-        return result
+    @api.depends("fiscal_operation_id")
+    def _compute_edoc_purpose(self):
+        for record in self:
+            record.edoc_purpose = record.fiscal_operation_id.edoc_purpose
 
-    def _prepare_referenced_subsequent(self, doc_referenced):
-        self.ensure_one()
+    def __document_comment_vals(self):
         return {
-            "document_id": self.id,
-            "document_related_id": doc_referenced.id,
-            "document_type_id": doc_referenced.document_type_id.id,
-            "document_serie": doc_referenced.document_serie,
-            "document_number": doc_referenced.document_number,
-            "document_date": doc_referenced.document_date,
-            "document_key": doc_referenced.document_key,
+            "user": self.env.user,
+            "ctx": self._context,
+            "doc": self,
         }
 
-    def _document_reference(self, documents_referenced):
-        self.ensure_one()
-        for doc_referenced in documents_referenced:
-            self.env["l10n_br_fiscal.document.related"].create(
-                self._prepare_referenced_subsequent(doc_referenced)
+    def _document_comment(self):
+        for d in self:
+            # Fiscal Comments
+            d.fiscal_additional_data = d.comment_ids.filtered(
+                lambda c: c.comment_type == COMMENT_TYPE_FISCAL
+            ).compute_message(
+                d.__document_comment_vals(), d.manual_fiscal_additional_data
             )
 
-    @api.depends("document_subsequent_ids.subsequent_document_id")
-    def _compute_document_subsequent_generated(self):
-        for document in self:
-            if not document.document_subsequent_ids:
-                document.document_subsequent_generated = False
-            else:
-                document.document_subsequent_generated = all(
-                    subsequent_id.operation_performed
-                    for subsequent_id in document.document_subsequent_ids
-                )
-
-    def _generates_subsequent_operations(self):
-        for record in self.filtered(lambda doc: not doc.document_subsequent_generated):
-            for subsequent_id in record.document_subsequent_ids.filtered(
-                lambda doc_sub: doc_sub._confirms_document_generation()
-            ):
-                subsequent_id.generate_subsequent_document()
-
-    def cancel_edoc(self):
-        self.ensure_one()
-        if any(
-            doc.state_edoc == SITUACAO_EDOC_AUTORIZADA
-            for doc in self.document_subsequent_ids.mapped("document_subsequent_ids")
-        ):
-            message = _(
-                "Canceling the document is not allowed: one or more "
-                "associated documents have already been authorized."
+            # Commercial Comments
+            d.customer_additional_data = d.comment_ids.filtered(
+                lambda c: c.comment_type == COMMENT_TYPE_COMMERCIAL
+            ).compute_message(
+                d.__document_comment_vals(), d.manual_customer_additional_data
             )
-            raise UserWarning(message)
-
-    def _get_mail_attachment(self):
-        self.ensure_one()
-        attachment_ids = []
-        if self.state_edoc == SITUACAO_EDOC_AUTORIZADA:
-            if self.file_report_id:
-                attachment_ids.append(self.file_report_id.id)
-            if self.authorization_file_id:
-                attachment_ids.append(self.authorization_file_id.id)
-        return attachment_ids
-
-    def action_send_email(self):
-        """Open a window to compose an email, with the fiscal document_type
-        template message loaded by default
-        """
-        self.ensure_one()
-        template = self._get_email_template(self.state)
-        compose_form = self.env.ref("mail.email_compose_message_wizard_form", False)
-        lang = self.env.context.get("lang")
-        if template and template.lang:
-            lang = template._render_template(template.lang, self._name, [self.id])
-        self = self.with_context(lang=lang)
-        ctx = dict(
-            default_model="l10n_br_fiscal.document",
-            default_res_id=self.id,
-            default_use_template=bool(template),
-            default_attachment_ids=self._get_mail_attachment(),
-            default_template_id=template and template.id or False,
-            default_composition_mode="comment",
-            model_description=self.document_type_id.name or self._name,
-            force_email=True,
-        )
-        return {
-            "name": _("Send Fiscal Document Email Notification"),
-            "type": "ir.actions.act_window",
-            "view_type": "form",
-            "view_mode": "form",
-            "res_model": "mail.compose.message",
-            "views": [(compose_form.id, "form")],
-            "view_id": compose_form.id,
-            "target": "new",
-            "context": ctx,
-        }
+            d.fiscal_line_ids._document_comment()

odoo/addons/l10n_br_fiscal/models/document_line.py

@@ -1,10 +1,25 @@
 # Copyright (C) 2013  Renato Lima - Akretion
 # License AGPL-3 - See http://www.gnu.org/licenses/agpl-3.0.html
 
-from odoo import fields, models
+from odoo import api, fields, models
 
 
 class DocumentLine(models.Model):
+    """
+    Represents a line item within a Brazilian fiscal document.
+
+    This model defines the core structure of a fiscal document line,
+    primarily linking it to its parent document (`l10n_br_fiscal.document`)
+    and holding essential line-specific data like quantity and a
+    descriptive name.
+
+    The vast majority of detailed fiscal fields (e.g., product, NCM,
+    CFOP, various tax bases and values) and their complex computation
+    logic are inherited from `l10n_br_fiscal.document.line.mixin`.
+    This delegation ensures code reusability and keeps this model
+    focused on its direct relationships and core line properties.
+    """
+
     _name = "l10n_br_fiscal.document.line"
     _inherit = "l10n_br_fiscal.document.line.mixin"
     _description = "Fiscal Document Line"
@@ -15,12 +30,18 @@ class DocumentLine(models.Model):
         ondelete="cascade",
     )
 
-    name = fields.Text()
+    name = fields.Char(
+        compute="_compute_name",
+        store=True,
+        precompute=True,
+        readonly=False,
+    )
 
     company_id = fields.Many2one(
         comodel_name="res.company",
         related="document_id.company_id",
         store=True,
+        precompute=True,
         string="Company",
     )
 
@@ -29,13 +50,36 @@ class DocumentLine(models.Model):
     )
 
     partner_id = fields.Many2one(
-        related="document_id.partner_id",
+        comodel_name="res.partner",
+        compute="_compute_partner_id",
         store=True,
+        precompute=True,
+        readonly=False,
     )
 
-    quantity = fields.Float(default=1.0)
+    # Do not depend on `document_id.partner_id`, the inverse is taking care of that
+    def _compute_partner_id(self):
+        for line in self:
+            line.partner_id = line.document_id.partner_id
+
+    uom_id = fields.Many2one(
+        comodel_name="uom.uom",
+        string="UOM",
+        compute="_compute_uom_id",
+        store=True,
+        readonly=False,
+        precompute=True,
+    )
 
-    ind_final = fields.Selection(related="document_id.ind_final")
+    price_unit = fields.Float(
+        digits="Product Price",
+        compute="_compute_price_unit_fiscal",
+        store=True,
+        precompute=True,
+        readonly=False,
+    )
+
+    quantity = fields.Float(default=1.0)
 
     # Usado para tornar Somente Leitura os campos dos custos
     # de entrega quando a definição for por Total
@@ -50,3 +94,36 @@ class DocumentLine(models.Model):
     edoc_purpose = fields.Selection(
         related="document_id.edoc_purpose",
     )
+
+    additional_data = fields.Text()
+
+    @api.depends("product_id")
+    def _compute_name(self):
+        for line in self:
+            if line.product_id:
+                line.name = line.product_id.display_name
+            else:
+                line.name = False
+
+    @api.depends("product_id")
+    def _compute_uom_id(self):
+        for line in self:
+            if line.fiscal_operation_type == "in":
+                line.uom_id = line.product_id.uom_po_id
+            else:
+                line.uom_id = line.product_id.uom_id
+
+    def __document_comment_vals(self):
+        self.ensure_one()
+        return {
+            "user": self.env.user,
+            "ctx": self._context,
+            "doc": self.document_id if hasattr(self, "document_id") else None,
+            "item": self,
+        }
+
+    def _document_comment(self):
+        for line in self:
+            line.additional_data = line.comment_ids.compute_message(
+                line.__document_comment_vals(), line.manual_additional_data
+            )