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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package brasilnfe-php-sdk

Brasil NFe PHP SDK

Packagist Version PHP Version License: MIT

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

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.


Recursos

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


Requisitos


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 userToken no construtor de BrasilNFe.


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:

  1. Falha de comunicação (timeout, DNS, TLS): Erro ao efetuar requisição HTTPS com Brasil NFe: ...
  2. 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

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:


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

Desenvolvido por BRASIL NFE LTDA — CNPJ 39.658.743/0001-99.


All versions of brasilnfe-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
symfony/serializer-pack Version ^1.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package brasilnfe/brasilnfe-php-sdk contains the following files

Loading the files please wait ...