O Componente NFC-e da Tecnospeed é uma biblioteca contendo todos os métodos necessários para emitir a Nota Fiscal de Consumidor eletrônica. É a escolha ideal para quem pode consumir OCX e prefere manter todo o processo de mensageria da NFC-e 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.
Neste artigo você terá todas as informações para conseguir fazer o download da nova versão do componente e implementar todos os novos métodos para emitir e imprimir uma nota fiscal eletrônica de forma absurdamente simples seguindo os seguintes passos.
Instalar Componente NFCe
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 NFC-e para download na . Você pode acessar a com os dados de acesso que você preencheu no formulário de registro.
Com o Componente já disponível, na aba lateral , clique no botão Baixar. Caso o download não inicie, .
Existem dois instaladores disponíveis para download na Central do Cliente: O Setup NFCe Full e o Setup NFCe 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/NFCe/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
Esta é a forma padrão de instalação. Basta executar o instalador e seguir as instruções na tela.
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, caso o sistema seja 64 bits, e na pasta SysWOW64 para a versão de 32 bits do Windows.
DLLs que devem ser registradas:
- NFCeX.ocx
- NFCeDataSetX.dll
- msxml6.dll
- NFCeGovX.ocx
- midas.dll
- stdvcl40.dll
DLLs que devem ser apenas copiadas:
- ssleay32.dll
- libeay32.dll
- msxml6r.dll
Instalação Manual
A instalação manual trata-se do usuário instalar o componente NFCe 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 NFCe 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 NFCe, 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
spdNFCeDataSets, spdNFCe;
Em seguida é necessário criar as variáveis das classes, como no exemplo a baixo.
type
TForm1 = class(TForm)
spdNFCe: TspdNFCe;
spdNFCeDataSets: TspdNFCeDataSets;
Independente da forma com que você trouxe as classes ao projeto, agora você deve criar o objeto e direcioná-lo a uma variável:
spdNFCe := TspdNFCe.Create(nil);
spdNFCeDataSets := TspdNFCeDataSets.Create(nil);
VB6
Primeiramente, declare o objeto pertencente à classe que faz interação com os servidores da Sefaz
Dim NFCe As NFCeX.spdNFCeX
Dim NFCeDataSet As NFCeDataSetX.spdNFCeDataSetX
Após isso, já na inicialização do Fom, instancie o objeto dentro de uma nova variável.
Set NFCe = New NFCeX.spdNFeX
Set NFCeDataSet = New NFCeDataSetX.spdNFeDataSetX
C#
No início do seu projeto, junto com as bibliotecas importadas, adicione as OCX da Tecnospeed
using NFCeX;
using NFCeDataSetX;
Após isso, instancie o objeto dentro de uma nova variável
spdNFCeX spdNFCe = new spdNFCeX();
spdNFCeDataSetX spdNFCeDataSets = new spdNFCeDataSetX();
Configurar Propriedades
Antes de utilizar os métodos e funções do componente, é necessário configurar as suas propriedades. Elas 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, as propriedades de e-mail e as propriedades de impressão (DANFE).
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
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 ideal da emissão da NFC-e
Existem duas formas de enviar a nota à SEFAZ: o envio síncrono e o envio assíncrono.
Enviando a nota de forma síncrona
No envio síncrono, a SEFAZ retornará direto a situação da nota. Esta é a forma que recomendamos que seja implementada, por ser o método que a própria SEFAZ recomenda ser utilizado.
Enviando a nota de forma assíncrona
No envio assíncrono, a SEFAZ retornará um número de recibo a ser consultado e esta consulta retornará a situação da nota. Nós não recomendamos o envio da NFC-e desta forma, pois a SEFAZ não o recomenda, uma vez que elas priorizam o envio síncrono e pode apresentar instabilidade no envio assíncrono.
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 o Componente DataSets ou o arquivo TX2
Para gerar o arquivo de integração utilizando Componente DataSets ou um arquivo TX2, é necessário seguir o exemplo presente nas nossas demonstrações. Consulte também o nosso dicionário de dados, lá vai encontrar todas as tags disponíveis na NFC-e.
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. Este artigo está dividido em três etapas:
- Obtendo o nome do Certificado Digital;
- Informado o nome do Certificado Digital;
- Realizando a assinatura do XML.
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 semelhante a 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
Informado 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 AssinarNota. 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.
Validar o XML da NF-e
Em alguns casos, antes de enviar a nota à SEFAZ, é importante validar o XML. Esta validação mostrará possíveis rejeições e avisos a serem corrigidos antes de enviar em produção. Para validar uma nota, é possível utilizar o validador NFC-e da SEFAZ.
Para utilizar o Validador NFC-e da SEFAZ do Rio Grande do Sul, basta colar um XML, no quadro, clicar em Validar e conferir o resultado da validação abaixo. O XML deve estar assinado para que a validação ocorra corretamente.
Acessar o validador da SEFAZ >
Rejeições
Caso ocorra uma rejeição junto ao servidor da SEFAZ, é necessário corrigi-la antes de enviar novamente a nota. É possível encontrar uma explicação de como resolver a maioria das rejeições na seção Rejeições da nossa documentação. Caso precise de ajuda, fale com a nossa equipe de suporte.
Enviar uma NFC-e
Para enviar a uma nota à SEFAZ, conforme é mostrado no artigo Entendendo o fluxo de emissão, há duas formas de comunicação: o envio síncrono e o envio assí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.
Enviando uma nota de forma síncrona
Para enviar uma nota de forma síncrona, é necessário utilizar o método EnviarNFSincrono. 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.
Nós, bem como a SEFAZ, recomendamos fortemente utilizar o envio síncrono no envio da NFC-e. Algumas UFs não trabalham muito bem com o envio assíncrono e podem apresentar falhas e instabilidades nesse modo de envio.
Exemplo de nota autorizada:
<nfeResultMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/NFeAutorizacao4">
<retEnviNFe versao="4.00" xmlns="http://www.portalfiscal.inf.br/nfe">
<tpAmb>2</tpAmb>
<verAplic>PR-v4_2_2</verAplic>
<cStat>104</cStat>
<xMotivo>Lote processado</xMotivo>
<cUF>41</cUF>
<dhRecbto>2018-12-04T10:54:59-02:00</dhRecbto>
<protNFe versao="4.00">
<infProt Id="ID141180002533793">
<tpAmb>2</tpAmb>
<verAplic>PR-v4_2_2</verAplic>
<chNFe>41181200000000000000655260000055111000709935</chNFe>
<dhRecbto>2018-12-04T10:54:59-02:00</dhRecbto>
<nProt>141180002533793</nProt>
<digVal>eA1oe0Wvh8FWWnyylSAJVcKqRr8=</digVal>
<cStat>100</cStat>
<xMotivo>Autorizado o uso da NF-e</xMotivo>
</infProt>
</protNFe>
</retEnviNFe>
</nfeResultMsg>
Exemplo de nota rejeitada:
<nfeResultMsg xmlns="http://www.portalfiscal.inf.br/nfe/wsdl/NFeAutorizacao4">
<retEnviNFe versao="4.00" xmlns="http://www.portalfiscal.inf.br/nfe">
<tpAmb>2</tpAmb>
<verAplic>PR-v4_2_2</verAplic>
<cStat>703</cStat>
<xMotivo>Data-Hora de Emissao posterior ao horario de recebimento. Tolerancia de ate 5 minutos. Data informada:2018-12-04T11:51:20</xMotivo>
<cUF>41</cUF>
<dhRecbto>2018-12-04T10:51:26-02:00</dhRecbto>
</retEnviNFe>
</nfeResultMsg>
Enviando uma nota de forma assíncrona
Para enviar uma nota de forma assíncrona, é necessário utilizar o método EnviarNF. No envio assíncrono, a SEFAZ retornará um XML com um número de recibo. É necessário capturar este número de recibo e realizar a consulta utilizando o método ConsultarRecibo.
O retorno desta consulta mostrará se a nota foi autorizada (cStat igual a 100) ou qual foi o motivo da rejeição.
Imprimir uma NFC-e
O DANFCE pode ser impresso na impressora ou salvo como um arquivo PDF. Em ambos os casos, é necessário informar o conteúdo de um XML de uma nota autorizada na SEFAZ (cStat igual a 100).
Imprimindo uma nota na impressora
Para imprimir uma nota, é necessário utilizar o método ImprimirDanfce. Como parâmetro, é necessário informar o XML autorizado, o caminho para o arquivo de modelo do DANFCE (extensão .rtm), e o nome da impressora que será utilizada para imprimir (caso seja vazio, será utilizada a impressora padrão do Windows).
Exportando o DANFCE em PDF
Para exportar o DANFCE em PDF, é necessário utilizar o método ExportarDanfce. Como parâmetro, é necessário informar o XML autorizado, o caminho para o arquivo de modelo do DANFCE (extensão .rtm), e o diretório que o PDF deve ser salvo (caso seja vazio, será mostrada a tela de salvar arquivo do Windows).
Cancelar uma NFC-e
A NFC-e pode ser cancelada até 24 horas após a autorização. Para cancelar uma nota, ela deve estar autorizada na SEFAZ (cStat igual a 100).
Para cancelar uma nota, é necessário utilizar o método CancelarNFCeEvento. Como parâmetro, é necessário informar a chave desta NFC-e, 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.
Imprimindo uma nota cancelada
Para imprimir uma nota que foi cancelada, é necessário utilizar o método ImprimirDanfce. Como parâmetro o XML destinatário de autorização e também o XML destinatário de cancelamento (no mesmo parâmetro), o caminho do arquivo de impressão (arquivo .rtm) e o nome da impressão (se não informado, a impressão sairá na impressora padrão da máquina).
Comentários
0 comentário
Por favor, entre para comentar.