CTeDistribuicaoDFe: Acesso Facilitado a DF-e para Atores do CT-e
Acesse documentos fiscais eletrônicos relevantes via Web Service CTeDistribuicaoDFe. Otimize a gestão fiscal e logística da sua empresa com dados rápidos e seguros.
CTeDistribuicaoDFe: Acesso Facilitado a DF-e para Atores do CT-e
O projeto Conhecimento de Transporte Eletrônico (CT-e) busca prover informações eficientes e confiáveis aos envolvidos em seus processos. Para atender a essa demanda, foi desenvolvido o Web Service CTeDistribuicaoDFe, que disponibiliza documentos fiscais eletrônicos (DF-e) de interesse aos atores do CT-e. Este serviço permite acesso facilitado a informações essenciais para a gestão fiscal e logística.
O Serviço CTeDistribuicaoDFe
A Nota Técnica 2015/002 apresenta o Web Service CTeDistribuicaoDFe, uma ferramenta destinada à distribuição de documentos e informações de DF-e para pessoas físicas ou jurídicas envolvidas no CT-e. O serviço opera de forma síncrona, utilizando o método cteDistDFeInteresse.
Este serviço permite que qualquer ator do CT-e, seja Pessoa Jurídica ou Pessoa Física, com certificado digital, acesse DF-e de seu interesse que não tenham sido gerados por ele. Para Pessoas Jurídicas, a autenticação ocorre pelo CNPJ base, permitindo consultas com qualquer CNPJ da empresa, desde que o CNPJ base consultado seja o mesmo do certificado digital.
Os documentos fiscais eletrônicos ficam disponíveis para distribuição por até três meses após sua recepção pelo Ambiente Nacional do CT-e. A distribuição é realizada para os seguintes atores e seus respectivos papéis:
- Emitente: Grupo
emit - Remetente: Grupo
rem - Destinatário: Grupo
dest - Expedidor: Grupo
exped - Recebedor: Grupo
receb - Tomador: Grupo
toma4 - Terceiros: Pessoas autorizadas a acessar o XML, informadas na tag
autXML.
Para preservar o sigilo fiscal de documentos como NF-e e CT-e relacionados nos grupos infDoc, docAntEle ou refCTe, o XML retornado para terceiros (autXML) tem as chaves de acesso alteradas para o literal 99999999999999999999999999999999999999999999. Para os demais atores, o XML retornado é o original, sem alterações.
Os prazos para a entrada em vigor da Nota Técnica 2015/002 foram:
* Ambiente de Homologação (testes): 01/07/2015
* Ambiente de Produção: 01/08/2015
Documentos Disponíveis para Distribuição
O serviço CTeDistribuicaoDFe disponibiliza diferentes tipos de documentos e eventos para os atores, conforme a tabela abaixo:
| Documento | Emitente | Remetente, Destinatário, Recebedor, Expedidor, Tomador | Terceiros¹ |
|---|---|---|---|
| CT-e | Não | Sim | Sim |
| Evento de Cancelamento | Não | Sim | Sim |
| Evento de Carta de Correção | Não | Sim | Sim |
| EPEC (Evento Prévio de Emissão) | Não | Sim | Não |
| Eventos MDF-e Autorizado/Cancelado | Sim | Sim | Não |
¹ O CT-e é disponibilizado para terceiros somente se seu CNPJ ou CPF estiver informado no grupo autXML. Nesses casos, as chaves de acesso de CT-e e NF-e relacionadas no CT-e distribuído são alteradas para preservar o sigilo fiscal.
Estrutura das Mensagens
A comunicação com o Web Service CTeDistribuicaoDFe utiliza mensagens XML padronizadas tanto para a requisição quanto para o retorno das informações.
Leiaute da Mensagem de Entrada
O pedido de distribuição de DF-e é realizado através de uma estrutura XML baseada no schema distDFeInt_v9.99.xsd. Os campos principais são:
distDFeInt(A01): Tag raiz da mensagem.versao(A02): Versão do leiaute.tpAmb(A03): Identificação do ambiente (1 para Produção, 2 para Homologação).cUFAutor(A04): Código da Unidade da Federação do autor.CNPJ(A05) /CPF(A06): CNPJ ou CPF do interessado no DF-e. Um desses campos deve ser informado.distNSU(A07): Grupo para solicitar a distribuição de um conjunto de DF-e.ultNSU(A08): Último Número Sequencial Único (NSU) recebido pelo ator. Se informado com zero ou um NSU antigo, a consulta retorna documentos recebidos nos últimos três meses.
consNSU(A09): Grupo para consultar um DF-e específico a partir de um NSU.NSU(A10): Número Sequencial Único do documento desejado, geralmente usado para preencher lacunas na base de dados do interessado.
Leiaute da Mensagem de Retorno
A resposta do Web Service é uma estrutura XML que pode conter até 50 documentos de interesse do ator, baseada no schema retDistDFeInt_v9.99.xsd. Campos relevantes incluem:
retDistDFeInt(B01): Tag raiz da resposta.versao(B02): Versão do leiaute de retorno.tpAmb(B03): Ambiente de identificação.verAplic(B04): Versão do aplicativo que processou a consulta.cStat(B05): Código do status da resposta.xMotivo(B06): Descrição literal do status.dhResp(B07): Data e hora da mensagem de resposta.ultNSU(B08): Último NSU pesquisado no Ambiente Nacional. O solicitante pode usá-lo para continuar a consulta.maxNSU(B09): Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado.loteDistDFeInt(B10): Conjunto de informações de DF-e de interesse.docZip(B11): Informação do documento fiscal eletrônico compactado no padrão Gzip (base64Binary).NSU(B12): NSU do documento fiscal.schema(B13): Identificação do Schema XML para validação do documento, indicando tipo e versão (ex:procCTe_v2.00.xsd).
Mensagem de Retorno Compactada
Para otimizar o uso da infraestrutura de rede, cada documento contido na mensagem de retorno é compactado individualmente na tag docZip utilizando o padrão Gzip. Estima-se que essa compactação reduza o tamanho da mensagem em aproximadamente 60%. A aplicação cliente deve descompactar cada documento e processá-lo normalmente. O Gzip é um padrão amplamente suportado em plataformas como Java e .NET.
Processo de Distribuição de DF-e de Interesse
O Web Service CTeDistribuicaoDFe pode ser consumido por diversos atores do CT-e (emitente, remetente, destinatário, expedidor, recebedor, tomador ou terceiro), sendo Pessoa Física ou Jurídica, mediante o uso de um certificado digital válido (CPF para PF, CNPJ para PJ).
O Ambiente Nacional gera um Número Sequencial Único (NSU) para cada interessado nos documentos fiscais, garantindo uma sequência sem intervalos na base de dados do destinatário.
Geração do Pedido de Distribuição
O XML do pedido de distribuição suporta dois tipos de consultas, definidas pelas tags distNSU e consNSU.
distNSU: Distribuição de Conjunto de DF-e a Partir do NSU Informado
Neste modo, a aplicação cliente informa o último NSU que possui (ultNSU). Se o NSU fornecido for menor que o primeiro NSU disponível para distribuição, o Ambiente Nacional entrega os documentos a partir do primeiro NSU disponível.
consNSU: Distribuição de DF-e Vinculado ao NSU Informado
Esta consulta é utilizada para recuperar DF-e de maneira pontual, quando um NSU é identificado como faltante na base de dados do interessado. A aplicação cliente informa o NSU específico desejado.
Informação do CNPJ ou CPF
É necessário informar o CPF da pessoa ou CNPJ da empresa para a recuperação dos DF-e. Este campo permite que uma empresa recupere DF-e de qualquer um de seus estabelecimentos usando um único certificado digital de Pessoa Jurídica.
Envio das Informações
O pedido de distribuição é enviado via Web Service, exigindo um certificado digital de PJ ou PF válido. A aplicação cliente envia uma mensagem que segue os padrões estabelecidos na nota técnica ao Ambiente Nacional.
Processamento de Requisições
O Web Service do Ambiente Nacional processa as requisições de distribuição e retorno de DF-e.
Processamento de Requisição de Conjunto de DF-e (distNSU)
O Web Service gera lotes com até 50 documentos para o interessado, contendo informações de DF-e com NSU superior ao informado. Se o NSU fornecido for menor que o primeiro NSU disponível, o Ambiente Nacional entrega os documentos a partir do primeiro.
A criação do lote de documentos segue estas regras:
* Ordem crescente de NSU.
* Pode conter qualquer tipo de documento e seu respectivo NSU.
* Quantidade máxima de 50 documentos por lote.
Documentos emitidos pela própria empresa não estão disponíveis para consulta por esse serviço. O processo de recepção e sincronização não garante ordem cronológica de emissão ou autorização de uso, mas sim a ordem cronológica de recepção pelo Ambiente Nacional.
É recomendável manter um controle do primeiro NSU válido para consulta. A resposta do Web Service pode ser:
* Rejeição: Com a devolução da mensagem e o motivo da falha no cStat.
* cStat='137-Nenhum documento localizado': Nenhum documento fiscal para o CNPJ/CPF informado.
* cStat='138-Documento localizado': Com a devolução dos documentos fiscais encontrados.
Se o ultNSU informado for igual ao maxNSU do Ambiente Nacional, significa que não há mais documentos a serem pesquisados no momento. Nesses casos, a empresa deve aguardar um tempo mínimo de uma hora antes de efetuar uma nova solicitação para evitar consumo indevido.
Processamento de Requisição de DF-e por NSU Específico (consNSU)
Considerando que o Ambiente Nacional gera NSUs sem lacunas, a identificação de uma lacuna na base de dados do interessado indica uma falha no processo de distribuição. Nesses casos, o interessado deve consultar pontualmente os NSUs faltantes através do método cteDistDFeInteresse, informando o NSU desejado na tag consNSU do XML de requisição.
A resposta do Web Service pode ser:
* Rejeição: Com a devolução da mensagem e o motivo da falha no cStat.
* cStat='137-Nenhum documento localizado': Indicando que o Ambiente Nacional não gerou o NSU, devendo o interessado desconsiderá-lo.
* cStat='138-Documento localizado': Com a devolução do documento fiscal encontrado.
Validações no Serviço
O Web Service CTeDistribuicaoDFe aplica diversas validações para garantir a segurança e a integridade das operações.
Validação do Certificado de Transmissão
As regras de validação do certificado digital do transmissor garantem sua autenticidade e validade. A maioria dessas validações é realizada pelo protocolo SSL. As principais verificações incluem:
- A01: Validade do certificado (versão, Basic Constraint, KeyUsage).
- A02: Período de validade do certificado.
- A03: Cadeia de certificação (certificado da AC emissora, revogação).
- A04: Lista de Certificados Revogados (LCR) do certificado.
- A05: Status de revogação do certificado.
- A06: Certificado Raiz da ICP-Brasil.
- A07: Extensões de CNPJ (OID=2.16.76.1.3.3) ou CPF (OID=2.16.76.1.3.1) no certificado.
Validação Inicial da Mensagem no Web Service
Antes de processar o conteúdo, a mensagem passa por validações preliminares:
- B01: Tamanho do XML de dados não deve exceder 10 KB. Mensagens maiores podem ser descartadas.
- B02/B03: Verificação se o servidor de processamento está paralisado momentaneamente ou sem previsão.
Validação da Área de Dados
A área de dados da mensagem é submetida a validações de forma e de regras de negócio.
Validação de Forma
- D01: Verificação do Schema XML da área de Dados.
- D02: Verificação do uso de prefixo no namespace.
- D03: O XML deve utilizar codificação UTF-8.
- D04/D05: Validação da versão dos dados informada (não pode ser superior à vigente ou não suportada).
Validação de Regras de Negócio
- H01: O tipo de ambiente do CT-e deve ser o mesmo do Web Service.
- H02/H03: CNPJ ou CPF do interessado na distribuição deve ser válido (sem DV inválido ou zeros).
- H04: O CNPJ base do certificado digital utilizado na transmissão deve ser o mesmo do CNPJ consultado.
- H05: O CPF do certificado digital utilizado deve ser o mesmo do CPF consultado.
- H06: O NSU informado não pode ser superior ao maior NSU disponível para consulta.
Visão Geral do Modelo de Distribuição
O modelo de distribuição baseia-se na geração de um Número Sequencial Único (NSU) para cada CNPJ ou CPF, a cada documento ou evento relacionado ao CT-e que é recebido pelo Ambiente Nacional.
O fluxo simplificado ocorre da seguinte forma:
1. Um emitente gera e transmite um CT-e, que é autorizado pela Sefaz e compartilhado com o Ambiente Nacional.
2. O Ambiente Nacional gera um NSU para o emitente, destinatário e cada papel relacionado no CT-e, disponibilizando-o para consulta.
3. O destinatário consulta o Web Service CTeDistribuicaoDFe a partir do último NSU recebido e recupera o XML do CT-e.
4. O emitente gera um evento para seu CT-e (ex: cancelamento), que é compartilhado com o Ambiente Nacional.
5. O Ambiente Nacional gera um NSU para cada papel relacionado com o CT-e para o evento e o disponibiliza para consulta.
6. O destinatário consulta o Web Service CTeDistribuicaoDFe a partir do último NSU recebido e recupera o evento.
7. O Ambiente Nacional recebe um evento gerado pelo fisco e gera NSUs para os envolvidos.
8. Emitente e destinatário consultam o Web Service CTeDistribuicaoDFe para recuperar o evento do fisco.
Recomendações para Evitar Uso Indevido
Para evitar sobrecarga nos ambientes autorizadores, o Web Service CTeDistribuicaoDFe possui controles para identificar situações de "consumo indevido". Aplicações que entram em "loop" de busca de registros já disponibilizados anteriormente podem ter suas novas tentativas rejeitadas com o erro 656-Rejeição: Consumo Indevido. É fundamental que as aplicações clientes gerenciem corretamente as consultas para otimizar o uso dos recursos e evitar esse tipo de rejeição.
Endereço do Web Service
Os endereços dos Web Services de distribuição, tanto para o Ambiente Nacional de Produção quanto para o de Homologação, estão publicados no Portal do CT-e.
* Produção: http://www.cte.fazenda.gov.br/portal, link 'Serviços' / 'Relação de Serviços Web'.
* Homologação: http://hom.cte.fazenda.gov.br/portal, também no link 'Serviços' / 'Relação de Servios Web'.
Tabela de Códigos de Erros
A Nota Técnica 2015/002 detalha uma tabela completa de códigos de erros e descrições para o processamento das solicitações. Essa tabela auxilia desenvolvedores e usuários na identificação e correção de problemas, apresentando códigos para resultados de processamento (ex: 137 para "Nenhum documento localizado", 138 para "Documento localizado") e motivos de não atendimento da solicitação (ex: 214 para "Tamanho da mensagem excedeu o limite", 280 para "Certificado Transmissor inválido", 489 para "CNPJ informado inválido").
Conclusão
O Web Service CTeDistribuicaoDFe é um componente essencial para a transparência e eficiência na troca de informações fiscais eletrônicas relacionadas ao Conhecimento de Transporte Eletrônico. Ao centralizar a distribuição de DF-e e eventos, o serviço simplifica o acesso a documentos importantes para os diversos atores, garantindo o sigilo fiscal e promovendo a conformidade. Compreender o seu funcionamento e as regras de validação é fundamental para o uso adequado e contínuo desse recurso.