Metadata-Version: 2.1
Name: odoo-addon-l10n_br_cte_spec
Version: 17.0.1.1.0
Requires-Python: >=3.10
Requires-Dist: odoo>=17.0a,<17.1dev
Summary: CT-e abstract models generated by xsdata-odoo from the official xsd
Home-page: https://github.com/OCA/l10n-brazil
License: LGPL-3
Author: Akretion, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 17.0
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Development Status :: 5 - Production/Stable
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

====================
CT-e abstract models
====================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:3fc7ca2e7053bd04ec47342cadf93b5af1ba8e72b0fd5859e99a26c62cf5b489
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
    :target: https://odoo-community.org/page/development-status
    :alt: Production/Stable
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
    :alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fl10n--brazil-lightgray.png?logo=github
    :target: https://github.com/OCA/l10n-brazil/tree/17.0/l10n_br_cte_spec
    :alt: OCA/l10n-brazil
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/l10n-brazil-17-0/l10n-brazil-17-0-l10n_br_cte_spec
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/l10n-brazil&target_branch=17.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

Este módulo é a fundação para a emissão do Conhecimento de Transporte
Eletrônico (``CT-e``, ``Modelo 57``) no Odoo. Ele fornece a estrutura de
dados completa e atualizada, em conformidade com os leiautes oficiais da
SEFAZ para o CT-e 4.0.

É importante ressaltar que este módulo não realiza a emissão do CT-e
sozinho. Ele funciona como uma biblioteca de modelos de dados abstratos
(mixins). A sua principal função é servir de base para um módulo de
implementação, como o ``l10n_br_cte``, que é responsável por mapear
esses modelos nos documentos fiscais do Odoo
(``l10n_br_fiscal.document``), adicionar as regras de negócio e realizar
a comunicação com os web services da SEFAZ. Essa arquitetura desacoplada
segue o mesmo padrão de sucesso já utilizado pelos módulos
``l10n_br_nfe_spec`` e ``l10n_br_nfe``.

Estrutura por Modal de Transporte
---------------------------------

Para garantir a conformidade com as particularidades de cada operação, o
módulo implementa modelos de dados específicos para todos os modais de
transporte previstos na legislação:

- Rodoviário (``cte.40.rodo``): Contempla informações essenciais como o
  RNTRC e as Ordens de Coleta associadas.
- Aéreo (``cte.40.aereo``): Inclui campos para o número da minuta, o
  número operacional do conhecimento aéreo (IATA) e detalhes sobre a
  natureza e periculosidade da carga.
- Aquaviário (``cte.40.aquav``): Aborda dados como o valor do AFRMM, a
  identificação do navio, informações de balsas e o detalhamento de
  contêineres.
- Ferroviário (``cte.40.ferrov``): Permite detalhar o tipo de tráfego
  (próprio, mútuo, etc.) e as ferrovias envolvidas na operação.
- Dutoviário (``cte.40.duto``): Contém campos para o valor da tarifa, as
  datas de início e fim do serviço e as características do duto.
- Multimodal (``cte.40.multimodal``): Estruturado para gerenciar o
  Certificado do Operador de Transporte Multimodal (COTM) e as
  informações de seguro associadas.

Geração de Código Automatizada
------------------------------

A principal característica deste módulo é que 100% dos seus modelos de
dados Odoo são gerados automaticamente a partir dos esquemas XSD
oficiais, publicados pelo Portal do CT-e. Essa geração pelo
``xsdata-odoo`` garante máxima fidelidade aos leiautes fiscais e
agilidade na atualização para novas versões.

Embora os esquemas XSD oficiais do CT-e sejam publicados e mantidos no
Portal da SEFAZ, a arquitetura deste projeto se apoia na biblioteca
``nfelib`` para a tarefa de serialização dos dados em XML. Para
facilitar o processo de desenvolvimento e garantir a consistência, a
própria ``nfelib`` armazena em seu repositório uma cópia atualizada
desses esquemas oficiais.

Portanto, a prática recomendada para (re)gerar os modelos deste módulo é
utilizar um clone local do repositório da nfelib como fonte para os
arquivos de esquema (.xsd), direcionando o comando do ``xsdata-odoo``
para o diretório correspondente.

Links:

- `GitHub -
  akretion/xsdata-odoo <https://github.com/akretion/xsdata-odoo>`__
- `GitHub - akretion/nfelib <https://github.com/akretion/nfelib>`__

O comando utilizado para gerar os modelos da versão 4.0 do CT-e foi:

.. code:: bash

   git clone https://github.com/akretion/nfelib
   cd nfelib
   export XSDATA_SCHEMA=cte
   export XSDATA_VERSION=40
   export XSDATA_SKIP="^ICMS\d+|^ICMSSN+|ICMSOutraUF|ICMSUFFim|INFESPECIE_TPESPECIE"
   export XSDATA_LANG="portuguese"

   xsdata generate nfelib/cte/schemas/v4_0 \
     --package nfelib.cte.odoo.v4_0 \
     --output=odoo

Prefixo dos campos e versão
---------------------------

Com mais de 1000 campos fiscais apenas no CT-e, com uma meia dúzia de
documentos fiscais complexos, com 3000 módulos OCA, existiria um risco
real de conflito com os nomes de campos vindo dos esquemas. Além disso,
temos várias versões do CT-e, a 3.0, a 4.0...

Nisso foi decidido que cada campo tem um prefixo composto do nome do
schema e de alguns dígitos da versão do esquema. No caso cte40\_. A
escolha de 2 dígitos permite que uma atualização menor do esquema use os
mesmos campos (e dados no banco então) e que um simples update Odoo
(--update=...) consiga resolver a migração. Enquanto que para uma
mudança maior como de 3.0 para 4.0, seria assumido de usar novos campos
e novas tabelas (para os objetos não Odoo) e que a lib nfelib iria
trabalhar com os campos da versão maior do documento fiscal considerado.

**Table of contents**

.. contents::
   :local:

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/l10n-brazil/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/l10n-brazil/issues/new?body=module:%20l10n_br_cte_spec%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Akretion

Contributors
------------

- `AKRETION <https://akretion.com/pt-BR/>`__:

  - Raphaël Valyi <raphael.valyi@akretion.com.br>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

.. |maintainer-rvalyi| image:: https://github.com/rvalyi.png?size=40px
    :target: https://github.com/rvalyi
    :alt: rvalyi

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-rvalyi| 

This module is part of the `OCA/l10n-brazil <https://github.com/OCA/l10n-brazil/tree/17.0/l10n_br_cte_spec>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
