README

Este é um repositório mantida pela equipe de desenvolvimento da Saipos (https://www.saipos.com.br/). Onde serão feitas correções de BUGs e implementações necessárias para o bom funcionamento da biblioteca conforme a necessidade das nossas ferramentas. Qualquer desenvolvedor que deseje contribuir, seja bem vindo!

Para maiores informações do repositório original (https://github.com/nfephp-org/nfephp).

NFePHP

NFePHP é uma API para gerenciamento das comunicações entre o emitente de NFe e os serviços dos SEFAZ estaduais. Inteiramente construído em PHP para rodar sob qualquer sistema operacional. Para começar veja nossas páginas Wiki.

Não deixe de se cadastrar no grupo de discussão do NFePHP!

Versão Estável

Devido as constantes alterações, dos schemas, webservices e legislações, promovidas pelo Congresso Nacional, pelas SEFAZ estaduais e pelos provedores dos webservices, a versão em MASTER e a última TAG são as mais estáveis e funcionais.

Instalação com Composer

Pelo terminal vá até a raiz de seu projeto e lá execute :

composer require saipos/saipos-nfephp

Isso fará com que o SEU arquivo composer.json seja acrescido da dependência da API. A API será baixada e colocada na pasta "vendor" e o arquivo autoload.php sejá atualizado.

Condicionantes

Para usar essa API é necessário conhecimento em programação PHP, bem como conhecer os padrões atuais da linguagem e ter bases de legislação fiscal. É extremanente recomendável que seja estudado o conteúdo dos seguintes sites.

Documentação do Funcionamento do sistema de NFe SEFAZ NFe
Documentação do Funcionamento do sistema de CTe SEFAZ CTe
Documentação do Funcionamento do sistema de MDFe SEFAZ MDfe
Composer Documentação Construção do composer.json
IMPORTANTE PHP do Jeito Certo
Coding Style Guide PSR-2
Autoload PSR-4

NOTA: A NFSe Nota Fiscal de Serviços Eletrônica, não tem padrão único, e a API tem somente alguns exemplos de montagem de um sistema para esse fim, mas nenhuma API realmente funcional para esse tipo de documentos fiscais.

Objetivo

A API permite que um programa emissor de NFe se comunique com a SEFAZ. A API não foi criada para ela própria emitir a NFe tendo em vista a enorme quantidade de informações necessárias e as características e especificidades de cada emitente.

Dependências

composer https://getcomposer.org/
Apache: http://httpd.apache.org/
PHP 5.5+: http://php.net
Bibliotecas de terceiros
FPDF: Provisóriamente usada para gerar os documentos em PDF. Veja http://www.fpdf.org/.Deverá ser substituida pela classe ZendPdf (devido ao tendimento dos padrões PSR e ser mais ativamente mantida e distribuida via composer.
zendframework/zend-mail (v.2.x) Usada para envio dos emails aos destinátarios dos docuemntos fiscais eletrônicos.
zendframework/zend-barcode (v.2.x) Usada para gerar os codigos de barras 128 presente nos documentos fiscais em PDF.
soundasleep/html2text (v.0.2) Usada para converter as mensagens Htlm dos emails em seu equivalente em texto puro. Usada na classe de envio dos emails.
endroid/qrcode (v.1.x) Usada para gerar o QRCode impresso nas NFCe
Extensões PHP
cURL: Normalmente já vem habilitado com o PHP 5.3+. Veja http://br2.php.net/manual/book.curl.php e http://curl.haxx.se/.
OpenSSL: Normalmente já vem habilitado com o PHP 5.3+. Veja http://br2.php.net/manual/book.openssl.php e http://www.openssl.org/.
mcrypt: Normalmente já vem habilitado com o PHP 5.3+. Veja http://www.php.net/manual/book.mcrypt.php.
imap: Normalmente já vem habilitado com o PHP 5.3+. Veja http://www.php.net/manual/book.imap.php
GD: Normalmente já vem habilitado com o PHP 5.3+. Veja http://www.php.net/manual/book.image.php
ZIP: Necessário para o download de NFe da SEFAZ. Veja http://www.php.net/manual/en/book.zip.php
Zlib: Necessária para descompactar NFe após download. Veja http://www.php.net/manual/en/book.zlib.php

Instalação

Para mais detalhes sobre a instalação, veja https://github.com/nfephp-org/nfephp/wiki/Instalação.

Quick start

Clone o repositório com git clone --branch=develop https://github.com/Saipos/saipos-nfephp.git.

$ composer install
$ ./vendor/bin/phpunit

Desenvolvimento

Para todo o desenvolvimento, correções de bugs, inclusões e testes deverá ser usada branch develop. Na branch masterestarão os códigos considerados como estáveis. Novas branches poderão surgir em função das necessidades que se apresentarem, seja para manter versionamentos anteriores seja para estabelecer correções de bugs. Mas apenas essas duas branches estabelecidas é que serão permanentente mantidas.

Bug tracker

Encontrou um bug? Informe-nos aqui no GitHub!

https://github.com/nfephp-org/nfephp/issues

saipos / saipos-nfephp

Maintainers

Details