Biblioteca PHP NFE.io

Esta é a documentação para a biblioteca PHP da NFE.io, que permite a emissão de Nota Fiscal de Serviço (NFS-e) de forma simples e rápida.

Onde acessar a documentação da API?

Nessa sessão falamos sobre nossa biblioteca PHP, com todos os passos necessários para instalar e utilizar nossa API.

Acesse a nossa documentação para mais detalhes e referências.

Como realizar a instalação do pacote?

Você pode instalar via Composer, executando o comando a seguir:

composer require nfe/nfe

Para usar a biblioteca, use o Composer autoload:

require_once('vendor/autoload.php');

Observação: A versão do PHP deverá ser 5.4 ou superior.

Dependencias

Esta biblioteca requer as seguintes extensões para funcionamento correto:

-curl

-json

Se você usa o Composer, essas dependencias são gerenciadas automaticamente. Caso tenha feito a instalação manual, você precisa ter certeza que estas extensões estão instaladas e disponíveis.

Se você não quiser utilizar o Composer, você pode fazer o download de uma das últimas versões, utilizando o endereço https://github.com/nfe/client-php/releases

Exemplos de uso

Depois de baixar o pacote, inclua a biblioteca em seu arquivo PHP, utilizando o código abaixo:

require_once("caminho-para/client-php/lib/init.php");

Observação: Caso você utilizar mais de um arquivo .php para fazer a integração, o código acima deverá ser replicado nos outros arquivos.

Como emitir uma Nota Fiscal de Serviço?

Abaixo, temos um código-exemplo para realizar uma Emissão de Nota Fiscal de Serviço:

require_once("caminho-para/client-php/lib/init.php");

NFe_io::setApiKey('c73d49f9649046eeba36dcf69f6334fd'); // Ache sua chave API no painel (https://app.nfe.io/account/apikeys)

$invoiceCreated = NFe_ServiceInvoice::create(
  // ID da empresa, você deve copiar exatamente como está no painel
  '64555e0ee340420fdc94ad09',
  // Dados da nota fiscal de serviço
  array(
    // Código do serviço de acordo com o a cidade
    'cityServiceCode' => '2690',
    // Descrição dos serviços prestados
    'description'     => 'TESTE EMISSAO',
    // Valor total do serviços
    'servicesAmount'  => 0.01,
    // Dados do Tomador dos Serviços
    'borrower' => array(
      // CNPJ ou CPF (opcional para tomadores no exterior)
      'federalTaxNumber' => 191,
      // Nome da pessoa física ou Razão Social da Empresa
      'name'             => 'BANCO DO BRASIL SA',
      // Email para onde deverá ser enviado a nota fiscal
      'email'            => '[email protected]', // Para visualizar os e-mails https://www.mailinator.com/
      // Endereço do tomador
      'address'          => array(
        // Código do pais com três letras
        'country'               => 'BRA',
        // CEP do endereço (opcional para tomadores no exterior)
        'postalCode'            => '70073901',
        // Logradouro
        'street'                => 'Outros Quadra 1 Bloco G Lote 32',
        // Número (opcional)
        'number'                => 'S/N',
        // Complemento (opcional)
        'additionalInformation' => 'QUADRA 01 BLOCO G',
        // Bairro
        'district'              => 'Asa Sul',
        // Cidade é opcional para tomadores no exterior
        'city' => array(
            // Código do IBGE para a Cidade
            'code' => '5300108',
            // Nome da Cidade
            'name' => 'Brasilia'
        ),
        // Sigla do estado (opcional para tomadores no exterior)
        'state' => 'DF'
      )
    )
  )
);

echo($invoiceCreated->id);

Como cancelar uma nota?

Abaixo, temos um código-exemplo para efetuar o cancelamento de uma nota:

require_once("caminho-para/client-php/lib/init.php");

NFe_io::setApiKey("c73d49f9649046eeba36dcf69f6334fd"); // Ache sua chave API no painel (https://app.nfe.io/account/apikeys)

$invoice = NFe_ServiceInvoice::fetch(
  '64555e0ee340420fdc94ad09', // ID da empresa, você deve copiar exatamente como está no painel
  'wPi7i954QAcr6kmy17BtEKtN'  // ID da nota fiscal
);

if ( $invoice->status == 'Issued' ) {
  $invoice->cancel();
}

Como criar uma empresa para realizar a emissão de notas fiscais?

Abaixo, temos um código-exemplo de criação de uma empresa, para realizar a emissão de nota fiscal:

require_once("caminho-para/client-php/lib/init.php");

NFe_io::setApiKey("c73d49f9649046eeba36dcf69f6334fd"); // Ache sua chave API no painel (https://app.nfe.io/account/apikeys)

$companyCreated = NFe_Company::create(
  array(
    'federalTaxNumber' => 87502637000164, // Use esse gerador para testar: http://www.geradordecnpj.org/
    'name'             => 'BANCO DO BRASIL SA',
    'tradeName'        => 'BANCO DO BRASIL',
    'email'            => '[email protected]', // Para visualizar os e-mails https://www.mailinator.com/inbox2.jsp?public_to=nfe
     // Endereço da empresa
    'address'          => array(
      // Código do pais com três letras
      'country'               => 'BRA',
      // CEP do endereço (opcional para tomadores no exterior)
      'postalCode'            => '70073901',
      // Logradouro
      'street'                => 'Outros Quadra 1 Bloco G Lote 32',
      // Número (opcional)
      'number'                => 'S/N',
      // Complemento (opcional)
      'additionalInformation' => 'QUADRA 01 BLOCO G',
      // Bairro
      'district'              => 'Asa Sul',
      // Cidade é opcional para tomadores no exterior
      'city' => array(
          // Código do IBGE para a Cidade
          'code' => '5300108',
          // Nome da Cidade
          'name' => 'Brasilia'
      ),
      // Sigla do estado (opcional para tomadores no exterior)
      'state' => 'DF'
    )
  )
);

echo($companyCreated->id);

Como efetuar o download de uma nota em PDF?

Abaixo, temos um código exemplo para baixar uma nota em PDF:

require_once("caminho-para/client-php/lib/init.php");

NFe_io::setApiKey('c73d49f9649046eeba36dcf69f6334fd'); // Ache sua chave API no painel (https://app.nfe.io/account/apikeys)

$url = NFe_ServiceInvoice::pdf(
  '64555e0ee340420fdc94ad09', // ID da empresa, você deve copiar exatamente como está no painel
  'wPi7i954QAcr6kmy17BtEKtN'  // ID da nota fiscal
);

file_put_contents( './invoice_file.pdf', file_get_contents($url) );

Como validar o Webhook?

Ainda estamos aprimorando esse tópico, mas você pode consultar mais aqui nesse link

Testes

Instale as dependências necessárias para executar os testes. O client-php do NFe utiliza SimpleTest.

composer update --dev

Execute a comitiva de testes:

php ./test/NFe.php

Como acessar o código-fonte?

O código-fonte do nosso cliente está disponível em nosso Github.

Como eu posso contribuir com o projeto?

Para contribuir com nosso projeto, você pode acessar nossa documentação para desenvolvedores

Mande sua sugestão para [email protected], ficaremos em receber sua sugestão!