Pular para o conteúdo principal
Ver como MarkdownDocs para agentes

Atualização

Esta página cobre dois cenários distintos:

Faça backup antes

Sempre realize um backup do seu WHMCS e do banco de dados antes de qualquer atualização. As atualizações alteram o schema das tabelas do módulo.

Atualização entre versões​

1. Baixe a versão mais recente​

Obtenha o pacote em releases/latest. O CHANGELOG descreve o que mudou em cada versão.

2. Substitua os arquivos​

Remova o diretório modules/addons/NFEioServiceInvoices existente antes de enviar os novos arquivos.

Reestruturações entre versões removeram arquivos que, se mantidos, entram em conflito com o código novo. Sobrescrever o diretório sem removê-lo primeiro deixa arquivos órfãos.

Não é necessário desativar o módulo para atualizar. As configurações, notas fiscais, códigos de serviço e alíquotas ficam no banco de dados e não são afetados pela troca dos arquivos.

3. Acione as migrações​

Acesse Opções -> Módulos Addon, localize NFE.io NFSe e clique em Salvar Alterações.

Este passo é obrigatório: é ele que dispara as rotinas de atualização do módulo, que criam colunas e tabelas novas conforme a versão de origem e destino.

4. Verifique​

  • Confirme a versão instalada no menu Addons -> NFE.io NFSe -> Sobre.
  • Revise as Configurações do Módulo — versões novas podem introduzir campos que começam vazios.
  • Emita uma nota de teste e confira o status.

Migrações executadas por versão​

O módulo detecta a versão anteriormente instalada e executa apenas as migrações necessárias.

A partir de versões anteriores aAlterações aplicadas
2.1.0Criação da tabela de alíquotas e novas colunas na tabela de notas fiscais
2.1.4Ampliação do limite do campo de código de serviço nas tabelas do módulo
2.1.9Padronização das colunas de data/hora nas tabelas do módulo
3.0.0Criação das tabelas de emissores e de associação cliente/emissor; adição da coluna de emissor nas tabelas existentes e preenchimento com a empresa já configurada
3.1.0Adição dos campos da Reforma Tributária (NBS, indicador da operação, classificação tributária) nas tabelas de notas, códigos de serviço e emissores
3.3.0Adição dos campos de PIS, COFINS e tipo de tributação nas tabelas de emissores, alíquotas e notas fiscais

Após atualizar para a 3.x​

  • Vindo de uma versão anterior à 3.0: a empresa emissora já configurada é cadastrada automaticamente como emissor padrão, com os dados buscados na API da NFE.io. Confira o cadastro em Definições de Emissores e cadastre os demais emissores, se houver.
  • Vindo de uma versão anterior à 3.1: os campos da Reforma Tributária começam vazios. Preencha-os no emissor e nos códigos de serviço conforme Reforma Tributária.
  • Vindo de uma versão anterior à 3.3: os campos de PIS, COFINS e tipo de tributação começam vazios e, enquanto não forem preenchidos, não são enviados nas notas.
  • Vindo de uma versão anterior à 3.2: o registro de webhook antigo é detectado como inválido e substituído automaticamente na próxima emissão de nota. Nenhuma ação manual é necessária — confira o resultado em Webhook e Callbacks.

Migração da versão legada v1.4 para a v2.x​

Aplicável apenas a instalações legadas

As seções a seguir descrevem a migração do módulo legado gofasnfeio (v1.4.x) para a estrutura atual NFEioServiceInvoices (v2.x em diante). Se a sua instalação já usa NFEioServiceInvoices, siga apenas a Atualização entre versões.

Ativando as versões em paralelo​

A versão 2.x do módulo possui uma nova estrutura de diretórios, o que possibilita uma ativação em paralelo a versão anterior permitindo assim uma migração rápida e transparente. Ao ativar a nova versão em paralelo, o módulo irá buscar todas as informações da versão anterior e irá importa-las automaticamente.

Então é crucial para que o processo de atualização e migração ocorra adequadamente a ativação em paralelo das duas versões do módulo.

Não desative o módulo antigo antes de concluir a migração/atualização.

Configuração​

Ao ativar a nova versão, todas as configurações globais do módulo serão automaticamente migradas. Configurações como API Key e ID da empresa já poderão ser visíveis como exemplificado na imagem a seguir.

As configurações migradas automaticamente da versão anterior serão:

  • API Key
  • ID da Empresa
  • Código de Serviço Principal
  • Informações de depuragem (debug)
  • RPS (legado)
  • Disparar e-mail com a nota
  • Quando emitir NFE
  • Cancelar NFE Quando Cancelar Fatura
  • Informações do campo personalizado para Campo Inscrição Municipal
  • Informações do campo personalizado para Campo Personalizado CPF
  • Informações do campo personalizado para Campo Personalizado CNPJ
  • Aplicar Impostos em todos os produtos
  • Descrição da NFSe
  • Exibir Link da Fatura na NFSe
  • Descrição Adicional

As demais configurações migradas poderão ser verificadas acessando o módulo em Addons -> NFE.io NFSe -> Configurações.

Migrando as notas fiscais​

