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:

• Fluxo Geral para a emissão de uma nota fiscal

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:

• API Key
• Id da Empresa

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":

• Clique aqui para ir para a pasta de exemplos

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

  • Emitindo uma nota fiscal

• Documentação

  • Saiba mais sobre os campos da emissão de uma nota fiscal - Documentação

Cancelamento de uma nota fiscal emitida

• Arquivo de Exemplo

  • Cancelando uma nota fiscal emitida

• Documentação

  • Saiba mais sobre os campos de cancelamento de uma nota fiscal utilizando o Id Interno
  • Saiba mais sobre os campos de cancelamento de uma nota fiscal utilizando o Id Externo

Consultar uma nota fiscal

• Arquivo de Exemplo

  • Consultando uma nota fiscal - Arquivo de exemplo

• Documentação

  • Saiba mais sobre os campos de consultar uma nota fiscal utilizando o Id Interno
  • Saiba mais sobre os campos de consultar uma nota fiscal utilizando o Id Externo

Fazer o download de uma nota fiscal emitida

• Arquivo de Exemplo

  • Baixando o PDF de uma nota fiscal emitida - Arquivo de exemplo

• Documentação

  • Saiba mais sobre os campos para baixar o PDF de uma nota fiscal utilizando o Id Interno
  • Saiba mais sobre os campos para baixar o PDF de uma nota fiscal utilizando o Id Externo

Fazer o download do XML de uma nota fiscal emitida

• Arquivo de Exemplo

  • Baixando o XML uma nota fiscal emitida

• Documentação

  • Saiba mais sobre os campos para baixar o XML de uma nota fiscal utilizando o Id Interno
  • Saiba mais sobre os campos para baixar o XML de uma nota fiscal utilizando o Id Externo

Inserir ou atualizar uma empresa

• Inserir ou Atualizar uma empresa
  • Saiba mais sobre os campos para Inserir/Atualizar uma empresa

Upload do certificado de uma empresa

• Arquivo de Exemplo

  • Enviar o certificado de uma empresa

• Documentação

  • Saiba mais sobre os campos para vincular o certificado de uma empresa

Upload do logo de uma empresa

• Arquivo de Exemplo

  • Enviar o logo de uma empresa

• Documentação

  • Saiba mais sobre os campos para vincular o logo de uma empresa