1. Go to this page and download the library: Download hyperdevs/nfse library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
hyperdevs / nfse example snippets
use Hyperdevs\Nfse\Application\DTO\Request\DpsRequest;
use Hyperdevs\Nfse\Application\DTO\Request\PrestadorRequest;
use Hyperdevs\Nfse\Application\DTO\Request\ServicoRequest;
use Hyperdevs\Nfse\Application\DTO\Request\TomadorRequest;
use Hyperdevs\Nfse\Application\Exception\ServiceException;
use Hyperdevs\Nfse\Application\Exception\ValidationException;
use Hyperdevs\Nfse\Facade\NfseNacionalFacade;
// 1. A "Facade" é o único objeto que você precisa usar. Em Laravel, injete ou resolva do container:
// (isto usa o certificado/prefeitura fixos do .env — para múltiplos clientes, veja a seção
// "Vários clientes (multi-tenant/SaaS)" mais abaixo)
$facade = app(NfseNacionalFacade::class);
// 2. Monte os dados do prestador (quem está emitindo a nota — sua empresa)
$prestador = new PrestadorRequest(
documento: '12345678000199', // CNPJ da sua empresa (só números)
isCnpj: true,
inscricaoMunicipal: '123456',
razaoSocial: 'Minha Empresa LTDA',
telefone: '11999999999',
email: '[email protected]',
logradouro: 'Rua Exemplo',
numero: '100',
complemento: null,
bairro: 'Centro',
codigoMunicipio: '3550308', // mesmo código IBGE do .env
uf: 'SP',
cep: '01000000',
regimeTributario: 1, // 1 = Simples Nacional (consulte seu contador)
);
// 3. Monte os dados do tomador (cliente que está pagando pelo serviço)
$tomador = new TomadorRequest(
documento: '98765432100',
isCnpj: false, // false = CPF, true = CNPJ
razaoSocial: 'Nome do Cliente',
telefone: null,
email: '[email protected]',
logradouro: 'Av. Cliente',
numero: '200',
complemento: null,
bairro: 'Bairro Cliente',
codigoMunicipio: '3550308',
uf: 'SP',
cep: '01001000',
);
// 4. Monte os dados do serviço prestado
$servico = new ServicoRequest(
discriminacao: 'Serviço de consultoria em TI',
codigoTributacao: '0107', // código do serviço conforme a LC 116
valorServicos: 500.00,
aliquotaIss: 2.0, // alíquota do ISS em % (ex.: 2%)
);
// 5. Junte tudo na DPS (Declaração de Prestação de Serviço — é o "pedido" de emissão)
$dpsRequest = new DpsRequest(
tipoAmbiente: 2, // igual ao NFSE_TP_AMB do .env
dataEmissao: date('c'),
versaoAplicacao: '1.0.0',
serie: 1,
numero: 1, // número sequencial da sua nota — controle isso no seu banco
dataCompetencia: date('Y-m-d'),
tipoEmissao: 1,
codigoMunicipioEmissor: '3550308',
prestador: $prestador,
servico: $servico,
tomador: $tomador,
);
// 6. Envia para a SEFIN
try {
$resposta = $facade->emitirDps($dpsRequest);
if ($resposta->success) {
echo "NFS-e emitida! Chave de acesso: {$resposta->chaveAcesso}\n";
} else {
echo "A SEFIN recusou a nota: {$resposta->mensagem}\n";
// $resposta->erros traz a lista completa de erros retornados
}
} catch (ValidationException $e) {
// Os dados enviados têm algum problema (ex.: CNPJ inválido, campo obrigatório faltando)
echo "Dados inválidos: {$e->getMessage()}\n";
} catch (ServiceException $e) {
// Falha de comunicação com a SEFIN (rede, timeout, certificado, etc.)
echo "Erro ao comunicar com a SEFIN: {$e->getMessage()}\n";
}
// Consultar pela chave de acesso (50 dígitos)
$nfse = $facade->consultarPorChave($resposta->chaveAcesso);
// Cancelar (usa a mesma Facade, com um EventoRequest)
use Hyperdevs\Nfse\Application\DTO\Request\EventoRequest;
$evento = new EventoRequest(
tipoAmbiente: 2,
versaoAplicacao: '1.0.0',
dataEvento: date('c'),
chaveNfse: $resposta->chaveAcesso,
tipoEvento: '101101', // código do tipo de evento (ex.: cancelamento)
codigoMotivo: '1',
descricaoMotivo: 'Erro de emissão',
);
$facade->cancelar($evento);
use Hyperdevs\Nfse\Config\Config;
use Hyperdevs\Nfse\Http\Security\CertificateManager;
use Hyperdevs\Nfse\Http\Security\XmlSigner;
use Hyperdevs\Nfse\Provider\NfseManager;
// $cliente é o registro do seu banco (empresa/tenant que está emitindo a nota)
$certificateManager = CertificateManager::fromPfxFile(
$cliente->caminho_certificado,
$cliente->senha_certificado,
);
$facade = app(NfseManager::class)->make(
config: new Config([
'tpAmb' => $cliente->ambiente, // 1 = Produção, 2 = Homologação
'prefeitura' => $cliente->codigo_ibge,
]),
certificateManager: $certificateManager,
xmlSigner: new XmlSigner($certificateManager->getCertificate()),
);
$resposta = $facade->emitirDps($dpsRequest);
use Hyperdevs\Nfse\Config\Config;
use Hyperdevs\Nfse\Facade\NfseNacionalFacade;
use Hyperdevs\Nfse\Http\Security\CertificateManager;
use Hyperdevs\Nfse\Http\Security\XmlSigner;
$certificateManager = CertificateManager::fromPfxFile('/caminho/certificado.pfx', 'senha');
$xmlSigner = new XmlSigner($certificateManager->getCertificate());
$facade = NfseNacionalFacade::create(
config: new Config(['tpAmb' => 2, 'prefeitura' => '3550308']),
certificateManager: $certificateManager,
xmlSigner: $xmlSigner,
);
bash
php artisan vendor:publish --tag=nfse-config
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.