Ascend
Ascend
Docs
API

Metas

CRUD de metas financeiras.

Visão geral

Rotas para criar, listar, obter, atualizar e arquivar/restaurar metas do usuário (opcionalmente vinculadas a um membro da família e/ou categoria).

  • Base: https://api.ascendteam.cloud/api/v1/goals
  • Autenticação: requer sessão/credenciais válidas do Better Auth (ver /docs/api/auth).

Endpoints

POST /

Cria uma meta.

Body

  • name (string, obrigatório)
  • type (SAVINGS | EXPENSE_LIMIT | INCOME_TARGET, obrigatório)
  • period (MONTHLY | YEARLY, obrigatório)
  • targetAmount (number, obrigatório)
  • startsAt (date, opcional)
  • endsAt (date, opcional)
  • categoryId (UUID, opcional)
  • familyMemberId (UUID, opcional)

GET /

Lista metas.

Query

  • includeArchived (boolean, opcional, default false)

GET /:id

Obtém uma meta por ID.

PATCH /:id

Atualiza campos da meta.

PATCH /:id/archive

Arquiva a meta.

PATCH /:id/restore

Restaura a meta.

On this page