Ascend
Ascend
Docs
API

Transações recorrentes

Recorrências diárias, mensais ou anuais.

Visao geral

Recorrencias permitem gerar transacoes automaticamente por data (diaria, mensal ou anual).

Cabecalhos obrigatorios

  • x-user-id: UUID do usuario autenticado.

Endpoints

Criar recorrencia

  • POST /api/v1/recurring-transactions
  • Body:
    • amount (number)
    • type (INCOME | EXPENSE)
    • periodicity (DAILY | MONTHLY | YEARLY)
    • multiplier (int >= 1)
    • startsAt (date, opcional)
    • endsAt (date, opcional)
    • indefinite (boolean, default true)
    • active (boolean, default true)
    • description, categoryId, familyMemberId, serviceCategoryId, paymentMethod (opcionais)

Listar recorrencias

  • GET /api/v1/recurring-transactions
  • Query:
    • active (boolean, opcional)
    • periodicity (opcional)
    • page, pageSize

Obter recorrencia

  • GET /api/v1/recurring-transactions/:id

Atualizar recorrencia

  • PATCH /api/v1/recurring-transactions/:id
  • Body: campos atualizaveis do create

Excluir recorrencia

  • DELETE /api/v1/recurring-transactions/:id

Regras de negocio

  • Recorrencias sao por data (sem horario), executadas o mais cedo possivel.
  • Quando active=false, a recorrencia pausa e so volta a rodar quando reativada.
  • indefinite=false exige endsAt.

On this page