Metadata-Version: 2.1
Name: odoo-addon-l10n_br_fiscal_dfe
Version: 16.0.2.0.0
Requires-Python: >=3.10
Requires-Dist: odoo-addon-l10n_br_fiscal>=16.0dev,<16.1dev
Requires-Dist: odoo-addon-queue_job>=16.0dev,<16.1dev
Requires-Dist: odoo>=16.0a,<16.1dev
Summary: Generic framework to monitor incoming electronic fiscal documents via the Sefaz DF-e distribution web service.
Home-page: https://github.com/OCA/l10n-brazil
License: AGPL-3
Author: Engenere, KMEE, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 16.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
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

======================
Monitor de DF-e (Base)
======================

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

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fl10n--brazil-lightgray.png?logo=github
    :target: https://github.com/OCA/l10n-brazil/tree/16.0/l10n_br_fiscal_dfe
    :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-16-0/l10n-brazil-16-0-l10n_br_fiscal_dfe
    :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=16.0
    :alt: Try me on Runboat

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

Framework genérico para monitoramento de documentos fiscais eletrônicos
recebidos via os web services de Distribuição de DF-e da SEFAZ (Ambiente
Nacional).

Este módulo é **agnóstico ao tipo de documento fiscal**: ele implementa
toda a lógica comum de distribuição DF-e — paginação de NSUs,
agendamento inteligente baseado na resposta da SEFAZ (138, 137, 656),
desduplicação, notificações, logs SOAP e o painel (banner) —
parametrizado por tipo de documento (``fiscal_type``).

Os módulos específicos implementam apenas o que é particular de cada
documento fiscal:

- ``l10n_br_nfe_dfe`` — DF-e de NF-e (NFeDistribuicaoDFe, `NT
  2014.002 <https://www.nfe.fazenda.gov.br/portal/exibirArquivo.aspx?conteudo=P0U3lU1Fe40=>`__)
- ``l10n_br_cte_dfe`` — DF-e de CT-e (CTeDistribuicaoDFe) — futuro

Funcionalidades genéricas:

- **Motor de distribuição** em ``res.company``, parametrizado por
  ``fiscal_type`` (campos ``{fiscal_type}_last_nsu``,
  ``{fiscal_type}_max_nsu``, ``{fiscal_type}_dfe_last_query``, etc.
  definidos pelos módulos específicos)
- **Modelos genéricos**: ``l10n_br_fiscal_dfe.dfe`` (payload XML por
  NSU) e ``l10n_br_fiscal_dfe.document`` (documento agrupado por chave
  de acesso)
- **Consulta manual** — assistente de busca específica por chave de
  acesso (com validação do dígito verificador) ou por NSU
- **Painel (banner)** genérico exibido nas visões dos módulos
  específicos via ``banner_route``
- **Notificações no Inbox** — notifica usuários sobre novos documentos
  de terceiros (preferência por usuário)
- **Matching automático de parceiro** pelo CNPJ da chave de acesso
- **Log de distribuição** com request/response SOAP para depuração
- **Suporte multi-empresa** com record rules
- **Canal queue_job** ``root.dfe`` para as consultas automáticas

**Table of contents**

.. contents::
   :local:

Installation
============

Dependências Python
-------------------

- ``erpbrasil.base`` — validação de chave de acesso (dígito verificador)

Os módulos específicos declaram suas próprias dependências (ex.:
``l10n_br_nfe_dfe`` requer ``nfelib`` e ``brazilfiscalreport``).

queue_job como server wide module
---------------------------------

O ``queue_job`` precisa ser carregado na inicialização do Odoo. Adicione
na configuração do servidor:

.. code:: ini

   [options]
   server_wide_modules = web,queue_job

Ou via variável de ambiente:

::

   SERVER_WIDE_MODULES=web,queue_job

Em produção, o Odoo deve rodar com ``workers > 0`` para que o jobrunner
inicie como processo dedicado.

Com ``--workers=0`` (modo threaded / desenvolvimento), o queue_job
funciona normalmente — ele cria uma thread extra no mesmo processo.

Configuration
=============

Canal queue_job
---------------

O módulo registra os jobs de distribuição DF-e no canal ``root.dfe``. É
**obrigatório** configurar este canal com capacidade máxima de **1 job
simultâneo**, caso contrário consultas concorrentes à SEFAZ podem causar
erro 656 (consumo indevido) e bloqueio temporário do CNPJ.

No arquivo de configuração do Odoo:

.. code:: ini

   [queue_job]
   channels = root:2,root.dfe:1

Ou via variável de ambiente:

::

   ODOO_QUEUE_JOB_CHANNELS=root:2,root.dfe:1

Configuração da empresa
-----------------------

A configuração por empresa (ambiente, busca automática, NSU, etc.) é
feita nos módulos específicos de cada documento fiscal (ex.: aba **NF-e
DF-e** do módulo ``l10n_br_nfe_dfe``).

Notificações
------------

Cada usuário pode ativar a preferência **DF-e Notification** em
**Preferências** para receber notificações no Inbox quando novos
documentos de terceiros forem encontrados.

Usage
=====

Este módulo é uma base técnica. O uso funcional acontece nos módulos
específicos de cada documento fiscal:

- **NF-e**: instale ``l10n_br_nfe_dfe`` e acesse **Faturamento >
  Consultas DF-e > NF-e de Terceiros**.

O menu **Faturamento > Consultas DF-e** também dá acesso às visões
genéricas (todos os documentos, registros DF-e brutos e logs de
distribuição) para depuração.

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_fiscal_dfe%0Aversion:%2016.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
-------

* Engenere
* KMEE

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

- `Engenere <https://engenere.one>`__:

  - Felipe Motter <felipe@engenere.one>
  - Antônio Neto <neto@engenere.one>
  - Cristiano Mafra Junior

- `KMEE <https://www.kmee.com.br>`__:

  - Luis Felipe Miléo <mileo@kmee.com.br>
  - Gabriel Cardoso <gabriel.cardoso@kmee.com.br>
  - Felipe Zago <felipe.zago@kmee.com.br>

- `Akretion <https://akretion.com>`__:

  - Raphaël Valyi <rvalyi@akretion.com>

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-felipemotter| image:: https://github.com/felipemotter.png?size=40px
    :target: https://github.com/felipemotter
    :alt: felipemotter
.. |maintainer-antoniospneto| image:: https://github.com/antoniospneto.png?size=40px
    :target: https://github.com/antoniospneto
    :alt: antoniospneto
.. |maintainer-rvalyi| image:: https://github.com/rvalyi.png?size=40px
    :target: https://github.com/rvalyi
    :alt: rvalyi

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

|maintainer-felipemotter| |maintainer-antoniospneto| |maintainer-rvalyi| 

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

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