Documentação

Português

English
Español

Português

English
Español

Appearance

Cobranças automáticas ​

Pré-requisitos de acesso

  • Permissão (módulo): processPaymentQueue
  • Licença/Feature: Nenhuma específica.
  • Contêiner do menu: GERAL → grupo Cobranças (rota /automated-recurrences)

O que é / quando usar ​

As Cobranças automáticas são modelos de cobrança perpétuos por dia do mês — sem data de fim. Enquanto a tela Cadastro de cobranças para usuários define um débito com início e fim e gera parcelas mês a mês, aqui o operador define um template recorrente (descrição, moeda, valor e o dia de cobrança) que vale por tempo indeterminado, até ser excluído.

Use-a para taxas e assinaturas contínuas que não têm prazo definido. Cada modelo fica ativo (is_active = true) e é aplicado no dia configurado de cada mês.

Pré-condições ​

  • Permissão: processPaymentQueue cadastrada para a role do operador (permissão dupla — enum CPM no backend + módulo dinâmico no DB).
  • Licença/Feature: Nenhuma específica.
  • Dependências de outras telas: o débito recai sobre o saldo do usuário; o cliente-alvo precisa estar APPROVED.

Passo a passo ​

  1. Acesse Cobranças → Cobranças automáticas (rota /automated-recurrences).
  2. A listagem mostra os modelos cadastrados com Descrição, Valor, Moeda e Dia.
  3. Clique em Criar nova cobrança para abrir o modal.
  4. Preencha Descrição, Moeda, Valor e Dia (1 a 31) e confirme em Salvar.
  5. Para remover um modelo, clique no ícone de lixeira na linha.

Campos (modal de cadastro) ​

CampoO que éObrigatório?Efeito no sistema/backend
DescriçãoTexto que identifica a cobrança e aparece no extratoSimGrava description em automated_recurrently_charges (FMS).
MoedaSímbolo da moeda da cobrança (ex.: BRL, token)SimGrava unit_of_money_requested. Como nas demais cobranças, BRL direciona o débito pela conta digital; outros símbolos pela carteira cripto.
ValorQuantia a debitar a cada cicloSim (> 0)Grava amount_requested (coluna numeric). Tratado como BigNumber no processamento.
DiaDia do mês em que a cobrança é aplicadaSim (inteiro 1–31)Grava day. Define a competência mensal recorrente. O modal valida que o valor é inteiro entre 1 e 31.

O campo is_active é definido como true automaticamente ao salvar — não há toggle na tela. Para "desligar" uma cobrança, exclua o modelo.

Ações e modais ​

  • Criar nova cobrança: abre o modal AutomatedRecurrencyModalComponent. Só habilita Salvar quando descrição, moeda, valor (> 0) e dia (1–31) estão válidos.
  • Salvar: envia para POST /v1/automated-recurrently/create. Em sucesso recarrega a lista.
  • Excluir (lixeira): chama POST /v1/automated-recurrently/delete com o recurrencyId. Após a confirmação a página é recarregada.

Regras de negócio / cuidados ​

Atenção

  • Cobranças automáticas não têm data de fim — permanecem ativas até serem excluídas. Revise periodicamente a lista para evitar débitos indevidos.
  • A Moeda determina o trilho (conta digital para BRL, carteira para token). Confira o símbolo.
  • O Dia deve existir no mês; meses curtos podem exigir atenção ao escolher 29/30/31.
  • Valores financeiros: tratados como BigNumber — sem arredondamento.
  • Idempotência: a aplicação de cada ciclo segue o padrão idempotente do FinLib — E00021 ("already processed") é sucesso, não erro.
  • Status APPROVED: o usuário-alvo precisa estar aprovado para o débito ser efetivado.

Telas relacionadas ​