Download the PHP package brasilnfe/brasilnfe-php-sdk without Composer
On this page you can find all versions of the php package brasilnfe/brasilnfe-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download brasilnfe/brasilnfe-php-sdk
More information about brasilnfe/brasilnfe-php-sdk
Files in brasilnfe/brasilnfe-php-sdk
Package brasilnfe-php-sdk
Short Description SDK para integração com Brasil NFe
License MIT
Informations about the package brasilnfe-php-sdk
Brasil NFe PHP SDK
SDK oficial em PHP para integração com a API da Brasil NFe. 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(Node.js / TypeScript).
Índice
- Sobre a Brasil NFe
- Recursos
- Requisitos
- Instalação
- Configuração Inicial
- Arquitetura do SDK
- Guia Rápido
- Exemplos
- 1. Emitir NF-e (modelo 55)
- 2. Emitir NFC-e (modelo 65)
- 3. Emitir NF-e em lote
- 4. Emitir NFS-e
- 5. Emitir CT-e
- 6. Cancelar NF-e
- 7. Carta de Correção (CC-e)
- 8. Inutilizar numeração
- 9. Manifestar NF-e de entrada
- 10. Consultar status da SEFAZ
- 11. Buscar notas por período
- 12. Baixar XML / DANFE
- 13. Gerar SPED e Sintegra
- 14. Gestão de empresas e certificados
- Referência de Métodos
- Tratamento de Erros
- Tabelas de Referência
- Ambientes
- Como o SDK serializa o payload
- Utilitário BrasilNFeHelper
- Testes
- Licença
- Suporte
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: https://www.brasilnfe.com.br
- Documentação da API: https://www.brasilnfe.com.br/docs
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
- PHP >= 8.0
- Extensões
curlejsonhabilitadas - Composer
- Token de acesso válido do painel Brasil NFe
Instalação
Via Composer:
Ou, se estiver usando o SDK localmente, adicione ao seu composer.json:
E rode:
Configuração Inicial
A classe principal é BrasilNFe. 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.
A definição de produção x homologação não é feita pela URL: é controlada pelo campo
tipoAmbiente(1 = Produção,2 = Homologação) de cada requisição.
Arquitetura do SDK
A instância BrasilNFe agrega cinco módulos públicos:
| Módulo | Propriedade | Classe | Responsabilidade |
|---|---|---|---|
| Nota Fiscal | $bnfe->NotaFiscal |
Methods\NotaFiscal |
Emissão de NF-e, NFC-e, NFS-e, CT-e, MDF-e, DC-e, NF3-e |
| Eventos | $bnfe->Eventos |
Methods\Eventos |
Cancelamento, CC-e, inutilização, manifestação |
| Consultas | $bnfe->Consultas |
Methods\Consultas |
Status SEFAZ, busca, cadastro, cálculo de impostos |
| Arquivos | $bnfe->Arquivos |
Methods\Arquivos |
XML, DANFE, SPED, Sintegra, FCI |
| Empresa | $bnfe->Empresa |
Methods\Empresa |
Cadastro de empresas e certificados (requer UserToken) |
Estrutura de diretórios:
Guia Rápido
Exemplos
1. Emitir NF-e (modelo 55)
2. Emitir NFC-e (modelo 65)
3. Emitir NF-e em lote
4. Emitir NFS-e
5. Emitir CT-e
6. Cancelar NF-e
7. Carta de Correção (CC-e)
8. Inutilizar numeração
9. Manifestar NF-e de entrada
10. Consultar status da SEFAZ
11. Buscar notas por período
12. Baixar XML / DANFE
13. Gerar SPED e Sintegra
14. Gestão de empresas e certificados
Requer
userTokenno construtor deBrasilNFe.
Referência de Métodos
NotaFiscal — src/Methods/NotaFiscal.php
| Método | Endpoint | Payload | Retorno |
|---|---|---|---|
enviarNotaFiscal |
EnviarNotaFiscal |
NotaFiscalEnvio |
NotaFiscalRetorno |
enviarNotaFiscalLote |
EnviarNotaFiscalLote |
NotaFiscalLoteEnvio |
NotaFiscalLoteRetorno |
enviarConhecimentoTransporte |
EnviarConhecimentoTransporte |
CTeEnvio |
CTeRetorno |
enviarDeclaracaoConteudo |
EnviarDeclaracaoConteudo |
DCeEnvio |
DCeRetorno |
enviarNotaFiscalServico |
EnviarNotaFiscalServico |
NotaFiscalServicoEnvio |
NotaFiscalServicoRetorno |
enviarManifestoTransporte |
EnviarManifestoTransporte |
ManifestoTransporteEnvio |
ManifestoTransporteRetorno |
enviarNFEnerCom |
EnviarNFEnerCom |
NFEnerComEnvio |
NFEnerComRetorno |
enviarNotaFiscalComplementar |
EnviarNotaFiscalComplementar |
NotaFiscalComplementarEnvio |
NotaFiscalRetorno |
Eventos — src/Methods/Eventos.php
| Método | Endpoint | Payload | Retorno |
|---|---|---|---|
cancelarNotaFiscal |
CancelNF |
CancelarNotaFiscalEnvio |
EventoNotaFiscalRetorno |
enviarCartaCorrecao |
EnviarCartaCorrecao |
CartaCorrecaoEnvio |
EventoNotaFiscalRetorno |
inutilizarNumeracao |
InutilizarNumeracao |
InutilizarNumeracaoEnvio |
EventoNotaFiscalRetorno |
manifestarNotaFiscal |
ManifestarNotaFiscal |
ManifestarNotaFiscalEnvio |
EventoNotaFiscalRetorno |
encerrarManifestoTransporte |
EncerrarManifestoTransporte |
EncerrarManifestoTransporteEnvio |
EventoNotaFiscalRetorno |
Consultas — src/Methods/Consultas.php
| Método | Endpoint | Payload | Retorno |
|---|---|---|---|
consultarStatusSefaz |
ConsultarStatusSefaz |
StatusSefazEnvio |
StatusSefazRetorno |
calcularImpostos |
CalcularImpostos |
Produto[] |
CalculoImpostosRetorno |
preVisualizarNotaFiscal |
PreVisualizarNotaFiscal |
PreVisualizarNotaFiscalEnvio |
PreVisualizarNotaFiscalRetorno |
buscarNotaFiscalServico |
BuscarNotaFiscalServico |
BuscarNotaFiscalServicoEnvio |
NotaFiscalServicoRetorno |
obterNotasFiscais |
ObterNotasFiscais |
BuscarNotaFiscalEnvio |
BuscarNotaFiscalRetorno |
consultarCadastroSefaz |
ConsultarCadastroSefaz |
ConsultarCadastroEnvio |
ConsultarCadastroRetorno |
obterArquivoSped |
ObterArquivoSped |
string (código) |
SpedRetorno |
consultarLoteNFe |
ConsultarLoteNFe |
ConsultarLoteNFeEnvio |
NotaFiscalLoteRetorno |
Arquivos — src/Methods/Arquivos.php
| Método | Endpoint | Payload | Retorno |
|---|---|---|---|
gerarArquivoSintegra |
GerarArquivoSintegra |
SintegraEnvio |
SintegraRetorno |
gerarArquivoFci |
GerarArquivoFci |
FciEnvio |
FciRetorno |
obterArqEnerCom |
ObterArquivoNFEnerCom |
ArqEnerComEnvio |
ArqEnerComRetorno |
gerarArquivoSped |
GerarArquivoSped |
SpedEnvio |
SpedRetorno |
unificarArquivoSped |
UnificarArquivoSped |
UnificarSpedEnvio |
SpedRetorno |
recriarArquivoSped |
RecriarArquivoSped |
string (código) |
SpedRetorno |
obterArquivoNotaFiscal |
ObterArquivoNotaFiscal |
PegarArquivoEnvio |
string (binário) |
obterArquivoEvento |
ObterArquivoEvento |
PegarArquivoEventoEnvio |
string (binário) |
obterArquivosPorPeriodo |
ObterArquivosPorPeriodo |
ObterArquivosRangeEnvio |
ObterArquivosRangeRetorno |
Empresa — src/Methods/Empresa.php
| Método | Endpoint | Payload | Retorno |
|---|---|---|---|
alterarCertificado |
AlterarCertificado |
CertificadoEnvio |
CertificadoRetorno |
verificarCertificado |
VerifyCertificate |
CertificadoEnvio |
CertificadoRetorno |
adicionarEmpresa |
AdicionarEmpresa |
EmpresaEnvio |
EmpresaRetorno |
editarEmpresa |
EditarEmpresa |
EmpresaEnvio |
EmpresaRetorno |
deletarEmpresa |
DeletarEmpresa |
— | EmpresaRetorno |
buscarEmpresa |
BuscarEmpresa |
— | EmpresaEnvio |
buscarTodasEmpresas |
BuscarTodasEmpresas |
— | EmpresaEnvio[] |
gerarLinkAtivacao |
GerarLinkAtivacao |
— | string (URL Fintely) |
consultarNumeracao |
ConsultarNumeracao |
— | ConsultarNumeracaoRetorno |
atualizarNumeracao |
AtualizarNumeracao |
Numeracao |
AtualizarNumeracaoRetorno |
Tratamento de Erros
O SDK emite \Exception em dois casos:
- Falha de comunicação (timeout, DNS, TLS):
Erro ao efetuar requisição HTTPS com Brasil NFe: ... - Resposta HTTP fora de 2xx:
Resposta HTTP inválida (<código>)
Rejeições da SEFAZ não lançam exceção — elas vêm dentro do objeto de retorno. Sempre verifique returnNF->ok (e error / avisos nos retornos que herdam de Erros).
Tabelas de Referência
Modelos de documento
| Código | Documento |
|---|---|
| 55 | NF-e |
| 57 | CT-e |
| 58 | MDF-e |
| 65 | NFC-e |
tipoAmbiente
| Código | Ambiente |
|---|---|
| 1 | Produção |
| 2 | Homologação |
finalidade (NF-e)
| Código | Finalidade |
|---|---|
| 1 | Normal |
| 3 | Ajuste |
| 4 | Devolução / Retorno |
indicadorPresenca
| Código | Descrição |
|---|---|
| 0 | Não se aplica |
| 1 | Operação presencial |
| 2 | Operação não presencial, Internet |
| 3 | Operação não presencial, teleatendimento |
| 4 | NFC-e com entrega em domicílio |
| 5 | Presencial fora do estabelecimento |
| 9 | Operação não presencial, outros |
indicadorIe (destinatário)
| Código | Situação |
|---|---|
| 1 | Contribuinte ICMS (IE obrigatória) |
| 2 | Contribuinte isento |
| 9 | Não contribuinte |
modalidadeFrete
| Código | Descrição |
|---|---|
| 0 | Por conta do Remetente (CIF) |
| 1 | Por conta do Destinatário (FOB) |
| 2 | Por conta de Terceiros |
| 3 | Transporte próprio, conta do Remetente |
| 4 | Transporte próprio, conta do Destinatário |
| 9 | Sem ocorrência de transporte |
formaPagamento
| Código | Forma |
|---|---|
| 01 | Dinheiro |
| 02 | Cheque |
| 03 | Cartão de Crédito |
| 04 | Cartão de Débito |
| 05 | Crediário / Private Label |
| 10–13 | Vales (Alimentação, Refeição, Presente, Combustível) |
| 14 | Duplicata Mercantil |
| 15 | Boleto Bancário |
| 16 | Depósito Bancário |
| 17 | PIX Dinâmico |
| 18 | Transferência / Carteira Digital |
| 19 | Programa de fidelidade / cashback |
| 20 | PIX Estático |
| 90 | Sem pagamento |
| 99 | Outros |
tipoManifestacao
| Código | Evento |
|---|---|
| 1 | Confirmação da Operação |
| 2 | Ciência da Operação |
| 3 | Desconhecimento da Operação |
| 4 | Operação não Realizada |
crt (Empresa)
| Código | Regime |
|---|---|
| 1 | Simples Nacional |
| 2 | Simples Nacional — Excesso de sublimite |
| 3 | Regime Normal |
Ambientes
- Homologação: envie
tipoAmbiente = 2em cada requisição. Ideal para testes; nenhuma nota tem validade fiscal. - Produção:
tipoAmbiente = 1. A partir daqui a nota é real — o usuário e CNPJ precisam estar devidamente autorizados no painel Brasil NFe e com certificado digital A1 válido.
A URL base padrão é https://api.brasilnfe.com.br/services/ — a mesma para homologação e produção. O ambiente é sempre determinado pelo campo do payload.
Como o SDK serializa o payload
O SDK usa symfony/serializer configurado em BrasilNFeRequest:
- Campos em PHP usam
camelCase(ex.:chaveNF,valorUnitario). - Na resposta, o SDK normaliza automaticamente nomes vindos em
PascalCase,camelCaseouUPPERpara o formato PHP (viaCaseInsensitiveNameConverter). - Datas
DateTimesão serializadas no formatoY-m-d\TH:i:s. -
Toda requisição envia os headers:
- Timeout padrão: 300s (configurado em
curl_setopt).
Utilitário BrasilNFeHelper
A classe BrasilNFeHelper expõe um método estático para ratear valores proporcionalmente entre itens (útil para distribuir frete, desconto ou seguro entre produtos da nota):
Testes
Licença
Distribuído sob a licença MIT. Veja LICENSE para mais informações.
Suporte
- Site: https://www.brasilnfe.com.br
- E-mail: [email protected]
- WhatsApp: +55 (31) 9 7168-5947
Desenvolvido por BRASIL NFE LTDA — CNPJ 39.658.743/0001-99.