Skip to main content
Odoo Community Association

Monitor de DF-e (Base)

Beta License: AGPL-3 OCA/l10n-brazil Translate me on Weblate Try me on Runboat

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)

  • 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

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:

[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:

[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. 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.

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

Credits

Authors

  • Engenere

  • KMEE

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Current maintainers:

felipemotter antoniospneto rvalyi

This module is part of the OCA/l10n-brazil project on GitHub.

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

Release files for odoo-addon-l10n-br-fiscal-dfe 16.0.2.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo-addon-l10n-br-fiscal-dfe 16.0.2.0.0
File Interpreter ABI Platform
odoo_addon_l10n_br_fiscal_dfe-16.0.2.0.0-py3-none-any.whl Python 3 none any Details

Release files / odoo_addon_l10n_br_fiscal_dfe-16.0.2.0.0-py3-none-any.whl

Download URL odoo_addon_l10n_br_fiscal_dfe-16.0.2.0.0-py3-none-any.whl
Size 68.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6a99aa06ec1cf47b1790d28d661365b3415f7f5a98d9ccfa0aa29867ff5a971
BLAKE2b-256 checksum
How to use checksums
afc0917b30e9ad18ea82a7e3966495ffbc2abb64a2aad9d888095f7867eb1b17
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page