@projetoacbr/acbrlib-nfse-node
v1.0.10
Published
Classe de alto nivel para ACBrLibNFSe
Readme
@projetoacbr/acbrlib-nfse-node
📋 Descrição
ACBrLib NFSe Node é uma implementação específica para Nota Fiscal de Serviço Eletrônica (NFSe) que fornece uma interface de alto nível para todas as funcionalidades da ACBrLibNFSe. Esta classe permite emissão, substituição, consultas e outras operações relacionadas à NFSe.
🏗️ Arquitetura
Esta classe (ACBrLibNFSeMT) estende ACBrLibDFeMT e implementa todos os métodos específicos da NFSe, herdando funcionalidades comuns dos pacotes base.
📦 Instalação
npm install @projetoacbr/acbrlib-nfse-node📖 Como Usar
🎯 Importação
📝 TypeScript (Recomendado)
// Importa a classe ACBrLibNFSeMT oficial conforme documentação
import ACBrLibNFSeMT from "@projetoacbr/acbrlib-nfse-node/dist/src";⚙️ Configuração tsconfig.json recomendada:
{
"compilerOptions": {
"target": "es2022",
"module": "commonjs",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
}
}🔧 JavaScript/CommonJS
const ACBrLibNFSeMT = require('@projetoacbr/acbrlib-nfse-node/dist/src').default🔧 Uso Básico
TypeScript
const acbrNFSe = new ACBrLibNFSeMT(
'./libacbrnfse64.so', // Linux
// './ACBrNFSe64.dll', // Windows
'./acbrlib.ini',
'12345678'
)JavaScript/CommonJS
const acbrNFSe = new ACBrLibNFSeMT(
'./libacbrnfse64.so', // Linux
// './ACBrNFSe64.dll', // Windows
'./acbrlib.ini',
'12345678'
)
// Inicializar a biblioteca
acbrNFSe.inicializar()
// Carregar XML
acbrNFSe.carregarXML('./nfse.xml')
// Validar e assinar
acbrNFSe.validar()
acbrNFSe.assinar()
// Emitir
const resposta = acbrNFSe.emitir()🔧 Funcionalidades
Métodos Herdados (DFe Comum)
inicializar(),finalizar()carregarXML(),carregarINI()obterXml(),obterIni()gravarXml(),gravarIni()imprimirPDF(),salvarPDF()enviarEmail()
Métodos Específicos da NFSe
Emissão e Substituição
emitir()substituirNFSe(numeroNFSe, codigoCancelamento, motivoCancelamento, numeroNFSeSubstituidora)
Consultas
linkNFSe(chaveAcesso, senha, visualizacao)consultarNFSePorRps(numeroRPS, serieRPS, tipoRPS, codigoVerificacao, codigoMunicipio)consultarNFSePorNumero(numeroNFSe, pagina)consultarNFSePorPeriodo(dataInicial, dataFinal, pagina, numeroLote)consultarNFSePorFaixa(numeroInicial, numeroFinal, pagina)consultarNFSePorChave(chaveAcesso)consultarParametros(codigoMunicipio, nomeParametro, valorParametro)
Geração de Lote e Token
gerarLote(numeroLote, quantidadeRPS, assinatura)gerarToken(codigoMunicipio, UFAutor, CNPJ, inscricaoMunicipal, razaoSocial, chaveAcesso)
Cancelamento
cancelarNFSe(numeroNFSe, codigoCancelamento, motivoCancelamento, numeroNFSeSubstituidora)
Impressão e Geração
obterDANFSE(numeroNFSe)imprimir(impressora, numCopias, protocolo, mostrarPreview, marcaDagua, viaConsumidor, simplificado)
🔗 Dependências
- @projetoacbr/acbrlib-dfe-node - Classe base para DFe
📚 Documentação
Para informações detalhadas sobre cada método, consulte a documentação JSDoc incluída no código fonte.
🤝 Contribuição
- Fork o projeto
- Crie uma branch para sua feature
- Commit suas mudanças
- Push para a branch
- Abra um Pull Request
📞 Suporte
- Issues: GitHub Issues
- Documentação ACBrLib: https://acbr.sourceforge.io/ACBrLib/BemVindo.html
📄 Licença
LGPL-2.1 License - veja o arquivo LICENSE para detalhes.
ACBrLib NFSe Node - Interface Node.js para ACBrLibNFSe
Versão: 1.0.5
Desenvolvido por: Projeto ACBr
