https://github.com/mazinsw/nfe-api
API para geração e envio de notas fiscais eletrônicas brasileiras
https://github.com/mazinsw/nfe-api
nfce nfe php
Last synced: about 11 hours ago
JSON representation
API para geração e envio de notas fiscais eletrônicas brasileiras
- Host: GitHub
- URL: https://github.com/mazinsw/nfe-api
- Owner: mazinsw
- License: mit
- Created: 2016-11-27T05:57:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-28T14:43:38.000Z (almost 2 years ago)
- Last Synced: 2025-10-05T04:53:11.697Z (9 months ago)
- Topics: nfce, nfe, php
- Language: PHP
- Size: 28.3 MB
- Stars: 53
- Watchers: 12
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# NFe-API
## Bliblioteca para geração, transmissão e tratamento de eventos de notas fiscais eletrônicas
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
###### Essa biblioteca permite a geração, transmissão e tratamento de eventos de notas fiscais eletrônicas do Brasil
## Vantagens
- Código bem estruturado e bem reaproveitado que permite a fácil manutenção
- Estrutura de código expansível para vários modelos de notas
- Fácil configuração e usabilidade (Só precisa implementar 2 classes para integração)
- Testes e cobertura de código que garantem melhor estabilidade
- Estrutura desvinculada do XML, atualizações quase não afetam em produção
## Motivo do projeto
As biliotecas de código aberto encontradas até o momento (2016) não fornecem uma estrutura sólida e de fácil utilização/manutenção, dessa forma surgiu a necessidade de criar uma bilioteca capaz de gerar notas fiscais em diversos modelos e que seja de fácil utilização
## Ideia do projeto
A ideia é criar uma bilioteca em que as entidades da nota sejam implementadas em classes separadas, cada uma gerando seu próprio nó XML, no final da geração todos os nós são unificados assim gerando o XML por completo, dessa forma fica fácil a manutenção pois parte da ideia da divisão e conquista
## Instalação
Você precisará do [Composer][link-composer] para instalar essa biblioteca.
Execute o comando abaixo na pasta do seu projeto
```sh
composer require mazinsw/nfe-api
```
## Manutenção
Atualizar tabelas IBPT
```sh
# linux
./utils/update_IBPT.sh
```
```cmd
REM Windows
utils\update_IBPT.bat
```
## Documentação
Acesse [aqui](../../wiki) para ver a documentação
## Colaboração no projeto
Para melhoria do projeto envie suas implementações por meio de um Pull request
## Solução de problemas
Caso tenha problemas ao utilizar a biblioteca, acesse o grupo no Discord: https://discord.gg/XGU2Y77
## Dependências
- PHP 7.3 ou superior
- Extensão openssl para assinatura da nota
- Extensão curl para envio da nota
## Limitações
- Apenas o modelo NFC-e foi implementado e testado
- Só funciona com certificado digital modelo A1
- Não suporta duas versões da NF-e ao mesmo tempo
## Licença
Por favor veja o [arquivo de licença](/LICENSE.txt) para mais informações.
[ico-version]: https://poser.pugx.org/mazinsw/nfe-api/version
[ico-travis]: https://api.travis-ci.org/mazinsw/nfe-api.svg
[ico-scrutinizer]: https://scrutinizer-ci.com/g/mazinsw/nfe-api/badges/coverage.png
[ico-code-quality]: https://scrutinizer-ci.com/g/mazinsw/nfe-api/badges/quality-score.png
[ico-downloads]: https://poser.pugx.org/mazinsw/nfe-api/d/total.svg
[link-packagist]: https://packagist.org/packages/mazinsw/nfe-api
[link-travis]: https://travis-ci.org/mazinsw/nfe-api
[link-scrutinizer]: https://scrutinizer-ci.com/g/mazinsw/nfe-api/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/mazinsw/nfe-api
[link-downloads]: https://packagist.org/packages/mazinsw/nfe-api
[link-composer]: https://getcomposer.org