Roteiro de implantação

Abaixo estão os passos gerais para implantação da NF-e em seu sistema.

Antes de começar

Antes de começar a usar a Library em seu sistema, recomendamos que: 

  • Leia o manual de integração fornecido pelo governo para conhecer o funcionamento do projeto e principalmente o layout da NF-e;
  • Providencie um certificado digital válido;
  • Providencie o credenciamento para emissão da NF-e. Em alguns estados, mesmo para emissão em ambiente de homologação é necessário solicitar o credenciamento junto à SEFAZ;
  • Faça a configuração da NFeLibrary em sua Workspace conforme especificado no tópico Configuração. 

Passo-a-passo

1 - Gerar o XML da NF-e

Para geração do arquivo XML da NF-e, a NFeLibrary fornece a função NFeGeraXMLNFe4_00. Esta função recebe como único parâmetro, uma variável do tipo Struct, que contém as informações necessárias para gerar o XML da NF-e.

A estrutura contém todos os dados de uma Nota Fiscal. Existem campos que são usados por algumas empresas e outros que não são. Por isso verifique o contexto a qual a empresa se enquadra para o preenchimento correto de todas as estruturas.

As estruturas estão definidas no pacote NF-eStructures.pkg. O Code Complete do Visual DataFlex Studio 12.0 ou superior facilita o preenchimento da estrutura, pois exibe os campos existentes conforme demonstrado na imagem que segue: 

Roteiro01

A NFeLibrary é fornecida com uma Workspace de Exemplo que demonstra o preenchimento da estrutura e chamada da função NFeGeraXMLNFe4_00. Consulte o pacote NF-ePreparaNFExemplo.pkg.

Observações

  • A edição Plus da NFeLibrary possui algumas funções complementares para obter o número de municípios e paíes em tabelas específicas também fornecidas. Consulte mais detalhes aqui.
  • É importante salientar que é de total responsabilidade do desenvolvedor o preenchimento correto das informações, não sendo responsabilidade da NFeLibrary garantir a correta carga das informações diante de cada contexto fiscal.

2 - Enviar o lote

Uma vez gerado o arquivo XML da NF-e, a próxima etapa é enviar o lote para a respectiva SEFAZ. Para o envio a NFeLibrary fornece a função NFeEnviar. Verifique a documentação da mesma para mais detalhes.

Importante salientar que a partir da versão 3.10 do layout cada SEFAZ pode, opcionalmente, processar o recebimento da NF-e de forma síncrona. E sendo assim apenas uma chamada ao Web Service é feita, pois a resposta do envio do lote já retorna o protocolo de autorização da NF-e quando a NF-e é aceita, ou o motivo da rejeição da nota. Sendo este processo opcional, é necessário verificar junto à SEFAZ se o processo de forma síncrona é aceito.

Quando o processo de envio é feito de forma síncrona, o passo (3) onde é feita a consulta do lote enviado se torna desnecessário, já que a resposta da solicitação de autorização da NF-e é recebida no momento do envio. Caso o processo de envio na SEFAZ seja feito de forma assíncrona, o passo (3) continua sendo obrigatório.

3 - Consultar o lote processado

A consulta do lote processado é feita com a função NFeBuscar.

Se o lote foi processado com sucesso esta função devolverá o protocolo de autorização da NF-e, permitindo que a nota seja utilizada para circulação da mercadoria garantindo sua autenticidade para consultas no portal da NF-e. 

Se o lote foi processado com erro e a nota não foi autorizada, esta função devolverá detalhes do erro que causou a rejeição para que a NF-e possa ser corrigida e uma nova tentantiva seja feita.

Essa etapa, a partir da versão 3.10 do layout se tornou, em alguns casos, desnecessária. É necessário verificar quais secretarias estão executando a solicitação de autorização de forma síncrona.

4 - O lote foi processado com sucesso e agora?

Uma vez que o lote foi processado com sucesso e a nota foi autorizada, é de responsabilidade do emitente fornecer, no mínimo, o arquivo XML autorizado para o destinatário. O e-mail é a forma mais usada pelas empresas para fazer este envio. Muitas empresas também enviam para o destinatário, o DANFe em PDF. Para o envio do e-mail a NFeLibrary dispõe da função NFeEnviaEmail. Por favor, consulte o manual da função para maiores detalhes.

Não existe exigência legal para a impressão do DANFE da NF-e, entretanto para circulação da mercadoria é necessário pelo menos uma cópia. Para a emissão do DANFE a NFeLibrary disponibiliza a função NFeGeraDANFe. Para maiores detalhes de utilização da função consulte sua documentação.

Se for necessário cancelar uma NF-e autorizada, utilize a função NFeCancelar. 

5 - A nota possui dados inválidos e já foi numerada, o que fazer?

Em alguns casos o emitente pode ter gerado e numerado uma nota, que por algum motivo, como preenchimento incorreto, precisará inutilizar a numeração em questão. A NFeLibrary então, para esses casos, disponibiliza a função NFeInutilizar.