Ao ativar o novo módulo, as informações das notas fiscais emitidas a partir da versão anterior serão migradas automaticamente.

Todas as notas existentes estarão visíveis ao acessar o módulo em Addons -> NFE.io NFSe.

Migrando os códigos de serviços​

Os códigos de serviços personalizados serão migrados automaticamente e poderão ser verificados acessando o módulo em Addons -> NFE.io NFSe -> Códigos de Serviços.

Migrando as definições dos usuários​

As configurações personalizadas de emissão de notas para os clientes também será migrada e todas as rotinas existentes de emissão para seus clientes serão mantidas.

Verificando tudo​

Por precaução, antes de desativar a versão antiga do módulo, faça uma verificação completa. Verifique se as configurações migradas estão corretas, verifique se as notas fiscais estão sendo listadas adequadamente e se os códigos dos serviços configurados condizem com os existentes na configuração do módulo antigo.

Fazendo esta verificação antes de seguir com a desativação e exclusão do módulo antigo ajudará a evitar problemas que não poderão ser revertidos após as próximas etapas.

Desativando a versão anterior (1.4)​

Após conferir a configurações do módulo e as notas ficais, tudo parecendo certo, você poderá desativar o módulo.

Para desativar o módulo NFE.io v1.4.x vá para Configurações -> Módulos Addons no WHMCS v7.x ou Opções -> Módulos Addons no WHMCS v8.x.

Localize o módulo antigo, verifique a versão que deve ser desativada, você deverá desativar a versão v1.4.x (sendo x qualquer versão menor como 1.4.1, 1.4.4 etc). Veja a imagem a seguir.

Excluindo o módulo anterior (v1.4)​

Após desativar o módulo NFE.io v1.4.x, será necessário remover o diretório gofasnfeio existente dentro de modules/addons como última etapa da atualização para a versão 2.x.

Para isso, utilize seu cliente FTP preferido para acessar o WHMCS, navegue até o diretório seu_whmcs/modules/addons para visualizar os módulos adicionais existentes em seu WHMCS e localize o diretório nomeado gofasnfeio como demonstrado na imagem a seguir.

Após localizar o diretório, exclua-o.

Pronto! Seu módulo de emissão de notas fiscais no WHMCS via NFE.io está atualizado para a versão 2.x!

Tabelas do Banco de Dados​

Este processo de atualização, por segurança, não exclui ou manipula as tabelas no banco de dados utilizado pela versão anterior. A versão 2.x copia todas as informações para novas tabelas e mantém as originais intactas, e a desativação do módulo não aciona nenhuma ação de exclusão. Então caso você tenha tido algum problema e precise voltar o módulo para uma versão anterior a atualização, basta desativar a versão 2.x e reenviar os arquivos da versão originalmente em uso.

Veja a lista a seguir das tabelas do banco de dados usadas pela versão anterior, caso você desejar fazer um backup manual ou exclui-las no futuro.

  • gofasnfeio: todos os registros de notas fiscais já emitidas pelo módulo.
  • mod_nfeio_custom_configs: contém todos os registros das configurações personalizadas de emissão de notas para os clientes.
  • tblproductcode: possui todos os registros de códigos de serviços personalizados associados aos produtos/serviços.
atenção

tblproductcode possui um nome muito similar as tabelas padrões do WHMCS, mas ela é uma tabela personalizada e nenhum componente ou função nativas do WHMCS dependem dela.

NFE.io

A NFE.io é uma empresa de tecnologia que fornece soluções para automatizar e simplificar a emissão e gestão de notas fiscais eletrônicas. Com suas ferramentas, as empresas podem economizar tempo e reduzir erros, aumentando a eficiência e precisão do processo de emissão de notas fiscais.

Um dos principais cases de sucesso da NFE.io é a implementação da solução na empresa de transporte Rodonaves. Com a automatização da emissão e gestão de notas fiscais eletrônicas, a Rodonaves conseguiu reduzir em até 80% o tempo gasto nesse processo, o que se traduziu em uma significativa melhoria na eficiência operacional. Além disso, a empresa também conseguiu eliminar erros e atrasos na emissão de notas fiscais, o que melhorou a relação com seus clientes e aumentou a confiança dos órgãos fiscais.

Outro exemplo é a implementação da NFE.io na empresa de comércio eletrônico, a Loja Integrada. Com a automatização da emissão de notas fiscais, a Loja Integrada conseguiu aumentar a velocidade de emissão de notas em até 10 vezes, o que permitiu que a empresa atendesse a uma maior quantidade de clientes e, consequentemente, aumentar as suas vendas.

Além desses exemplos, a NFE.io também tem outros cases de sucesso com empresas de setores como indústria, construção, varejo e serviços, mostrando a versatilidade e eficácia da sua solução.

Em resumo, a NFE.io é uma empresa de tecnologia que oferece soluções para automatizar e simplificar a emissão e gestão de notas fiscais eletrônicas, ajudando as empresas a economizar tempo e reduzir erros, melhorando a eficiência e precisão do processo. Com cases de sucesso em diferentes setores, a NFE.io tem se destacado como uma empresa líder em automação fiscal.