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

Configuração

Este documento irá mostrar como configurar com sucesso o Módulo Nota Fiscal para WHMCS via NFE.io. Ele irá guiar passo a passo por todo o processo de configuração.

Após a instalação e configuração inicial do addon como chave de acesso (API Key), é necessário realizar as configurações avançadas e rotinas de emissão das notas fiscais. Para isso acesse Addons -> NFE.io NFSe -> Configurações -> Configurações do Módulo.

Menu de configurações do módulo

A tela é dividida em dois blocos: Definições de Emissores e Configurações Globais.

Definições de Emissores​

É possível configurar diferentes empresas a serem utilizadas para emissão de notas fiscais pelo módulo, cada uma com suas definições.

Lista de emissores cadastrados

Para adicionar uma nova empresa, clique no botão Cadastrar Emissor e preencha os campos obrigatórios.

Modal de definições da empresa emissora

Os valores definidos aqui funcionam como padrão do emissor: são aplicados a todos os produtos/serviços que não possuírem uma definição mais específica. A ordem de precedência completa está descrita em Reforma Tributária.

Empresa​

Selecione a empresa que será configurada para emissão. Será exibida uma lista com todas as empresas cadastradas na sua conta NFE.io. É possível cadastrar mais de uma empresa para emissão de notas fiscais, cada uma com suas próprias definições.

Código de Serviço Principal​

Código de serviço municipal que será usado como padrão para geração das notas fiscais pelo WHMCS para este emissor. O código de serviço padrão será utilizado para todos os produtos/serviços que não possuírem um código de serviço personalizado definido.

Retenção de ISS​

Alíquota em porcentagem (%) padrão de retenção de ISS. Será aplicada a todos os produtos/serviços deste emissor, exceto onde houver uma alíquota específica por código de serviço.

Nomenclatura Brasileira de Serviços (NBS)​

Código NBS padrão utilizado na emissão das notas deste emissor. Campo da Reforma Tributária.

Indicador da Operação​

Código de natureza da operação (operationIndicator) padrão utilizado na emissão. Campo da Reforma Tributária.

Código de Classificação Tributária​

Código de Classificação Tributária para IBS/CBS (classCode) padrão utilizado na emissão. Campo da Reforma Tributária.

Alíquota de PIS (%)​

Alíquota de PIS padrão do emissor. Quando informada, o módulo calcula o valor de PIS da nota a partir do valor dos serviços e envia a alíquota e o valor no payload de emissão. Deixe em branco para não enviar o campo.

Alíquota de COFINS (%)​

Alíquota de COFINS padrão do emissor, com o mesmo comportamento descrito para o PIS.

Tipo de Tributação (ISSQN)​

Regime de tributação do ISSQN (taxationType) padrão do emissor, selecionado a partir da lista de valores aceitos pela API. Quando não informado, a API assume WithinCity (tributável no município).

Campos da Reforma Tributária

NBS, Indicador da Operação e Classificação Tributária são obrigatórios apenas para empresas nos regimes Lucro Real ou Lucro Presumido. Empresas em outros regimes podem preenchê-los, mas não são obrigadas.

PIS, COFINS e Tipo de Tributação são opcionais em qualquer regime. Preencha somente se precisar declarar esses tributos ou definir o regime de tributação do ISSQN. Deixados em branco, não são enviados na nota e a emissão funciona normalmente.

Consulte Reforma Tributária para as tabelas de referência de cada código.

Empresa Padrão​

Marque esta opção para definir a empresa como padrão. A empresa padrão será utilizada para emissão de notas fiscais quando houver mais de uma empresa configurada e o cliente não estiver associado a um emissor específico. Caso haja apenas uma empresa configurada, a mesma será utilizada como padrão.

Para associar clientes a emissores diferentes do padrão, veja Associar Emissor.

Configurações Globais​

As configurações globais são aplicadas a todas as empresas cadastradas no módulo. As opções disponíveis estão descritas a seguir.

Painel de Configurações Globais

Deduzir descontos da fatura na NF​

Deduz do valor da nota os itens de desconto da fatura, ou seja, os itens com valor negativo, como cupons promocionais. Se a fatura tiver itens de desconto para serviços diferentes, cada desconto é abatido da nota do grupo de código de serviço ao qual o item pertence.

Crédito aplicado à fatura não é desconto. Ele é forma de pagamento e não é deduzido da nota. Veja Mass Pay, Adicionar Fundos e crédito.

Opção habilitada por padrão.

Emitir NFE​

Configuração global que define quando as notas fiscais serão emitidas pelo WHMCS. As opções disponíveis são:

  1. Quando a fatura é gerada: a NFS-e será emitida assim que uma fatura for publicada, ou seja, esteja disponível para o cliente.
  2. Quando a fatura é paga: a NFS-e será emitida apenas quando a fatura registrar um pagamento. Esse pagamento poderá ser registrado por qualquer portal de pagamento dentro do fluxo transacional padrão do WHMCS ou manualmente ao adicionar um pagamento em uma fatura.
  3. Manualmente: nenhuma nota é emitida automaticamente. A emissão é feita pelo operador, a partir da fatura no admin ou da listagem de Notas Fiscais.

