simplesvet / enotas-nfse
EnotasGw API NFS-e
Requires
- php: >=5.3.0
This package is auto-updated.
Last update: 2025-03-23 16:07:00 UTC
README
Client escrito na linguagem PHP da API do eNotas Gateway, plataforma de emissão automática de nota fiscal eletrônica de serviço (NFS-e), Produto (NF-e) e Consumidor (NFC-e).
Atenção: Esta biblioteca deve ser utilizada para a emissão de NFS-e (Nota fiscal de Serviço), caso você deseje emitir NF-e (Nota Fiscal de Produto) ou NFC-e (Nota Fiscal ao Consumidor) utilize a bilioteca php-client-v2
Documentação
Abaixo disponibilizamos as documentações oficiais do eNotas Gateway para consulta:
- Documentação de conceitos para utilização da API do eNotas GW
- Documentação referencial dos endpoints da API do eNotas GW
- Swagger dos endpoints da API V1 do eNotas GW
Além disso também consideramos que seja muito importante que você entenda como é o fluxo geral para a emissão de uma nota fiscal, para isso leia a documentação a seguir:
Instalação eNotas GW PHP client
Para instalar manualmente esta biblioteca, basta clonar o repositório GIT para a sua máquina, conforme imagem abaixo:
Ou através do comando:
$ git clone https://github.com/eNotasGW/php-client
Para instalar através do composer, basta utilizar o comando:
composer require enotas/php-client
Para utilizar o nosso cliente é fácil, veja:
Após baixar os arquivos disponibilizados aqui, basta que você copie estes arquivos para a pasta da sua aplicação e faça referência à classe eNotasGW.php e, além disso você também precisará de duas informações:
Abaixo um exemplo simples para a emissão de nota fiscal:
<?php header('Content-Type: text/html; charset=utf-8'); require('../src/eNotasGW.php'); eNotasGW::configure(array( 'apiKey' => '<sua api key>' )); $idEmpresa = '484FB0C5-969E-46AD-A047-8A0DB54667B4'; eNotasGW::$NFeApi->emitir($idEmpresa, array( 'tipo' => 'NFS-e', 'idExterno' => '5', //id para mapeamento com sistema de origem (opcional) 'ambienteEmissao' => 'Homologacao', //'Homologacao' ou 'Producao' 'cliente' => array( 'nome' => 'Nome Cliente', 'email' => 'cliente@mail.com', 'cpfCnpj' => '23857396237', 'tipoPessoa' => 'F', 'endereco' => array( 'uf' => 'MG', 'cidade' => 'Belo Horizonte', 'logradouro' => 'Rua 01', 'numero' => '112', 'bairro' => 'Savassi', 'cep' => '32323111' ) ), 'servico' => array( 'descricao' => 'Discriminação do serviço prestado' ), 'valorTotal' => 10.05 )); ?>
Precisa de mais exemplos? Sem problemas! ;)
Todos os nossos exemplos podem ser encontrados na pasta "samples":
Ou se preferir, você pode ir diretamente para o arquivo que desejar, também fornecemos a documentação oficial para cada um dos itens:
Emissão de nota fiscal
-
Arquivo de Exemplo
-
Documentação
Cancelamento de uma nota fiscal emitida
-
Arquivo de Exemplo
-
Documentação
Consultar uma nota fiscal
-
Arquivo de Exemplo
-
Documentação
Fazer o download de uma nota fiscal emitida
-
Arquivo de Exemplo
-
Documentação
Fazer o download do XML de uma nota fiscal emitida
-
Arquivo de Exemplo
-
Documentação
Inserir ou atualizar uma empresa
Upload do certificado de uma empresa
-
Arquivo de Exemplo
-
Documentação
Upload do logo de uma empresa
-
Arquivo de Exemplo
-
Documentação