Pular para o conteúdo principal

Cobranças recorrentes

Ao final deste capítulo, você saberá configurar um modelo mensal que, em cada execução, envia uma NFS-e para a Fila, prepara o e-mail da nota e, quando habilitado, gera também o boleto. O modelo guarda os dados que serão repetidos; cada execução gera uma nota própria e fica registrada separadamente.

Tela de cobranças recorrentes

Crie uma cobrança recorrente​

  1. Abra Recorrentes e clique em Nova cobrança.

  2. Em Empresa emissora, escolha a Empresa que emitirá a nota.

  3. Em Tomador, selecione ou cadastre o cliente. Confira E-mail fiscal (consta na NFS-e), Telefone e endereço. O e-mail fiscal é enviado à prefeitura dentro da NFS-e; os destinatários dos arquivos são definidos mais adiante, em E-mail.

  4. Se houver intermediário na operação, marque Esta operação tem intermediário e preencha os dados exibidos.

  5. Selecione o Perfil tributário, quando aplicável. Os campos definidos pelo perfil ficam bloqueados para edição. Em Serviço, confira Serviço (atalho), Cód. tributação nacional (LC 116), Cód. serviço municipal, Local de prestação, Descrição do serviço e Observações.

  6. Em Valores, informe Valor do serviço (R$), Desconto (R$), Desconto condicionado (R$), Dedução da base do ISS (R$), Alíquota ISSQN (%) e ISS retido. Desconto condicionado e dedução têm finalidades fiscais diferentes; use os valores definidos pelo contador.

  7. Em Boleto, marque Gerar boleto junto com a NFS-e somente se a empresa já estiver configurada para essa integração. Informe Dias para vencimento, Multa (%) e Juros ao mês (%), quando necessários.

  8. Em Recorrência, preencha Nome da cobrança, mantenha o Status ativo e escolha o Tipo. Use Contínua para executar mensalmente até a desativação. Use Limitada e informe Quantidade de emissões para encerrar depois do total definido. Em Dia da emissão automática, escolha um dia de 1 a 28.

  9. Em E-mail, preencha Para (e-mails separados por vírgula), Cópia (opcional), Assunto e Corpo do e-mail. Se a empresa tiver um modelo, mantenha Usar o modelo padrão da empresa para aproveitar o assunto e o corpo configurados nela.

  10. Clique em Salvar cobrança.

Defina a periodicidade e a vigência​

A execução é mensal, no Dia da emissão automática. O tipo Contínua corresponde ao valor interno ILIMITADA e não tem quantidade final. O tipo Limitada corresponde a LIMITADA; a cada nota concluída, Emissões realizadas aumenta, e novas execuções deixam de ser criadas quando esse contador alcança Quantidade de emissões.

Não existe pausa com reativação. Na lista, uma cobrança ativa pode ser Desativar, mas a própria tela avisa que ela não pode ser reativada. Para interromper temporariamente uma programação e retomá-la depois, será necessário criar um novo modelo quando chegar a hora.

Use variáveis no assunto e no corpo do e-mail​

O assunto e o corpo aceitam somente estas variáveis reais:

  • {{nfNumero}}: número da NFS-e emitida;
  • {{mesPrestacao}}: mês da prestação;
  • {{anoPrestacao}}: ano da prestação;
  • {{nomeCobranca}}: nome da cobrança; na falta dele, o nome do serviço;
  • {{periodoDia}}: saudação adequada ao horário, como bom dia ou boa tarde.

As variáveis são substituídas em cada emissão. O assunto padrão do sistema é Cobrança - {{nomeCobranca}} - {{mesPrestacao}} de {{anoPrestacao}}. Se a empresa tiver Assunto padrão próprio, esse texto prevalece quando a recorrência usa o modelo da empresa. Se houver destinatário e nenhum assunto específico, o fluxo de emissão também procura o assunto padrão cadastrado na empresa.

Entenda o que acontece no dia programado​

O agendador externo consulta o sistema a cada minuto. A configuração padrão libera o processamento diário às 07:00 no horário de Brasília; configurações operacionais podem usar outros horários ou intervalos. Quando o processamento é liberado, o sistema verifica as recorrências ativas e recupera também competências mensais pendentes desde a criação ou a última alteração.

Cada execução elegível cria um job em Fila. Ali você acompanha a emissão até a conclusão ou a falha. Depois da autorização, a nota e seus eventos aparecem em Histórico; o e-mail é preparado e o boleto é gerado quando Gerar boleto junto com a NFS-e estiver marcado. O contador Emissões realizadas aumenta somente após a emissão concluída.

Na lista de Recorrentes, os indicadores Recorrente/mês, Modelos ativos, Emitidas e Próxima emissão resumem os modelos. Use Emitir todas de hoje para consultar uma prévia e enviar manualmente as recorrências elegíveis do dia para a fila. Cada card ativo também oferece Emitir, Editar e Desativar.

Edite ou encerre o modelo​

  • Use Editar para alterar o modelo. A nova configuração vale para execuções futuras e não modifica notas já emitidas. A data da alteração passa a ser o início para o cálculo de competências futuras.

  • Use Desativar e confirme em Desativar cobrança para impedir novas execuções. O modelo e as notas anteriores permanecem no histórico, mas a desativação não pode ser revertida pela tela.

  • Não há ação de excluir. Isso preserva a rastreabilidade das emissões realizadas.

Se algo der errado​

  • Se uma execução não puder ser enfileirada, a prévia ou o resultado de Emitir todas de hoje mostra o erro daquele modelo. Corrija a causa antes de tentar de novo.

  • Se o job entrar na fila e falhar, abra Fila, leia a mensagem e acompanhe as tentativas. A falha de uma competência não desativa o modelo: as competências seguintes continuam elegíveis, e o sistema mantém o controle do que já foi agendado para evitar duplicidade.

  • Consulte Mensagens de erro e o que fazer para identificar a causa e a ação segura.

Preencha os campos fiscais nos locais apresentados pela tela, sempre com os dados definidos pelo contador do cliente. A recorrência repete a configuração salva; ela não decide qual tratamento tributário deve ser usado.

Use também pela API​

A gestão de recorrências também está disponível na API v1 em /api/v1/recorrentes. Consulte o capítulo Integrações e API para autenticação, operações e exemplos.