Saltar para o conteúdo
RemindCash

Cobranças recorrentes

Como funcionam as cobranças recorrentes semanais e mensais e o que a API v1 pode e não pode fazer com elas.

Estado da API pública

A API v1 usa chaves bearer da empresa e exige um período de plano ativo. Os endpoints de rascunhos e de comunicação de pagamentos não enviam mensagens a clientes. Os exemplos usam marcadores — nunca cole uma chave real em código partilhado.

Ainda não está na API. As séries recorrentes são criadas e geridas na aplicação RemindCash. A API v1 não tem endpoints para criar, editar ou parar uma série.

Como funcionam as cobranças recorrentes

Uma cobrança recorrente é uma série que se repete todas as semanas ou todos os meses, indefinidamente ou até ser parada. Cada repetição é uma ocorrência separada com:

  • o seu próprio ID estável, data de vencimento e montante fixado,
  • os seus próprios lembretes planeados (segundo o calendário da empresa) e estado de pagamento.

Pagar uma ocorrência nunca marca outra como paga, e uma ocorrência paga nunca volta a ser lembrada. As datas mensais que não existem num mês mais curto seguem uma regra coerente de último dia do mês.

Quando edita uma série na aplicação, escolhe se a alteração se aplica apenas a esta ocorrência ou às ocorrências futuras. As ocorrências passadas e pagas nunca são reescritas.

O que pode fazer através da API

  • As ocorrências aparecem em GET /v1/receivables como qualquer outra cobrança, com o seu próprio id, due_date e status.
  • Pode registar pagamentos numa ocorrência e pausá-la, retomá-la ou cancelá-la.
  • PATCH numa ocorrência devolve 409 conflict — edite a série na aplicação.