Agendar Emissão​

Número de dias após o pagamento da fatura em que as notas devem ser emitidas. Informe quantos dias após o registro do pagamento em uma fatura a NFS-e será emitida.

Atenção: preencher este campo desativa a configuração Emitir NFE.

Cancelar NFE ao Cancelar Fatura​

Marque esta opção para cancelar automaticamente uma nota quando a fatura associada é cancelada.

Inscrição Municipal​

Selecione o campo personalizado criado anteriormente que será responsável por registrar o número de inscrição municipal do cliente.

Campo Personalizado CPF​

Selecione o campo personalizado criado anteriormente que será responsável pelo CPF do cliente. Este campo poderá ser o mesmo para CPF e CNPJ.

Campo Personalizado CNPJ​

Selecione o campo personalizado criado anteriormente que será responsável pelo CNPJ do cliente. Selecione o mesmo campo personalizado do CPF caso seja um campo único para ambos os números de documento (CPF/CNPJ).

Descrição da NFSe​

Selecione a informação que será exibida no campo de descrição da nota fiscal.

  1. Número da fatura: exibe apenas o número da fatura vinculada a NFS-e.
  2. Nome dos serviços: exibe o nome de todos os serviços vinculados a fatura.
  3. Número da fatura + Nome dos Serviços: exibe o número da fatura em uma linha e o nome de todos os serviços vinculados a fatura em outra linha.

Inclui o link da fatura juntamente com a descrição da NFS-e na mensagem da nota.

Enviar e-mail​

Habilita a opção de envio da nota fiscal por e-mail ao cliente.

O e-mail será enviado para o endereço principal cadastrado no perfil do cliente e a mensagem será disparada pela plataforma da NFE.io.

Descrição Adicional​

Campo livre para informação adicional que será exibida no campo mensagem da nota fiscal.

Mass Pay, Adicionar Fundos e crédito​

A NFS-e documenta o serviço prestado. Por isso, a partir da versão 3.4.0, o módulo segue estas regras em todas as formas de emissão (automática, agendada, manual e reemissão):

  • Mass Pay (pagamento em massa): a fatura de pagamento em massa não gera nota. Cada fatura quitada por ela gera a própria nota, com os próprios itens.
  • Adicionar Fundos: a fatura de adição de crédito não gera nota, porque é um adiantamento. A nota sai quando o crédito paga uma fatura de serviço.
  • Fatura paga com crédito: a nota sai com o valor cheio dos itens da fatura. O crédito é forma de pagamento e não é abatido, mesmo com a opção Deduzir descontos da fatura na NF ativa.
  • Juros por atraso: os itens de juros e multa (LateFee) continuam fora da nota.

Na emissão manual ou na reemissão de uma fatura sem item elegível, o módulo mostra o aviso "Fatura #número sem item elegível para NFS-e" e não cria nota.

Atualização a partir da versão 3.3 ou anterior

Até a versão 3.3, o módulo emitia nota também para as faturas de Adicionar Fundos e de Mass Pay. Antes de atualizar:

  • WHMCS 8 ou anterior: o saldo de crédito comprado antes da atualização já teve nota na adição de fundos. Quando esse crédito pagar uma fatura de serviço, sai outra nota. Confira os saldos de crédito dos clientes e avalie com o seu contador as notas geradas sobre crédito antigo.
  • WHMCS 8 ou anterior: faturas pagas só com crédito passam a gerar nota. Antes elas ficavam sem nota.
  • WHMCS 9: o módulo já emitia nota na adição de fundos e de novo no uso do crédito. A atualização corrige esse comportamento a partir dela.
Limitação conhecida no WHMCS 9

No WHMCS 9, cancelar um item de uma fatura já publicada gera uma nota de crédito, e o item continua na fatura. O módulo ainda não lê essas notas de crédito, então a NFS-e sai com o valor do item cancelado. Confira o valor da nota das faturas com item cancelado. Esse caso será tratado numa versão futura.

Emissão Personalizada por cliente​

É possível definir uma opção de emissão personalizada por cliente, esta opção de emissão sobrescreve a configuração global de emissão configurada.

Para inserir uma opção personalizada de emissão, acesse o perfil do cliente desejado e localize o campo Emitir nota fiscal quando e selecione uma das opções de emissão da lista, como exemplificado na imagem a seguir.

Campo de emissão personalizada no perfil do cliente

Para inserir um link da nota fiscal do PDF e XML, edite o arquivo viewinvoice.tpl da pasta do template do WHMCS, utilize o exemplo abaixo:

{include file="../../modules/addons/NFEioServiceInvoices/lib/templates/clientarea/viewinvoice.tpl"}

Recomendamos a inserção da tabela logo acima da linha:

<p class="text-center d-print-none"><a href="clientarea.php?action=invoices">{lang key='invoicesbacktoclientarea'}</a></p>

Exemplo de exibição do download da NF na visualização da fatura pelo cliente.

Download da nota fiscal na fatura vista pelo cliente

Próximos passos​

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.