Usando o Nota Fiscal Asaas no dia a dia
Como emitir, acompanhar e cancelar notas fiscais depois que o módulo já está instalado e configurado. Este guia não repete a configuração — só o que muda no uso diário.
Este guia assume que a licença, a API Key, o webhook e os campos personalizados já estão configurados. Se ainda não estão, veja primeiro o Guia de Instalação e Configuração — itens como "Formas de Pagamentos" e "Emitir Nota Fiscal", citados abaixo, são definidos por lá.
Onde tudo acontece
Todo o uso diário fica em Complementos › Nota Fiscal Asaas MP.
Emitir NF
Lista faturas elegíveis, com filtros, seleção múltipla e ações de emissão manual ou em lote.
Gerenciar Clientes
Ajusta a preferência de emissão de vários clientes de uma vez.
Serviço Municipal
Cadastro de serviços e associação a produtos do WHMCS.
Notas emitidas
Consulta com filtros, visualização de PDF/XML e cancelamento.
Logs do Sistema
Histórico de webhook, cron, emissão e ações administrativas.
Paginação
Todas as listas têm seletor de linhas por página e indicador de página atual.
Emitir uma nota manualmente
ManualPela listagem "Emitir NF".
Abra Complementos › Nota Fiscal Asaas MP › Emitir NF para ver as faturas elegíveis para emissão. A tabela traz Nº da invoice, vencimento, data de pagamento v7.2 (em branco enquanto a fatura não é paga), cliente, valor, status, condição de emissão, gateway e ações. Use os filtros para encontrar o que precisa:
- Nº Invoice
- Busca pelo número da fatura.
- Cliente
- Busca por nome, sobrenome ou razão social.
- Status Invoice
- Situação da fatura no WHMCS: não paga, paga, cancelada, faturada ou em cobrança.
- Status Gateway v7.2
- Compara a forma de pagamento da fatura com as formas cadastradas em "Formas de Pagamentos":
EmiteouNão Emite. Antes chamado apenas de "Gateway". - Gateway v7.2
- Lista os nomes reais das formas de pagamento usadas nas faturas (ex.: Cartão de Crédito, Pix, Boleto), sem repetir nomes — filtra pela forma escolhida.
- Vencimento (de/até) v7.2
- Filtra as faturas cujo vencimento cai dentro do período informado.
- Pagamento (de/até) v7.2
- Filtra pela data em que a fatura foi paga; faturas ainda não pagas não aparecem nesse filtro.
Cada linha tem as ações disponíveis para aquela fatura — emitir, agendar ou aguardar processamento, conforme o status atual da nota.
Agendar emissão para várias faturas de uma vez
Novidade v7.2Cada linha da listagem tem um checkbox à esquerda do Nº da invoice, e o cabeçalho da tabela tem um checkbox para marcar todas as faturas visíveis na página de uma vez. Marque as faturas desejadas, escolha a ação em "Com os selecionados" e clique em Agendar Agora.
O módulo processa uma fatura por vez, mostra o progresso e, ao final, resume quantas foram agendadas com sucesso e quais falharam — e por quê — antes de recarregar a página com os mesmos filtros aplicados.
Ao agendar uma NF, seja individualmente ou em lote, o módulo verifica se o cliente já existe no Asaas pelo CPF/CNPJ; se não existir, ele é cadastrado automaticamente com os dados do WHMCS antes de agendar a nota — sem nenhuma ação manual extra.
Emitir direto pela fatura
Novidade v7.2Sem sair da tela da fatura, em Faturas › Ver Fatura.
Toda fatura paga ou em aberto passa a exibir um bloco Asaas - Modules Pay com o resumo da situação de emissão:
Os três rótulos acima combinam a preferência do cliente, a forma de pagamento usada na fatura e o status atual dela — exatamente o que decide se a nota pode sair.
Quando a combinação permite emissão, um botão Agendar Emissão aparece na própria tela: confirma o agendamento e dispara a NFS-e sem precisar abrir a listagem "Emitir NF".
Quando a fatura já tem uma NF emitida, agendada ou em processo de cancelamento, o bloco troca automaticamente o botão pelo número da nota, o status e a data de emissão.
Como funciona a emissão automática
AutomáticoRodando pelos hooks de cron do WHMCS, nesta ordem.
Preferência do cliente
Definida no campo "Emitir Nota Fiscal": não emitir, antes ou depois do pagamento.
Cron executa
O WHMCS dispara as rotinas do módulo no horário programado.
Módulo verifica a fatura
Confere forma de pagamento permitida e status (paga/não paga) contra a regra do cliente.
Agenda e envia
Respeita os dias configurados e envia a NFS-e para a prefeitura pelo Asaas.
Sincroniza status
Atualiza periodicamente até a nota ficar autorizada, via cron e webhook.
Nota disponível
PDF e XML liberados; e-mail com o PDF enviado ao cliente, se essa opção estiver ativa.
Cancelar ou remover um registro
ManualCancelar NF
Disponível só quando o status da nota é AUTHORIZED. O botão fica na listagem de notas emitidas e envia o pedido de cancelamento ao Asaas.
Remover registro local
Aparece apenas para registros já CANCELED que nunca chegaram a gerar número de NF nem de RPS — útil para limpar tentativas que não avançaram, sem afetar nenhuma nota realmente emitida.
Correção em lote
Novidade v7.2Três ferramentas para corrigir contas afetadas por notas duplicadas ou presas — todas buscam os dados direto na Asaas, não só no registro local.
Notas Duplicadas por Cliente/Dia
v7.2Agrupa as notas ativas por cliente e data de emissão, destacando quem recebeu mais de uma nota no mesmo dia — o cenário típico de uma reemissão indevida. Cada grupo lista as notas com um checkbox; a mais antiga do grupo já vem desmarcada (presumível válida) e as demais marcadas. Revise, informe o motivo e cancele as selecionadas direto dali.
Cancelamento em Lote (por Nº)
v7.2Informe o número da NF inicial, o final e uma observação (motivo do cancelamento — obrigatório). O módulo busca na Asaas todas as notas autorizadas nessa faixa de número, mostra uma prévia com o valor total e, após confirmação, solicita o cancelamento de cada uma na Asaas e na prefeitura.
Cancelamento de nota autorizada não pode ser desfeito. Sempre confira a lista antes de confirmar.
Cancelar Notas sem Emissão na Prefeitura
v7.2Localiza, direto na Asaas, notas fiscais com erro de processamento/recusa da prefeitura (status ERROR) que nunca chegaram a ter número — nem no campo devolvido pela Asaas, nem no histórico local (verificação reforçada, já que a Asaas pode não devolver mais o número de uma nota que foi autorizada e depois entrou em erro). Notas agendadas ou já canceladas não entram na busca. A busca só roda depois que você clica em Filtrar (não carrega sozinha ao abrir a tela). Filtre por fatura, cliente ou período e confirme para cancelar na Asaas (a nota nunca chegou à prefeitura, então o cancelamento acontece só do lado da Asaas) e limpar o registro local.
A API da Asaas não remove/expurga o registro — só permite cancelar (mudar o status). Se o objetivo for limpar a listagem visual do painel da Asaas ou resolver um erro de integração específico causado por uma nota "fantasma", é preciso pedir ao suporte da Asaas para intervir manualmente na conta.
As três telas processam os registros um por vez, com barra de progresso — em contas com centenas ou milhares de notas, a busca e o processamento podem levar alguns segundos ou minutos. Não feche a aba enquanto a barra de progresso estiver em andamento.
Para reduzir o risco de bloqueio por excesso de requisições, o processamento em lote aguarda 10 segundos a cada 50 registros processados. Em lotes grandes, isso é esperado — acompanhe pela barra de progresso.
Quando a prefeitura recusa o cancelamento
v7.2Nem todo município do Brasil tem cancelamento automático de NFS-e integrado com a Asaas. Nesses casos, ao tentar cancelar, a nota volta com uma mensagem do tipo "[cidade] ainda não tem essa funcionalidade disponível" — não é uma falha do módulo, é uma limitação daquela prefeitura específica, e tentar de novo do mesmo jeito não resolve.
Quando isso acontece, ao final do processamento em lote o módulo pergunta se você quer cancelar somente na Asaas — só para as notas que caíram nessa situação. Esse modo desfaz o vínculo na Asaas (por exemplo, deixando de bloquear a emissão de uma nova nota para a mesma fatura) mas não notifica nem cancela o documento junto à prefeitura.
Cancelar "somente na Asaas" pode deixar o documento fiscal ainda válido perante o município. Use apenas quando souber que é seguro (ex.: nota duplicada por engano, nunca de fato prestada) e, se necessário, regularize manualmente com a prefeitura depois.
PDF, XML e reenvio por e-mail
ManualEm qualquer nota da listagem, use Visualizar para abrir os detalhes, com acesso ao XML, e o botão de Download para o PDF assim que ele estiver disponível.
Se Enviar PDF da NF por E-mail estiver ativo na configuração, o PDF é enviado automaticamente ao cliente usando o template Nota Fiscal Eletrônica de Serviço do WHMCS.
Na tela de SMTP, o botão Testar Configuração envia um e-mail de teste real para o endereço informado, usando os dados preenchidos no formulário — funciona mesmo antes de salvar. Use-o para validar host, porta, usuário e senha sem depender da próxima emissão automática.
Gerenciar clientes em massa
AdministrativoEm Gerenciar Clientes, ajuste a preferência de emissão (não emitir / emitir antes / emitir depois do pagamento) de vários clientes ao mesmo tempo, sem precisar abrir o perfil de cada um individualmente.
IBS/CBS e códigos fiscais
Novidade v7.2Em Complementos › Nota Fiscal Asaas MP › IBS/CBS.
Os 5 campos da Reforma Tributária (Código NBS, Código de Tributação Nacional, Código de Situação Tributária, Classificação Tributária e Código Indicador de Operação) são preenchidos nessa tela e enviados à Asaas dentro do bloco ibsCbs ao agendar cada NFS-e. Não são obrigatórios, mas se preencher um, os cinco precisam estar preenchidos.
Consultar os códigos válidos
v7.2Cada campo tem um botão Listar... que abre, em nova aba, a lista oficial de códigos consultada ao vivo na Asaas para aquele campo. A tela de listagem traz:
- Filtros
- Por código e/ou descrição (e também por situação tributária vinculada, na lista de Classificação Tributária) — os mesmos filtros aceitos pela API da Asaas, então a busca vale para a base inteira, não só para a página carregada.
- Itens por página
- 10, 25, 50 ou 100 por página.
- Paginação
- Primeira, anterior, próxima e última página, com indicador de página atual e total de resultados.
Use essas listas para conferir o código certo antes de preencher o campo correspondente — evita erro de digitação e código inválido na hora de emitir a NFS-e.
O que o cliente vê
ClienteCom Exibir Nota Fiscal para o Cliente habilitado, um menu Nota Fiscal aparece na área do cliente, listando as NFS-e emitidas com os links de PDF e XML de cada uma.
Consultar e limpar logs
AdministrativoEm Addons › Nota Fiscal Asaas MP › Logs do Sistema.
Use os logs para investigar qualquer emissão, cancelamento ou execução de cron. É possível:
- Filtrar por mensagem, nível, cliente, fatura, contexto e período.
- Abrir o registro para ver os dados adicionais gravados em JSON.
- Apagar logs antigos por período, para manter a tabela enxuta.
Todo evento de webhook, cron, emissão, cancelamento e ação administrativa passa por aqui — é o primeiro lugar a olhar quando uma nota não sai como esperado.