Se a Nota Fiscal Eletrônica é algo novo para você, essa documentação pode ser bem útil.
Sobre a Nota Fiscal Eletrônica:
- O que é a Nota Fiscal Eletrônica
- Objetivos da funcionalidade NF-e
- Gerando arquivo de integração NF-e
- Fluxo de envio e consulta
- Fluxo utilizando WebHook
- Lista de Rotas NF-e
O que é Nota Fiscal Eletrônica
A nota fiscal eletrônica (NF-e) é um documento fiscal digital, utilizado para documentar operações de circulação de mercadorias.
Objetivos da Funcionalidade NF-e
- Redução de Custos: Eliminação do uso de papel, impressão, armazenamento físico e transporte de documentos fiscais, reduzindo custos operacionais para empresas e órgãos governamentais.
- Simplificação de Obrigações Acessórias: Redução da burocracia fiscal, facilitando o cumprimento das obrigações acessórias por parte das empresas.
- Aumento da Confiabilidade: Aumento da confiabilidade da documentação fiscal, uma vez que a NF-e é emitida e armazenada eletronicamente, dificultando a falsificação e possibilitando consultas online para validação.
- Combate à Sonegação Fiscal: Melhora na fiscalização tributária, proporcionando maior controle sobre as operações comerciais e dificultando práticas de sonegação fiscal.
- Simplificação do Processo de Controle Fiscal: Facilitação do controle fiscal pelo governo, através do monitoramento em tempo real das transações comerciais, o que contribui para a redução da informalidade e para a arrecadação tributária.
- Padronização Nacional: Padronização do formato da NF-e em todo o território nacional, proporcionando maior harmonização e integração entre os estados brasileiros.
-
Modernização do Sistema Tributário: Modernização dos processos fiscais e tributários, acompanhando o avanço tecnológico e proporcionando maior eficiência na gestão fiscal.
Esses objetivos visam não apenas a modernização e eficiência no processo de emissão e controle
das notas fiscais, mas também a melhoria do ambiente de negócios e o aumento da transparência nas relações comerciais.
Gerando arquivo de integração
A integração com o PlugNotas funciona por meio de um arquivo JSON.
Esse arquivo vai receber algumas informações tributárias, que foram coletadas naqueles pontos anteriores que comentamos.
O arquivo em si é bem simples. Suas dúvidas podem ser apenas em relação a alguns campos.
Algumas observações sobre o nosso JSON são as seguintes:
- O arquivo disponibilizado na documentação, é um exemplo que representa UM CASO de envio: uma empresa de Regime Normal (CNPJ da Tecnospeed) com tributação isenta. Qualquer caso diferente disso, pode ser necessário alterar alguns campos diferentes, principalmente em relação à tributação. Campos estes, que estão disponíveis no dicionário de dados.
Essa documentação aqui, é sobre a rota de envio da NF-e e nela você consegue visualizar todos os campos disponíveis para o JSON de envio, bem como a especificação dos campos (string, inteiro, enum...).
Fluxo de emissão NF-e
Os envios de notas são realizados de forma assíncrona, o que significa que o retorno direto do seu envio, NÃO é informando se a nota está autorizada ou não. Para isso, será necessário o uso de consultas dessas notas ou o uso do webhook para receber notificações. Nessa documentação, ambos os fluxos estão explicados.
Nesse fluxo, vamos assumir que os passos anteriores já foram realizados, como todos os cadastros, configurações da empresa e informações dentro do json.
Fluxo utilizando a consulta
O fluxo se inicia com o envio do arquivo json via API para o PlugNotas. Quando chega ali, nós vamos buscar os dados do cadastro da empresa, setar a numeração da nota, realizar os cálculos de impostos e valores (caso eles não constem no json) e montar o XML para enviar isso tudo para a SEFAZ. Ao mesmo tempo em que todo esse processo é feito, a API já retornou para você o ID dessa nota dentro do nosso banco de dados.
A SEFAZ vai processar essa nota e retornar para nós. Para que você consiga saber o resultado do processamento ou se ela ainda permance em processamento, você deve utilizar a rota de consulta de notas usando como filtro o ID retornado da rota de envio.
O retorno da consulta vai dizer se a nota foi autorizada (CONCLUÍDO), rejeitada (REJEITADO) ou se ainda está pendente de processamento (PROCESSANDO).
Em caso de autorização, o processo por si só está finalizado, mas caso seja do seu interesse ou do seu cliente, você pode solicitar o PDF e/ou o XML dessa nota para o PlugNotas.
Em caso de rejeição, você deve analisar o motivo da rejeição e aplicar a correção, gerando um novo envio depois disso.
Em caso de processamento pendente, resta apenas aguardar e realizar novas consultas periódicamente para saber se o processo foi finalizado.
Fluxo utilizando o WebHook
Para esse fluxo é primordial que se realize as configurações do WebHook para o qual enviaremos as notificações (os Webhooks estão explicados na documentação "Obtendo o retorno").
O fluxo se inicia com o envio do arquivo json via API para o PlugNotas. Quando chega ali, nós vamos buscar os dados do cadastro da empresa, setar a numeração da nota, realizar os cálculos de impostos e valores (caso eles não constem no json) e montar o XML para enviar isso tudo para a SEFAZ. Ao mesmo tempo em que todo esse processo é feito, a API já retornou para você o ID dessa nota dentro do nosso banco de dados.
A SEFAZ vai processar essa nota e retornar para nós. Para que você consiga saber o resultado do processamento, você receberá uma notificação via WebHook configurado anteriormente.
O retorno desse WebHook vai dizer se a nota foi autorizada (CONCLUÍDO) ou rejeitada (REJEITADO).
Em caso de autorização, o processo por si só está finalizado, mas caso seja do seu interesse ou do seu cliente, você pode solicitar o PDF e/ou o XML dessa nota para o PlugNotas.
Em caso de rejeição, você deve analisar o motivo da rejeição e aplicar a correção, gerando um novo envio depois disso.
Notas pendentes de processamento não serão notificadas, apenas notas em estado final.
Lista de Rotas NF-e
Nome da rota | Método | Rota | Descrição | Retorno |
---|---|---|---|---|
Emitir nota | POST | https://api.plugnotas.com.br/nfe | Realiza o envio assíncrono da nota a partir do JSON no BODY da requisição. | ID da nota em caso de JSON correto, ou um erro de validação de JSON como campos obrigatórios vazios. |
Solicitando cancelamento da nota | POST | https://api.plugnotas.com.br/nfe/{idNota}/cancelamento | Realiza a requisição do cancelamento assíncrono da nota a através do ID gerado para a nota. | XML de confirmação de cancelamento, em caso de sucesso, ou XML da resposta do servidor. |
Solicitar correção da nota | POST | https://api.plugnotas.com.br/nfe/{idNota}/cce | Realiza o envio de uma carta de correção. | Protocolo. Para saber o status da solicitação da carta de correção, consulte o protocolo retornado no envio. |
Consultar resumo da notas | GET | https://api.plugnotas.com.br/nfe/{idNotaOrChaveOrProtocol}/resumo | Traz apenas as informações principais sobre o processamento dessa nota |
Retorna um resumo da nota enviada e o status da nota. A consulta pode apresentar os seguintes status:
|
Consultar solicitação de cancelamento | GET | https://api.plugnotas.com.br/nfe/{idNota}/cancelamento/status | Consulta o status de sua solicitação de cancelamento pelo ID gerado por nossa API no envio da nota. | Retorna o status da nota, que deve ser "CONCLUIDO" para casos de sucesso, e "REJEITADO" em caso de insucesso. |
Consultar correção da nota | GET | https://api.plugnotas.com.br/nfe/{idNotaorChaveorProtocol}/cce/status | Consulta o status de sua solicitação de carta de correção pelo ID gerado por nossa API no envio da nota. |
Retorna o status da nota, que pode ser:
Para mais detalhes, acesse o link |
Baixar PDF da correção | GET | https://api.plugnotas.com.br/nfe/{idNota}/cce/pdf | Download do PDF da carta de correção (CC-e). | Retorna o PDF em bytes. |
Baixar XML da correção | GET | https://api.plugnotas.com.br/nfe/{idNota}/cce/xml | Download do XML da carta de correção (CC-e). | Retorna o XML da CCe. |
Consultar resumo da nota por ID | GET | https://api.plugnotas.com.br/nfe/{cnpj}/{idIntegracao}/resumo | Consulta resumida da nota, por CNPJ e idIntegracao. |
Retorna um resumo da nota enviada e o status da nota. A consulta pode apresentar os seguintes status:
|
Baixar PDF nota | GET | https://api.plugnotas.com.br/nfe/{idNota}/pdf | Download da impressão em PDF da NF-e, por ID ou Chave. | Retorna o PDF em bytes. |
Baixar XML nota | GET | https://api.plugnotas.com.br/nfe/{idNotaorChave}/xml | Download do XML Destinatário da NF-e, por ID ou Chave. | Retorna o XML destinatário. |
Baixar XML de cancelamento | GET | https://api.plugnotas.com.br/nfe/{idNotaorChave}/cancelamento/xml | Download do XML de cancelamento da NF-e, por ID ou Chave. | Retorna o XML de cancelamento. |
Solicitar pré visualização da nota | POST | https://api.plugnotas.com.br/nfe/preview | A rota de Pré Visualização da nota, pode ser usada para realizar a conferência dos dados que serão impressos antes da autorização da NFe. | Essa rota é assíncrona, você receberá o protocolo gerado pela API para baixar o PDF. |
Baixar PDF da prévia da DANFe | GET | https://api.plugnotas.com.br/nfe/{protocol}/preview | Download da impressão em PDF da previsão da DANFE de uma NF-e, por protocolo. | Retorna o PDF em bytes. |
Enviar e-mail | POST | https://api.plugnotas.com.br/nfe/{idNota}/email | Envio, ou reenvio de e-mail utilizando o ID da nota. | |
Consultar notas por período | GET | https://api.plugnotas.com.br/nfe/consulta/periodo |
Tipos de consulta:
|
Retorna todas as notas enviadas em determinado período, de um cpfCnpj específico, independente de sua situação. |
Solicitar inutilização de numeração | POST | https://api.plugnotas.com.br/nfe/inutilizacao | Realiza uma solicitação de inutilização de numeração junto a Sefaz de origem. | Essa rota é assíncrona, para obter a situação da sua inutilização, utilize a rota /nfe/inutilizacao/{protocol}/status. |
Consultar solicitação de inutilização | GET | https://api.plugnotas.com.br/nfe/inutilizacao/{protocol}/status | Consulta o status de sua solicitação de inutilização de numeração. | Retorna o status da solicitação de inutilização de numeração., podendo ser "CONCLUÍDO" ou "REJEITADO". |
Comentários
0 comentário
Por favor, entre para comentar.