PHPackages                             alves/nfse-php-brazil - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. alves/nfse-php-brazil

ActiveLibrary[API Development](/categories/api)

alves/nfse-php-brazil
=====================

Pacote para emissao de NFS-e para municipios brasileiros usando componentes NFePHP (https://github.com/nfephp-org)

v1.8.0(3w ago)054↓90%MITPHPPHP ^8.1

Since Jun 4Pushed 3w agoCompare

[ Source](https://github.com/andersonav/nfse-php-brazil)[ Packagist](https://packagist.org/packages/alves/nfse-php-brazil)[ RSS](/packages/alves-nfse-php-brazil/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (10)Versions (11)Used By (0)

nfse-php-brazil
===============

[](#nfse-php-brazil)

Biblioteca PHP para integração de NFS-e em municípios brasileiros, com catálogo compilado de provedores, runtime por adapter e geração de DANFSe em PDF.

Visão geral
-----------

[](#visão-geral)

O projeto foi organizado para servir como base de uma API própria de NFS-e. Hoje ele entrega:

- resolução de município, provedor e URLs por ambiente;
- execução unificada de emissão, cancelamento, substituição e consultas;
- catálogo versionado dentro do próprio repositório;
- geração de DANFSe em PDF a partir do XML da NFS-e;
- interface web para operação, diagnóstico e testes.

Estado atual do catálogo
------------------------

[](#estado-atual-do-catálogo)

O projeto não depende mais de ACBr em runtime.

O catálogo já está consolidado e versionado em:

- `storage/municipios-catalog.php`
- `storage/municipios-catalog.js`

Em produção, a biblioteca usa esses arquivos compilados diretamente.

Estrutura principal
-------------------

[](#estrutura-principal)

- `src/Tools.php`
    - fachada principal da biblioteca.
- `src/RestCurl.php`
    - resolve contexto municipal, provedor e URLs.
- `src/Provider/`
    - contracts, registry e adapters por provedor.
- `src/ProviderBuilders/`
    - builders de envelopes e payloads por provedor.
- `src/Danfse/`
    - geração de DANFSe em PDF.
- `storage/municipios-catalog.php`
    - catálogo principal consumido em runtime.
- `storage/municipios-catalog.js`
    - catálogo serializado para consumo auxiliar.
- `storage/schemes/`
    - schemas e artefatos técnicos mantidos no projeto.
- `bin/municipio-info.php`
    - utilitário simples para consulta do catálogo.
- `web/public/index.php`
    - interface web de operação e homologação.

Instalação
----------

[](#instalação)

```
composer require alves/nfse-php-brazil
```

Configuração mínima
-------------------

[](#configuração-mínima)

Exemplo:

```
{
  "tpamb": 2,
  "prefeitura": "3550308",
  "catalog_compiled_path": "/app/storage/municipios-catalog.php"
}
```

Operações principais
--------------------

[](#operações-principais)

Consulta e diagnóstico:

- `detalhesMunicipio($prefeitura = null)`
- `diagnosticoMunicipio()`
- `listarMunicipios($uf = null, $provedor = null, $limit = null)`
- `municipioSuportado()`

Operações municipais:

- `emitirNfseMunicipal($payload, $service = 'recepcionar')`
- `cancelarNfseMunicipal($payload, $service = 'cancelar_nfse')`
- `substituirNfseMunicipal($payload, $service = 'substituir_nfse')`
- `consultarMunicipal($service = 'consultar_nfse')`
- `consultarDanfseMunicipal($service = 'consultar_danfse')`

Padrão nacional:

- `emitirNfsePadraoNacional($xmlDps)`
- `cancelarNfsePadraoNacional($evento)`
- `consultarNfseChave($chave, $encoding = true)`

DANFSe
------

[](#danfse)

O componente já possui geração de DANFSe em PDF:

- `gerarDanfsePdf($xmlNfse, $outputPath = null)`
- `gerarDanfsePdfPorChave($chave, $outputPath = null)`

Exemplo:

- `examples/GerarDanfsePdf.php`

Interface web
-------------

[](#interface-web)

A interface em `web/public/index.php` permite:

- consultar detalhes do município;
- executar diagnóstico;
- listar municípios;
- emitir, consultar, cancelar e substituir NFS-e;
- consultar NFS-e por chave;
- gerar DANFSe por chave ou por XML manual;
- visualizar request e response técnicos.

Utilitário de catálogo
----------------------

[](#utilitário-de-catálogo)

Consultar um município pelo terminal:

```
php bin/municipio-info.php 3550308
```

Saída em JSON:

```
php bin/municipio-info.php 3550308 --json
```

Testes
------

[](#testes)

Executar a suíte principal:

```
composer test
```

Somente municípios:

```
composer test:municipios
```

Integração:

```
composer test:integration
```

Observações
-----------

[](#observações)

- O catálogo está versionado no repositório e pronto para uso em novos clones.
- O arquivo `.php` é a fonte principal de runtime.
- O arquivo `.js` é mantido como serialização auxiliar do mesmo catálogo.
- A pasta `storage/schemes` permanece como apoio técnico para validações e integração com provedores.

###  Health Score

43

—

FairBetter than 89% of packages

Maintenance95

Actively maintained with recent releases

Popularity12

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~3 days

Total

10

Last Release

23d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/fec03576723f1006aa8d355fc6b99baf9969bd016cbe5550eb7f13978e14a984?d=identicon)[andersonav](/maintainers/andersonav)

---

Top Contributors

[![andersonav](https://avatars.githubusercontent.com/u/38483866?v=4)](https://github.com/andersonav "andersonav (14 commits)")

---

Tags

nfsemeinfse-php-brazil

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/alves-nfse-php-brazil/health.svg)

```
[![Health](https://phpackages.com/badges/alves-nfse-php-brazil/health.svg)](https://phpackages.com/packages/alves-nfse-php-brazil)
```

###  Alternatives

[matomo/matomo

Matomo is the leading Free/Libre open analytics platform

21.7k38.9k](/packages/matomo-matomo)[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

751291.4k46](/packages/civicrm-civicrm-core)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.2k18.1k](/packages/prestashop-prestashop)[tempest/framework

The PHP framework that gets out of your way.

2.2k34.4k16](/packages/tempest-framework)[hadder/nfse-nacional

Pacote para geração de NFSe Nacional usando componentes NFePHP (https://github.com/nfephp-org)

754.6k](/packages/hadder-nfse-nacional)[myparcelnl/sdk

This package is designed to send and receive data from MyParcel by means of an API.

31523.5k26](/packages/myparcelnl-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)