Hercules-NET / ZeusFiscal

A Principal Biblioteca em C# para Emissão e Impressão de NFe, NFCe, MDF-e e CT-e

Entre no nosso Discord https://discord.gg/EE4TGKAkkG

Confira nosso exemplo de uso de emissao de NFe + Impressão de DANFE em (https://github.com/Hercules-NET/DemoNFe)

Versões suportadas:

A biblioteca foi desenvolvida em C# utilizando Visual Studio Community 2022 com os SDKs net462, netstandard2.0 e net6.0 instalados.

Escopos	Frameworks Suportados
NFe, NFCe, CTe, MDFe	.NET 4.6.2+, .NetStandard 2.0, .NET 6.0+ .NET 8.0
Impressões com FastReport OpenSource (NFe, NFCe, CTe, MDFe)	..NET 4.6.2+, .NetStandard 2.0, .NET 6.0(windows+linux) .NET 8.0+(windows apenas)
Impressões com FastReport (Versão PAGA) (NFe, NFCe, CTe, MDFe)	.NET 4.6.2+, .NetStandard 2.0, .NET 6.0(windows+linux) .NET 8.0+(windows apenas)
Impressões com FastReport.Skia (Versão PAGA SkiaSharp) (NFe)	.NET 7.0+(windows+linux+mobile)
Impressões com QuestPdf	.NET 4.6.2+, .NetStandard 2.0, .NET 7.0+(windows+linux+mobile)
Impressões com PDFClown (NFe)	.NET 4.6.2+

ATENÇÃO! Não temos suporte para .NetFramework 4.5.2 ou 4.5 ou menor. A Biblioteca irá seguir o ciclo de vida de versões da microsoft, sendo retirado a compatibilidade de versoes específicas e antigas do .Net caso a microsoft retire seu suporte.

Licenciada sobre a LGPL (https://pt.wikipedia.org/wiki/GNU_Lesser_General_Public_License).

Pacotes Nugets:

A melhor maneira de você ter a última versão do ZeusFiscal em seu projeto é utilizando os pacotes Nugets abaixo

Hercules.NET.Nfe.Nfce

Hercules.NET.MDFe

Hercules.NET.CTe

O que a biblioteca faz:

O projeto traz classes construídas de forma manual que extraem a complexidade dos XSDs. Com isso é possível preencher objetos nativos em .NET e gerar o XML na estrutura exigida para seu DFe, assim como o processo inverso de ler um XML de um DFe e obter objetos nativos em .NET.

Além da serialização e desserialização, o projeto também conta com os métodos de consumo dos webservices (consultar, transmitir, cancelar, inutilizar, etc.), ou seja, com a biblioteca você preenche um objeto nativo em .NET e transmite o seu DFe de forma totalmente transparente, sem se preocupar coma serialização e consumo do webservice.

A bibliteca também conta com a impressão dos DFes suportados, onde basicamente basta fazer a desserialização (ou preencher manualmente o(s) objeto(s) do DFe em questão) e chamar seu projeto de impressão.

Exemplo:

varproc=newnfeProc().CarregarDeArquivoXml(Caminho_do_arquivo_XML);vardanfe=newDanfeFrNfce(proc,newConfiguracaoDanfeNfce(NfceDetalheVendaNormal.UmaLinha,NfceDetalheVendaContigencia.UmaLinha,null/*Logomarca em byte[]*/),"00001","XXXXXXXXXXXXXXXXXXXXXXXXXX");danfe.Visualizar();//danfe.Imprimir();//danfe.ExibirDesign();

Como usar a ferramenta:

Antes de qualquer coisa leia os manuais e conheça à fundo o(s) projetos que pretende usar, entenda o que é um DFe (documento fiscal eletrônico), o que é um certificado, como funciona um webservice, o que é obrigatório ser informado no DFe que pretende emitir, entre outras informações. Isso vai ajudar na construção do seu software e na integração com a biblioteca.

Com o conhecimento prévio adquirido, agora você precisa estudar a biblioteca. A linguagem utilizada é C#, logo um conhecimento basico da linguagem pode te ajudar bastante, mesmo que você use apenas as dlls com VB.Net ou outra linguagem compatível.

Para facilitar o seus estudos a biblioteca oferece projetos do tipo DEMO, sendo eles (por ordem alfabética):

• CTe.AppTeste: Projeto em WPF para demonstração de uso do CTe;
• CTe.AppTeste.NetCore: Projeto em Console para demonstração de uso do CTe em .NET6;
• CTe.Dacte.AppTeste: Projeto em Winforms para demonstração de uso da impressão do CTe (necessita do FastReport.Net¹);
• MDFe.AppTeste: Projeto em WPF para demonstração de uso do MDFe;
• MDFe.Damdfe.AppTeste: Projeto em Winforms para demonstração de uso da impressão do MDFe (necessita do FastReport.Net¹);
• NFe.AppTeste: Projeto em WPF para demonstração de uso do NFe;
• NFe.AppTeste.NetCore: Projeto em Console para demonstração de uso do NFe e NFCe em .NET6;
• NFe.Danfe.AppTeste.Fast: Projeto em WPF para demonstração de uso da impressão da NFe e NFCe (A NFe e NFCe estão disponíveis em FastReport.Net¹. A NFC-e também está disponível de forma nativa, entretanto para O DEMO é necessária as DLLs do FastReport.Net¹. A utilização do DANFe da NFCe de forma nativa fora do DEMO não depende do FastReports.Net);
• NFe.Danfe.AppTeste.OpenFast: Projeto em Console em .NET6 para demonstração de uso de impressão da NFe, NFCe, como DANFE de xml não registrado e registrado ou Eventos como carta de correção e cancelamento.(A NFe utiliza o FastReport.OpenSource (https://github.com/FastReports/FastReport). Não é necessário nenhuma DLL externa, tudo está incluído no pacote nuget.);

Impressão (FastReport) (Versão PAGA):

https://www.fast-report.com/

• Exemplo no Projeto NFe.Danfe.AppTeste.Fast.
• Suporte a linux usando os pacotes SkiaSharp https://www.fast-report.com/blogs/fastreport-core-skia
• A impressão de forma nativa (sem dependências de bibliotecas de terceiros) está disponível somente para a NFCe¹.
• O projeto conta também com a impressão em FastReport.Net¹ (https://www.fast-report.com/pt/product/fast-report-net/) para NFe, NFCe²(térmica), CTe(modal rodoviário) e MDFe.

¹ As dlls do FastReport.Net disponibilizadas na biblioteca são da versão de demonstração³ do mesmo. A versão de demonstração coloca uma marca d'água "DEMO VERSION" na impressão do relatório. Se você possui licença FastReport.Net, substitua as dlls do FastReport.Net nos projetos NFe.Danfe.Fast\Dll, CTe.Dacte.Fast\DLLs e MDFe.Damdfe.Fast\Dlls pelas dlls de sua versão licenciada, antes de compilar sua aplicação para distribuição.

² Obs: Visando abranger o maior número possível de impressoras térmicas, a impressão é feita via spooler do windows. A impressão térmica via spooler, dependendo da impressora, pode sair com má qualidade. Para sanar isso, no relatório são utilizadas duas fontes condensadas que possuem boa legibilidade em tamanho pequeno, a saber a OpenSans e UbuntuCondensed, ambas de uso livre podendo ser obtidas em https://www.google.com/fonts; As fontes estão anexadas ao projeto em Shared.NFe.Danfe.Base\Fontes_; Instale as fontes informadas no PC que for imprimir o DANFE da NFCe_;

Impressão (FastReport) (OpenSource):

https://github.com/FastReports/FastReport

• Exemplos no Projeto NFe.Danfe.AppTeste.OpenFast.
• A impressão da NFe utiliza o FastReport.OpenSource (https://github.com/FastReports/FastReport), sendo ele instalado automatico ao utilizar o pacote nuget do Zeus.
• A impressão requer que o arquivo .frx seja indicado, ou seja, ao publicar os binarios de seu projeto os arquivos .frx devem estar juntos e passado o caminho do arquivo para que seja gerado a impressão.
• As saídas suportadas pelo FastReport.OpenSource são Stream ou Byte[], sendo elas em PDF, HTML e PNG.
• Para Impressão de NFCe tambem existe a seguinte opção ESC/POS (direto na impressora): https://github.com/marcosgerene/Gerene.DFe.EscPos.

Impressão em Linux (Nativo ou Docker)

Para a geração de impressão no Linux, alguns detalhes devem ser compreendidos...

Foi necessário a instalação da biblioteca libgdiplus

• (Exemplo abaixo para Ubuntu 18.x)

apt-get install -y --no-install-recommends libgdiplus libc6-dev

• (Exemplo abaixo para DockerFile Ubuntu 18.x)

RUN apt-get update
&& apt-get install -y --no-install-recommends libgdiplus libc6-dev
&& apt-get clean
&& rm -rf /var/lib/apt/lists/*

Caso aconteça algum erro de System.OutOfMemoryException, utilize a versão 6.0.5, o código acima instala a versão padrão dependendo da versão do SO (6.0.4), para instalar a 6.0.5 utilize o seguinte código, nesse caso para Debian 10:

RUN apt-get update && apt-get remove libgdiplus -y && apt autoremove -y && apt-get install -y apt-transport-https dirmngr gnupg ca-certificates
RUN apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF
RUN echo "deb https://download.mono-project.com/repo/debian stable-buster main" | tee /etc/apt/sources.list.d/mono-official-stable.list
RUN apt-get update && apt-get install -y libgdiplus=6.0.5-0xamarin1+debian10b1
RUN apt show libgdiplus && rm -rf /var/lib/apt/lists/*

Tambem foi necessário copiar algumas fontes, o relatório de Danfe atual utiliza Times New Roman, as fontes contem royalties e não existe repositório online com as mesmas, porem as mesmas estão disponíveis na pasta do windows. (fontes instaladas: times.ttf, timesbd.ttf, timesbi.ttf, timesi.ttf)

• (Exemplo abaixo para Ubuntu 18.x)

sudo apt-get install ttf-mscorefonts-installer

• (Exemplo para Debian 10)

apt-get install -y ttf-mscorefonts-installer fontconfig

• (Exemplo abaixo para DockerFile Ubuntu 18.x, porem diferente do exemploa anterior, copiando fontes ja existentes em uma pasta para a pasta de destino da imagem docker, não recomendamos essa opção por possíveis problemas porem a imagem de saída fica menor)

RUN mkdir -p /usr/share/fonts/truetype/times
COPY suapastadasfontes/* /usr/share/fonts/truetype/times/

O FastReport.OpenSource é pesado na geração de PDF, por isso recomendamos a versão paga do mesmo e utilizando a geração via SkiaSharp, que é apenas possível na versão paga.

Impressão (QuestPdf):

Código que eu Roberto utilizo para imprimir

QuestPDF.Settings.License=LicenseType.Community;// adicionar isso em algum local da sua aplicação ou licença equivalente para mais informações sobre licenças https://www.questpdf.com/

NFC-e

[HttpPost("danfe")][Produces("application/json")][ProducesResponseType(typeof(ValidationProblemDetails),(int)HttpStatusCode.BadRequest)][ProducesResponseType(200)]publicTask<IActionResult>GerarDanfeNfce([FromBody]CupomFiscalImprimirModelmodel){if(string.IsNullOrEmpty(model.Xml)){AddError("Selecione um XML de NFC-e");returnTask.FromResult<IActionResult>(CustomResponse());}varstringXml=model.Xml;try{FuncoesXml.XmlStringParaClasse<nfeProc>(stringXml);}catch{AddError("Verifiquei que seu XML esta inválido");returnTask.FromResult<IActionResult>(CustomResponse());}vardocumento=newDanfeNfceDocument(model.Xml,model.LogoBytes);documento.TamanhoImpressao(model.TamanhoImpressao);vardocumentoBytes=documento.GeneratePdf();varbase64Pdf=Convert.ToBase64String(documentoBytes);returnTask.FromResult<IActionResult>(CustomResponse(newRetornaPdfBase64(base64Pdf)));}

Carta Correção ou eventos

[HttpPost("carta-correcao")][Produces("application/json")][ProducesResponseType(typeof(ValidationProblemDetails),(int)HttpStatusCode.BadRequest)][ProducesResponseType(200)]publicTask<IActionResult>GerarDanfeCce([FromBody]NotaFiscalCartaCorrecaoImprimirModelmodel){if(string.IsNullOrEmpty(model.XmlNfe)){AddError("Selecione um XML de NF-e");returnTask.FromResult<IActionResult>(CustomResponse());}if(string.IsNullOrEmpty(model.XmlCartaCorrecao)){AddError("Selecione um XML de Carta Correção de NF-e");returnTask.FromResult<IActionResult>(CustomResponse());}vardocumento=newEventoNfeDocument(model.XmlNfe,model.XmlCartaCorrecao,model.LogoBytes);vardocumentoBytes=documento.GeneratePdf();varbase64Pdf=Convert.ToBase64String(documentoBytes);returnTask.FromResult<IActionResult>(CustomResponse(newRetornaPdfBase64(base64Pdf)));}

Impressão (PDFClown):

a base foi obtida daqui https://github.com/Laranjeiras/Zion.NFe.Danfe?tab=readme-ov-file esse por sua vez foi obtido daqui https://github.com/SilverCard/DanfeSharp funciona apenas em .net 6 core por hora

[namespaceFiscal.Impressao.API.Controllers{publicrecordDanfeViewModel(stringBase64Pdf);publicstaticclassImprimirDanfeService{publicstaticbyte[]GerarZionPdf(stringxmlNfeProc,byte[]?logoMarca){xmlNfeProc=xmlNfeProc.Replace("\u00a0"," ");varmodel=DanfeViewModelCreator.CriarDeStringXml(xmlNfeProc);usingvarpdfStream=newMemoryStream();using(vardanfe=newDanfeDoc(model)){if(logoMarca!=null){usingvarlogo=newMemoryStream(logoMarca);{danfe.AdicionarLogoImagem(logo);}}danfe.Gerar();returndanfe.ObterPdfBytes(pdfStream);}}}publicclassXmlDto{publicstringXml{get;set;}publicbyte[]?LogoBytes{get;set;}}[ApiController][Route("imprimir-danfe")]publicclassImprimirController: ApiController
{[HttpPost("")][Produces("application/json")][ProducesResponseType(typeof(ValidationProblemDetails),(int)HttpStatusCode.BadRequest)][ProducesResponseType(200)]publicasyncTask<IActionResult>GerarDanfe([FromBody]XmlDtoxml){if(string.IsNullOrEmpty(xml.Xml)){AddError("Selecione um XML de NF-e");returnCustomResponse();}varstringXml=xml.Xml;nfeProcnfeProc;try{nfeProc=FuncoesXml.XmlStringParaClasse<nfeProc>(stringXml);}catch{AddError("Verifiquei que seu XML esta inválido");returnCustomResponse();}varpdfStream=ImprimirDanfeService.GerarZionPdf(nfeProc.ObterXmlString(),xml.LogoBytes);varbase64Pdf=Convert.ToBase64String(pdfStream);returnCustomResponse(newDanfeViewModel(base64Pdf));}}}

Suporte:

O uso dessa biblioteca não lhe dá quaisquer garantias de suporte. No entanto se tiver dúvidas a respeito do uso desta biblioteca, abra um novo Issue aqui mesmo no github ou pergunte no grupo Discord => https://discord.gg/EE4TGKAkkG.

Colaborando:

Mantenha seu projeto atualizado para evitar issues desnecessárias, reporte bugs e soluções para problemas comuns, compartilhe suas ideias de melhorias, se tiver condições ajude enviando um pull request ou responda issues de outros colegas.

Ao enviar um PR explique brevemente o que foi alterado e o motivo. Teste amplamente as alterações antes de submeter, não remova funcionalidades ou mude regras de métodos já existentes sem aviso prévio e com tempo para adaptações.

Colabore, a bibloteca é open source e seu sucesso depende unicamente de sua comunidade.