Skip to content

Latest commit

 

History

75 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

WHMCS · NFe.io

Módulo addon para WHMCS que integra com a NFe.io e emite NFS-e (nota fiscal de serviço) automaticamente a partir das faturas — na geração ou após o pagamento, conforme você escolher por cliente. As notas ficam disponíveis no admin e na área do cliente (PDF e XML), com atualização de status via webhook.

Recursos

  • Emissão automática de NFS-e ao gerar a fatura ou ao compensar o pagamento
  • Escolha por cliente (não emitir / emitir no boleto gerado / emitir no boleto pago)
  • Cancelamento de nota pelo painel
  • Atualização de status em tempo real por webhook da NFe.io
  • Download de PDF/XML individual e em lote (zip)
  • Envio de e-mail ao cliente com os links da nota
  • Área do cliente listando as notas emitidas

Requisitos

  • WHMCS (versão atual)
  • PHP 8.0+
  • Extensões curl e zip
  • allow_url_fopen = On no php.ini
  • Conta na NFe.io com API key e empresa cadastrada

Instalação

  1. Copie a pasta modules/addons/nfeio para a raiz da sua instalação WHMCS.
  2. No admin, vá em Configurações → Addon Modules (Opções → Módulos Addon).
  3. Localize NFe.io e clique em Ativar.
  4. Em Configure, no controle de acesso, marque o grupo de administradores que poderá gerenciar o módulo (ex.: Full Administrator).

⚠️ Não desative o módulo em Addon Modules: a desativação remove as tabelas do módulo e o histórico de notas salvas no WHMCS.

Configuração

Acesse Addons → NFe.io → aba Configurações e preencha:

Campo O que é
Chave da API (chave_api) API key da sua conta NFe.io
ID da empresa (empresa_id) ID da empresa emissora na NFe.io
Código do serviço (cityServiceCode) Código de serviço municipal usado na NFS-e
Campo CPF/CNPJ (input_doc) Custom field do cliente com o documento
Campo Número (input_num) Custom field com o número do endereço
Campo Complemento (input_complemento) Custom field com o complemento (opcional)
Campo Emitir NF (input_emitir) Custom field (select) que decide se/quando emitir
Descrição (descricao) Texto da nota; aceita {fatura_id} e {fatura_itens}
Template de e-mail (email_template) Template do WHMCS enviado ao cliente após a emissão

Os campos personalizados que ainda não existirem podem ser criados direto pela tela de configuração (link "clique aqui para criar" na descrição de cada item).

Depois, preencha os custom fields no cadastro de cada cliente. O campo Emitir NF vem como "Nenhum" por padrão (não emite); escolha Boleto Gerado ou Boleto Pago para que a nota seja emitida no momento correspondente.

Webhook

Para o status da nota atualizar sozinho:

  1. No painel da NFe.io, vá em Conta → Webhooks (https://app.nfe.io/account/webhooks).
  2. Crie um webhook apontando para: https://SEU_WHMCS/modules/addons/nfeio/webhook.php
  3. Salve. O módulo revalida cada evento consultando a API antes de gravar o status.

Como funciona

A emissão é disparada pelos hooks de fatura do WHMCS (hooks.php) conforme a opção escolhida no cliente. O cron.php reprocessa notas pendentes e sincroniza status. As notas ficam em Addons → NFe.io, e o cliente vê as dele na área do cliente.

Licença

MIT.

About

Módulo Emissão de Notas Fiscais para WHMCS - NFE.io

Topics

Resources

Stars

8 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages