O Componente NFCom da Tecnospeed é uma biblioteca contendo todos os métodos necessários para emitir a Nota Fiscal de Serviço de Comunicação. É a escolha ideal para quem pode consumir OCX e prefere manter todo o processo de mensageria do NFCom dentro do próprio ambiente. Para utilizar o Componente em seu software, basta instanciá-lo em seu projeto, implementar chamadas para cada um dos métodos e configurá-los de acordo com sua necessidade.
Com isso reunido, você poderá seguir este passo a passo detalhado:
- Instalar Componente
- Instanciar Componente NFCom
- Configurando as propriedades
- Entendendo o fluxo de emissão
- Gerar o arquivo de integração
- Assinar um XML
- Enviar NFCom
- Cancelar NFCom
Instalar Componente NFCom
Após aprovação do pedido de adesão, em até 24 horas úteis, nossa equipe financeira irá realizar o faturamento e disponibilizar o Componente NFCom para download na Central do Cliente. Você pode acessar a Central do Cliente com os dados de acesso que você preencheu no formulário de registro.
Com o Componente já disponível, na aba lateral Download, clique no botão Baixar. Caso o download não inicie, desabilite o bloqueador de pop-ups do seu navegador.
Além do Componente NFCom, você também precisará de um CNPJ com Inscrição Estadual e um certificado digital deste CNPJ cadastrado no Web Service da SEFAZ.
Existem dois instaladores disponíveis para download na Central do Cliente: O Setup NFCom Full e o Setup NFCom Dependencies. O primeiro deve ser instalado no ambiente de desenvolvimento e o segundo no ambiente onde o sistema for ser executado.
No ambiente de desenvolvimento
No ambiente de desenvolvimento, nós devemos instalar a versão Full, pois ela é a biblioteca completa, com todos os métodos e arquivos que o componente possui. Para instalá-la, basta executar o instalador e seguir as instruções na tela.
No ambiente do cliente
No ambiente onde o sistema for ser executado, devemos instalar a versão Dependencies, que é a versão Full reduzida, com apenas as DLLs necessárias para o componente funcionar. Para instalá-la, existem algumas opções: é possível simplesmente executar o instalador, como na versão Full, executar o instalador em modo silencioso, ou incluir as DLLs no seu próprio instalador.
Além das DLLs, é necessário que o componente tenha acesso às pastas de Esquemas e Templates e aos arquivos com o endereço dos servidores. Estas pastas e arquivos são criados no diretório de instalação da versão Full (TecnoSpeed/NFCom/Arquivos). É necessário colocá-los no ambiente do cliente e configurar o diretório delas nas propriedades DiretorioEsquemas, DiretorioTemplates, ArquivoServidoresHom e ArquivoServidoresProd.
Executando o instalador Modo Silencioso
Para evitar que o usuário precise realizar alguma interação, é possível incorporar um comando na sua aplicação ou instalador. Existem dois comandos disponíveis: Silent e VerySilent. O comando Silent irá exibir a interface de instalação, mas não permitirá que o usuário interaja com o instalador. Por outro lado, o comando VerySilent não exibirá nenhuma interface ao usuário, a instalação será executada em segundo plano.
prompt> instalador.exe /silent
prompt> Instalador.exe /verysilent
Incluindo os arquivos no próprio instalador
O instalador das dependências apenas adiciona as DLLs onde ele é instalado. Para não utilizar o instalador, é possível incorporar as DLLs ao próprio instalador. Basta copiar ou registrar na pasta System32 ou SysWOW64 , caso o sistema seja 64 bits, e na pasta SysWOW64 para a versão de 32 bits do Windows.
DLLs que devem ser registradas:
- NFComX.ocx
- spdNFComDatasetX.ocx
- msxml6.dll
- NFComGovX.ocx
- midas.dll
DLLs que devem ser apenas copiadas:
- ssleay32.dll
- libeay32.dll
- msxml6r.dll
- stdvcl40.dll
Instalação Manual
A instalação manual trata-se do usuário instalar o componente NFCom através de seu arquivo binário na extensão .dpk (Delphi Package). Caso opte em instalar o componente manualmente siga as instruções abaixo:
- Atenção! É necessário que seja instalado a versão Dependencies no ambiente de Desenvolvimento e do cliente;
- Deverá ter em mãos o dpk do componente NFCom DataSet na versão de Delphi desejada e abri-lo.
- Após abrir o projeto do NFCom DataSet, poderá compilar e em seguida instalar normalmente.
- Em seguida, para instalar o componente NFCom deverá ter em mãos seu respectivo dpk na versão de Delphi desejada e abri-lo.
- Incluir no search path do projeto o caminho das BPL´s e DCP´s da GOV, exemplo:
- Após inserir os search path, deve-se compilar o projeto e o mesmo não poderá ter nenhum erro.
-
Ao compilar o projeto anteriormente, será criado um arquivo BPL e DCP do componente no diretório específico do Delphi, segue exemplos de diretórios:
- C:\Users\Public\Documents\Embarcadero\Studio\17.0\Bpl;
-
C:\Users\Public\Documents\Embarcadero\Studio\17.0\Dcp;
- Obs. Esse diretório é somente um exemplo, cada versão do Delphi tem seu respectivo diretório. Exemplo:
- Delphi Seattle - C:\Users\Public\Documents\Embarcadero\Studio\17.0;
- Delphi XE6 - C:\Users\Public\Documents\Embarcadero\Studio\14.0;
- Delphi XE3 - C:\Users\Public\Documents\RAD Studio\10.0;
- Delphi XE - C:\Users\Public\Documents\RAD Studio\8.0;
- Será necessário copiar as BPL´s e DCP´s da GOV que são as mesmas colocadas no search path do projeto anteriormente, para o diretório específico do Delphi conforme citado alguns exemplos acima, onde são criados os arquivos BPL e DCP do componente, exemplo:
- Após realizar esses passos, poderá finalmente instalar o seu componente NFCom, conforme a imagem abaixo:
Instanciar o Componente
Após a instalação do componente, é necessário instanciar a classe no projeto para fazer as modificações necessárias em suas propriedades e também utilizar os seus métodos.
Aqui iremos te mostrar passo a passo como instanciar a classe em três das linguagens, Delphi, C# e VB6.
Delphi
No Delphi há duas formas de instanciar o componente. Você pode arrastar os ícones do componente na barra de ferramentas para dentro do seu unit ou fazê-lo de forma manual, adicionando no uses do projeto:
uses
spdNFCom,
spdNFComUtils,
spdNFComTypes,
Em seguida é necessário criar as variáveis das classes, como no exemplo a baixo.
type
TForm1 = class(TForm)
public
NFCom: TspdNFCom;
Independente da forma com que você trouxe as classes ao projeto, agora você deve criar o objeto e direcioná-lo a uma variável:
NFCom := TspdNFCom.Create(nil);
VB6
Primeiramente, declare o objeto pertencente à classe que faz interação com os servidores da Sefaz
Dim NFCom As NFComX.spdNFComX
Dim NFComDataSet As spdNFComDatasetX.spdNFComDatasetX
Após isso, já na inicialização do Fom, instancie o objeto dentro de uma nova variável.
Set NFCom = New NFComX.spdNFComX
Set NFComDataSet = New spdNFComDatasetX.spdNFComDatasetX
C#
No início do seu projeto, junto com as bibliotecas importadas, adicione as OCX da Tecnospeed
using spdNFComX;
Após isso, instancie o objeto dentro de uma nova variável
public NFComX.spdNFComX _spdNFComX = new NFComX.spdNFComX();
Configurar Propriedades
Antes de utilizar os métodos e funções do componente, é necessário configurar as suas propriedades.
As configurações do Componente NFSe podem ser configuradas utilizando um arquivo de configuração (.ini) ou através do código fonte.
Cada propriedade indica uma configuração. Por exemplo, a propriedade "Ambiente" determina para qual servidor o Componente irá enviar a nota (o de homologação ou de produção). Estas configurações estão divididas em três tipos: as propriedades gerais do componente e as propriedades de e-mail
Configurando através do código fonte
É possível preencher as propriedades através do código fonte do sistema. Basta informar os valores desejados para cada uma delas. Você encontra uma lista completa de funções e exemplos de preenchimento das propriedades na seção Propriedades do componente.
Configurando com um arquivo de configuração (ini)
Também é possível preencher as propriedades através de um arquivo de configuração (.ini). Basta informar os valores desejados para cada uma delas e passar o diretório deste arquivo como parâmetro no método LoadConfig. Você encontra uma lista completa de funções e exemplos de preenchimento das propriedades na seção Propriedades do componente.
Fluxo da emissão NFCom
Atualmente o NFCom só pode ser enviado a Sefaz pelo modo: síncrono. O envio assíncrono foi desativado em definitivo na NT 2024.001 em 30/06/2023.
No envio síncrono, a SEFAZ retornará direto a situação da nota, não sendo necessário fazer uma consulta de chave ou recibo após o envio.
Caso tente enviar pelo modo assíncrono a SEFAZ retornará com a seguinte rejeição:
Rejeição: Serviço de recepção de lotes desativado (NT2024.001). Migrar para recepção sincrona!
Gerar arquivo de Integração
Para gerar este arquivo de integração, é necessário preencher alguns campos com os valores corretos. Para informar estes dados, é possível:
- Gerar o arquivo de integração utilizando o Componente DataSets ou o arquivo TX2;
- Manter o arquivo XML (caso o sistema já gere).
Utilizando Datasets ou arquivo TX2
Para gerar o arquivo de integração utilizando Componente DataSets ou um arquivo TX2, é necessário seguir o Dicionário de Dados. Este dicionário possui todos os campos disponíveis, instruções de como iniciar e concluir um arquivo e como informar os grupos que podem se repetir.
Saiba mais sobre o Dicionário de Dados >
Mantendo o arquivo XML
Caso o arquivo XML já seja gerado pelo sistema, não é necessário alterar para o TX2 ou o Componente DataSets. Basta manter o arquivo XML que já é gerado e, antes de enviar, realizar a assinatura digital deste arquivo.
Assinar XML
Para enviar uma nota à SEFAZ, é necessário realizar uma assinatura digital do XML. Esta assinatura é realizada utilizando um Certificado Digital.
Obtendo o nome do Certificado Digital
Cada certificado possui uma identificação única, que é o que o componente utilizará para selecionar o certificado correto ao realizar a assinatura. É possível listar todos os certificados digitais utilizando o método ListarCertificados.
Este método retornará uma lista com as identificações dos certificado, tanto do modelo A1 quanto do modelo A3 (que possui um cartão físico), instalados no repositório pessoal do Windows. A identificação é uma string parecida com esta:
CN=TECNOSPEED S A:08187168000160, OU=Certificado PJ A1, O=ICP-Brasil, C=BR, S=, L=, E=, SE=26 41 18 05 02 40 D6 8A
Informando o nome do Certificado Digital
Para selecionar o Certificado Digital que será utilizado na assinatura, basta informar o nome do certificado (esta identificação que o método ListarCertificados retornou) na propriedade NomeCertificado.
Para configurar a propriedade, é possível utilizar um arquivo de configuração (.ini) ou configurar através do código fonte. O artigo Configurando as propriedades detalha o funcionamento das propriedades.
Realizando a assinatura do XML
Para assinar o XML de envio, é necessário utilizar o método AssinarNFCom. Como parâmetro, é necessário informar o XML sem assinatura como string. O método retornará o mesmo XML passado como parâmetro na função, porém ele terá as tags de assinatura em seu conteúdo.
É importante lembrar que é necessário que o CNPJ do emitente da nota seja o mesmo CNPJ do certificado digital utilizado para realizar a assinatura.
Enviar NFCom
Para enviar a uma nota à SEFAZ, há apenas uma forma de comunicação: o envio síncrono.
Antes de enviar, é importante verificar a propriedade Ambiente. Esta propriedade define se o envio será em homologação ou em produção, conforme é explicado no artigo Configurando as propriedades.
Para enviar uma nota de forma síncrona, é necessário utilizar o método EnviarNFComSincrono. No envio síncrono, a SEFAZ retornará um XML mostrando se a nota foi autorizada (cStat igual a 100) ou qual foi o motivo da rejeição.
Cancelar NFCom
O NFCom pode ser cancelado até 24 horas após a autorização. Para cancelar uma nota dela deve estar autorizada na SEFAZ (cStat igual a 100).
Para cancelar um NFCom, é necessário utilizar o método CancelarNFCom. Como parâmetro, é necessário informar a chave desta NFCom, o número de protocolo de registro, uma justificativa de cancelamento, a data e hora de cancelamento, a sequência deste evento, e o fuso horário.
Veja mais sobre o método CancelarNFeEvento >
Imprimir NFCom Cancelado
Para imprimir uma nota que foi cancelada, é necessário utilizar o método ImprimirDANFCom. Como parâmetro, é necessário informar o XML autorizado, o XML cancelado, o caminho para o arquivo de modelo do DANFCom (extensão .rtm), e o nome da impressora que será utilizada para imprimir (caso seja vazio, será utilizada a impressora padrão do Windows).
Comentários
0 comentário
Artigo fechado para comentários.