Metas Financeiras

Defina e acompanhe metas financeiras com valor alvo, prazo e contribuicoes. Categorize por prioridade e acompanhe o progresso em tempo real.

GET/api/goals

Lista metas financeiras com paginacao e filtros.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Pagina(default: `1`)
`limit`(query)	`integer`	Nao	Itens por pagina(default: `20`)
`category`(query)	`string`	Nao	Categoria
`priority`(query)	`string`	Nao	low, medium ou high

bash

curl -s "https://flow.seudominio.com/api/goals?priority=high" \
  -H "Authorization: Bearer $TOKEN" | jq .

200Lista de metas

json

{
  "success": true,
  "data": {
    "goals": [
      {
        "id": "clx...",
        "name": "Reserva de emergencia",
        "targetAmount": 50000.00,
        "currentAmount": 32000.00,
        "targetDate": "2026-12-31",
        "category": "reserva",
        "priority": "high",
        "progress": 64
      }
    ],
    "total": 5,
    "page": 1,
    "limit": 20
  }
}

POST/api/goals

Cria uma nova meta financeira.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome da meta
`targetAmount`	`number`	Sim	Valor alvo
`targetDate`	`string`	Sim	Data limite (YYYY-MM-DD)
`category`	`string`	Nao	Categoria
`priority`	`string`	Nao	low, medium ou high

curl -X POST "https://flow.seudominio.com/api/goals" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Reserva de emergencia",
    "targetAmount": 50000.00,
    "targetDate": "2026-12-31",
    "category": "reserva",
    "priority": "high"
  }'

GET/api/goals/{id}

Retorna detalhes de uma meta com historico de contribuicoes.

bash

curl -s "https://flow.seudominio.com/api/goals/clx123" \
  -H "Authorization: Bearer $TOKEN" | jq .

PUT/api/goals/{id}

Atualiza uma meta financeira.

bash

curl -X PUT "https://flow.seudominio.com/api/goals/clx123" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "targetAmount": 60000.00, "priority": "high" }'

DELETE/api/goals/{id}

Remove uma meta financeira.

bash

curl -X DELETE "https://flow.seudominio.com/api/goals/clx123" \
  -H "Authorization: Bearer $TOKEN"

Contribuicoes

POST/api/goals/{id}/contribute

Adiciona uma contribuicao a uma meta.

Body

Nome	Tipo	Obrigatorio	Descricao
`amount`	`number`	Sim	Valor da contribuicao (minimo 0.01)

curl -X POST "https://flow.seudominio.com/api/goals/clx123/contribute" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 2000.00 }'

200Contribuicao registrada

json

{
  "success": true,
  "data": {
    "id": "clx...",
    "name": "Reserva de emergencia",
    "targetAmount": 50000.00,
    "currentAmount": 34000.00,
    "progress": 68
  }
}

GET/api/goals/summary

Resumo de todas as metas financeiras.

200Resumo de metas

json

{
  "success": true,
  "data": {
    "totalGoals": 5,
    "totalTarget": 150000.00,
    "totalCurrent": 78000.00,
    "averageProgress": 52,
    "completedGoals": 1,
    "nearDeadline": 2
  }
}