README

NFePHP 是一个用于管理 NFe 发起者与省级 SEFAZ 服务之间通信的 API。完全使用 PHP 构建，可在任何操作系统上运行。要开始，请查看我们的 Wiki 页面。

不要错过在 NFePHP 讨论组注册！

PULL REQUESTS

尊敬的，本存储库只接受与 BUG 和由 SEFAZ 推动的变更相关的修正的 "PULL REQUESTS"。

不再接受代码更改、改进或新功能或新服务的添加，所有这些改进都应发送到新的存储库 SPED-XXX。

不久（截至 2017 年中旬），此存储库将停止接收任何贡献并将被废弃，以支持新的存储库！！！为了保持新版本（4.1.x-dev）API 的完整性，正在维护 "namespaces"、方法调用及其参数，除非因 "force majeure" 原因（如 SEFAZ 强制改变此情况），否则不应更改。在使用新版本时，应注意类名命名简化，以及功能如打印已被转移到另一个存储库。

存储库重结构化

CTe、MDFe 等结构已被从本存储库移除，并转移到其新的存储库，请参阅

SPED NFe 新的 NFe 类存储库（测试中）

SPED CTe 新的 CTe 类存储库（开发中）

SPED MDFe 新的 MDFe 类存储库（开发中）

SPED NFSe 新的 NFSe 类存储库（开发中）

其他组件也将有新的存储库，但暂时仍留在此处。

SPED COMMON 新的用于所有或多个项目的公共类存储库。

SPED DA 生成文档打印的类的新存储库。

POSPRINT 用于 POS 打印机的打印框架（开发中）

SPED GNRE GNRE 类的存储库（稳定版）

除了这些其他存储库外，还在建设中或已经提供库

SPED EFD Sped EFD 财务类的存储库（开发中）

SPED RESTFUL 用于生成 Sped 文档的 RestFul 应用程序（开发中）

SPED CONSOLE 命令行工具资源集合（开发中）

SPED DOCS NFePHP 包文档集合（已过时、不完整和部分）

SPED EMISSOR 文档生成应用程序 "front-end"（未开始）

SPED eSOCIAL eSocial 类库存储库（仅文档）

SPED SERIALIZER XML 序列化类库存储库（概念）

其他相关项目，但具有特定目的

SPED eFINANCEIRA eFinanceira 类库存储库（稳定版）

SPED eSFINGE 与 TCE/SC 的 eSfinge 系统集成框架（稳定版）

贡献

这是一个完全的开源项目，使用和修改它您无需支付任何费用。但是为了继续维护它，我们需要得到一些贡献，无论是协助编码、文档编写还是进行测试和错误/BUG 识别。

此外，如果您认为这里获取的任何信息对您都有帮助，并且这值得一些金钱，您愿意捐赠，请随时通过以下方式发送任何金额：

