PHPackages                             brasilnfe/brasilnfe-php-sdk - 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. brasilnfe/brasilnfe-php-sdk

ActiveLibrary[API Development](/categories/api)

brasilnfe/brasilnfe-php-sdk
===========================

SDK para integração com Brasil NFe

1.2.0(1mo ago)287MITPHPPHP >=8.0

Since May 18Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/BrasilNFe/brasilnfe-php-sdk)[ Packagist](https://packagist.org/packages/brasilnfe/brasilnfe-php-sdk)[ RSS](/packages/brasilnfe-brasilnfe-php-sdk/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (3)Versions (5)Used By (0)

Brasil NFe PHP SDK
==================

[](#brasil-nfe-php-sdk)

[![Packagist Version](https://camo.githubusercontent.com/3be39a7e9d658d55dfc565092cb0c5241c5b3faab8705f279d2667a461cdd41d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7061636b61676973742d76312e322e302d626c75652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/brasilnfe/brasilnfe-php-sdk)[![PHP Version](https://camo.githubusercontent.com/e4c8bb5752c8e2d69e963b83a97e8dd76f6afa9321c848503d806d60c48b2503/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344382e302d3737376262342e7376673f7374796c653d666c61742d737175617265)](https://www.php.net/)[![License: MIT](https://camo.githubusercontent.com/6c711032aff1ca0eb6b211aa6cb3649ce7fd64a7714e1181d4bb457f9680e7cf/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e2e7376673f7374796c653d666c61742d737175617265)](https://opensource.org/licenses/MIT)

SDK oficial em **PHP** para integração com a API da **[Brasil NFe](https://www.brasilnfe.com.br)**. Permite emitir, consultar, cancelar e gerenciar documentos fiscais eletrônicos (NF-e, NFC-e, CT-e, MDF-e, NFS-e, DC-e, NF3-e) e arquivos fiscais (SPED, Sintegra, FCI), de forma orientada a objetos com tipagem forte e serialização automática.

> Equivalente em PHP ao pacote [`brasilnfe`](https://www.npmjs.com/package/brasilnfe) (Node.js / TypeScript).

---

Índice
------

[](#índice)

- [Sobre a Brasil NFe](#sobre-a-brasil-nfe)
- [Recursos](#recursos)
- [Requisitos](#requisitos)
- [Instalação](#instala%C3%A7%C3%A3o)
- [Configuração Inicial](#configura%C3%A7%C3%A3o-inicial)
- [Arquitetura do SDK](#arquitetura-do-sdk)
- [Guia Rápido](#guia-r%C3%A1pido)
- [Exemplos](#exemplos)
    - [1. Emitir NF-e (modelo 55)](#1-emitir-nf-e-modelo-55)
    - [2. Emitir NFC-e (modelo 65)](#2-emitir-nfc-e-modelo-65)
    - [3. Emitir NF-e em lote](#3-emitir-nf-e-em-lote)
    - [4. Emitir NFS-e](#4-emitir-nfs-e)
    - [5. Emitir CT-e](#5-emitir-ct-e)
    - [6. Cancelar NF-e](#6-cancelar-nf-e)
    - [7. Carta de Correção (CC-e)](#7-carta-de-corre%C3%A7%C3%A3o-cc-e)
    - [8. Inutilizar numeração](#8-inutilizar-numera%C3%A7%C3%A3o)
    - [9. Manifestar NF-e de entrada](#9-manifestar-nf-e-de-entrada)
    - [10. Consultar status da SEFAZ](#10-consultar-status-da-sefaz)
    - [11. Buscar notas por período](#11-buscar-notas-por-per%C3%ADodo)
    - [12. Baixar XML / DANFE](#12-baixar-xml--danfe)
    - [13. Gerar SPED e Sintegra](#13-gerar-sped-e-sintegra)
    - [14. Gestão de empresas e certificados](#14-gest%C3%A3o-de-empresas-e-certificados)
- [Referência de Métodos](#refer%C3%AAncia-de-m%C3%A9todos)
- [Tratamento de Erros](#tratamento-de-erros)
- [Tabelas de Referência](#tabelas-de-refer%C3%AAncia)
- [Ambientes](#ambientes)
- [Como o SDK serializa o payload](#como-o-sdk-serializa-o-payload)
- [Utilitário BrasilNFeHelper](#utilit%C3%A1rio-brasilnfehelper)
- [Testes](#testes)
- [Licença](#licen%C3%A7a)
- [Suporte](#suporte)

---

Sobre a Brasil NFe
------------------

[](#sobre-a-brasil-nfe)

A **Brasil NFe** oferece uma API REST para emissão de notas fiscais e documentos eletrônicos, com foco em estabilidade, performance e conformidade com a legislação brasileira.

- **Site oficial:**
- **Documentação da API:**

---

Recursos
--------

[](#recursos)

O SDK cobre todos os módulos da API REST da Brasil NFe:

- **Emissão de documentos fiscais**
    - NF-e (modelo 55)
    - NFC-e (modelo 65)
    - NFS-e (nota fiscal de serviço)
    - CT-e (modelo 57)
    - MDF-e (modelo 58)
    - DC-e (Declaração de Conteúdo)
    - NF3-e / NF-e de Energia (`NFEnerCom`)
    - Nota Fiscal Complementar
    - Envio em lote
- **Eventos**
    - Cancelamento
    - Carta de Correção (CC-e)
    - Inutilização de numeração
    - Manifestação do Destinatário
    - Encerramento de MDF-e
- **Consultas**
    - Status SEFAZ
    - Consulta de Cadastro (IE/CNPJ)
    - Busca de notas por período
    - Pré-visualização de DANFE
    - Cálculo de impostos
- **Arquivos fiscais**
    - Download de XML e DANFE
    - SPED Fiscal e Contribuições (individual e unificado)
    - Sintegra
    - FCI (Ficha de Conteúdo de Importação)
    - Arquivos por range de chaves
- **Gestão**
    - Cadastro e edição de empresas
    - Envio e verificação de certificados digitais A1

---

Requisitos
----------

[](#requisitos)

- PHP **>= 8.0**
- Extensões `curl` e `json` habilitadas
- Composer
- Token de acesso válido do painel Brasil NFe

---

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

[](#instalação)

Via Composer:

```
composer require brasilnfe/brasilnfe-php-sdk
```

Ou, se estiver usando o SDK localmente, adicione ao seu `composer.json`:

```
{
    "require": {
        "brasilnfe/brasilnfe-php-sdk": "^1.1"
    }
}
```

E rode:

```
composer install
```

---

Configuração Inicial
--------------------

[](#configuração-inicial)

A classe principal é [`BrasilNFe`](src/BrasilNFe.php). Com um **Token** você já tem acesso a todos os módulos fiscais. O **UserToken** é opcional e só é necessário para o módulo de gestão de empresas/certificados.

```