Com o PlugNotas, é possível consultar e importar de forma simplificada as notas que foram emitidas contra o CNPJ da empresa, contando com alguns processos automatizados. O objetivo dessa documentação é oferecer uma visão clara de como funciona o fluxo de consulta das notas destinadas.
Fluxo de Consulta de Destinadas
Seguindo o fluxo descrito, por parte da Software House é necessário cadastrar a empresa no PlugNotas e ativar a consulta automática das destinadas. Essas duas operações podem ser executadas por meio da interface web ou via API, utilizando a rota /empresa para o cadastro e, na mesma rota, incluir a propriedade nfe.config.dfe.ativo como TRUE para ativar a consulta de destinadas. Se a empresa já estiver cadastrada, basta ativar essa propriedade por meio da rota empresa/cnpj.
A comunicação com a SEFAZ para consulta das notas destinadas, a manifestação com a “Ciência da Operação” e o download do XML são automatizados pelo PlugNotas e ocorrem a cada intervalo de 1 hora e 20 minutos.
Para obter as notas destinadas completas, que foram retornadas pela SEFAZ, é possível configurar um webhook ou utilizar a rota de consulta específica para esse fluxo. Além disso, é necessário verificar no retorno se a nota foi manifestada para obter o XML completo. Caso a manifestação não tenha ocorrido, será retornado o motivo da rejeição, sendo necessário solicitar a manifestação por meio da rota /nfe/{idNota}/manifestacao.
Tipos de consulta:
- Somente com cpfCnpj, retorna todos os registros.
- cpfCnpj + manifestada = true, retorna todas as notas já manifestadas conclusivamente.
- cpfCnpj + manifestada = false, retorna todas as notas ainda não manifestadas conclusivamente.
- cpfCnpj + dataInicial + dataFinal, retorna todos os registros do período solicitado.
- cpfCnpj + status, retorna todos as notas com o status informado.
- cpfCnpj + status,status..., retorna todas as notas com os status informado.
Rota
GET
Produção
Sandbox
Headers
Nome | Descrição |
x-api-key | Header utilizado para autenticação. |
body - query Parameters;
Nome | Tipo | Descrição | Exemplo |
cpfCnpjrequired | string | CPF ou CNPJ da Empresa que está com a configuração de DFE ativada. | cpfCnpj=18187168000160 |
manifestada | boolean | Filtra por notas com manifestação conclusíva. | manifestada=false |
status | string | Filtra notas por status. Valores aceitos: 'CONCLUIDO', 'CANCELADO', 'DENEGADO'. Caso queira filtrar por mais de um status será necessário separar por vírgula. | status=CONCLUIDO,CANCELADO |
dataInicial | string <date> | Período inicial de consulta. | ataInicial=2020-09-01 |
dataFinal | string <date> | Período final de consulta. | dataFinal=2020-09-30 |
hashProximaPagina | string | Hash da próxima nota para paginação; | hashProximaPagina=604773edbeeb7d1d0c2dd7fa |
resume | boolean | Filtrar notas com xml completo ou resumido. Informando 'false' serão retornadas apenas notas com xml completo, e, caso for enviado 'true', retornaremos todas as notas, diferenciando-as com o campo "xmlCompleto". |
Retorno
Exemplo de retorno:
Para ver um exemplo de retorno da consulta, acesso nossa documentação completa da rota Consultar Notas Destinadas
Exemplo de retorno com erro:
Comentários
0 comentário
Por favor, entre para comentar.