[![](https://stc.pagseguro.uol.com.br/public/img/botoes/doacoes/209x48-doar-assina.gif)](https://pag.ae/bkXPq4)

重要

从本版本开始，版本号将遵循 API 的自身序列，而不再引用 NFe、CTe 等布局版本。

在本版本（4.0.x）中，只有 NFe 是可用的，对于 CTe 和 MDFe，至少在其他贡献者愿意协助重构之前，必须使用 3.10-Obsoleta 标签。

开发版本

版本 4.0.x-dev（注意 SEFAZ 布局版本 3.10）

稳定版本

由于国会、州 SEFAZ 和 Web 服务提供商不断推出 schemas、webservice 和法律，MASTER 版本和最新标签是最稳定和功能最齐全的。

使用 Composer 安装

在终端中，前往您项目的根目录，然后执行：

composer require nfephp-org/nfephp

这将使您的 composer.json 文件增加 API 依赖项。API 将被下载并放置在 "vendor" 文件夹中，同时更新 autoload.php 文件。

条件

使用此 API 需要具备 PHP 编程知识，了解当前语言标准，并具备税收法规基础知识。强烈建议研究以下网站的资料。

NFe 系统工作原理文档 SEFAZ NFe
CTe 系统工作原理文档 SEFAZ CTe
MDFe 系统工作原理文档 SEFAZ MDfe
Composer 文档构建 composer.json
重要 PHP 正确的方式
编码风格指南 PSR-2
自动加载 PSR-4

注意：NFSe（电子服务发票）没有唯一的规范，API仅提供了构建此类系统的一些示例，但没有真正可用的API来处理此类税务文件。

目标

API允许NFe发射程序与SEFAZ通信。考虑到需要的大量信息和每个发射者的特性和规格，API不是为了自身发射NFe而创建的。

依赖

composer https://getcomposer.org.cn/
Apache: https://httpd.apache.ac.cn/
PHP 5.4+: https://php.ac.cn
第三方库
FPDF：暂时用于生成PDF文档。请参阅 http://www.fpdf.org/。应被ZendPdf类（由于PSR标准趋势，更积极地维护和通过composer分发）取代。
zendframework/zend-mail (v.2.x) 用于向电子税务文件收件人发送电子邮件。
zendframework/zend-barcode (v.2.x) 用于在PDF税务文件中生成128位条码。
soundasleep/html2text (v.0.2) 用于将电子邮件中的HTML消息转换为纯文本。用于电子邮件发送类。
endroid/qrcode (v.1.x) 用于生成NFCe上的QRCode。
PHP扩展
cURL：通常与PHP 5.3+一起启用。请参阅 http://br2.php.net/manual/book.curl.php 和 http://curl.haxx.se/。
OpenSSL：通常与PHP 5.3+一起启用。请参阅 http://br2.php.net/manual/book.openssl.php 和 http://www.openssl.org/。
mcrypt：通常与PHP 5.3+一起启用。请参阅 https://php.ac.cn/manual/book.mcrypt.php。
imap：通常与PHP 5.3+一起启用。请参阅 https://php.ac.cn/manual/book.imap.php
GD：通常与PHP 5.3+一起启用。请参阅 https://php.ac.cn/manual/book.image.php
ZIP：用于从SEFAZ下载NFe。请参阅 https://php.ac.cn/manual/en/book.zip.php
Zlib：下载NFe后用于解压缩。请参阅 https://php.ac.cn/manual/en/book.zlib.php

安装

有关安装的更多详细信息，请参阅 https://github.com/nfephp-org/nfephp/wiki/Instalação。

快速入门

使用 git clone --branch=develop https://github.com/nfephp-org/nfephp.git 或下载最新稳定版克隆存储库。

$ composer install
$ ./vendor/bin/phpunit

版本控制

为了透明度和对发布周期的辨别，并力求保持与先前版本的兼容性，NFePHP的版本号将尽可能保持以下标准。

发布将按照以下格式编号

<major>.<minor>.<patch>

并将按照以下指南构建

与先前版本的兼容性中断，增加 <major>。
在不破坏先前版本兼容性的情况下添加新功能，增加 <minor>。
修复错误和其他更改，增加 <patch>。

有关更多信息，请访问 http://semver.org/。

开发

对于所有开发、错误修复、新增功能和测试，应使用分支 develop。在分支 master 中将包含被认为是稳定的代码。根据需要，可能还会出现新的分支，无论是为了保持旧版本还是为了建立错误修复。但仅这两个已建立的分支将永久维护。

错误跟踪器

发现了错误？请在此处GitHub上告诉我们！

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

维护者（待审查）

NFe - Roberto L. Machado
NFCe - Roberto L. Machado
NFSe - 未定义
CTe - 未定义
MDFe - 未定义
CLe - 未定义

拉取请求

为了使您的拉取请求被接受，它必须遵循本文档中描述的标准 http://www.walkeralencar.com/PHPCodeStandards.pdf

sqginfo / nfephp

维护者

详细信息