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.
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.
Para adicionar uma nova empresa, clique no botão Cadastrar Emissor e preencha os campos obrigatórios.
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).
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.
Deduzir descontos da fatura na NF
Deduzir descontos/abatimentos existentes na fatura do valor total da nota a ser emitida. Quando uma fatura possuir um item de desconto ou item com valor negativo, o mesmo será deduzido do valor total da nota a ser emitida. Se uma fatura possuir vários itens de desconto para diferentes serviços, os descontos serão somados e descontados com base no grupo de código de serviço.
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:
- Quando a fatura é gerada: a NFS-e será emitida assim que uma fatura for publicada, ou seja, esteja disponível para o cliente.
- 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.
- 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.
- Número da fatura: exibe apenas o número da fatura vinculada a NFS-e.
- Nome dos serviços: exibe o nome de todos os serviços vinculados a fatura.
- 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.
Link da Fatura na NFSe
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.
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.
Link da nota na fatura
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.
Próximos passos
- Defina códigos de serviço personalizados por produto
- Configure alíquotas e retenções por código de serviço
- Confira o webhook de callbacks para que os status das notas sejam atualizados automaticamente