API
Categorias
Categorias de transação.
Visao geral
Rotas para criar, listar, obter, atualizar, arquivar e restaurar categorias de transacao.
- Base:
https://api.ascendteam.cloud/api/v1/categories - Autenticacao: requer sessao/credenciais validas do Better Auth (ver
/docs/api/auth).
Modelo (campos principais)
id(UUID)userId(UUID)name(string)type(INCOME | EXPENSE)archivedAt(opcional)createdAtupdatedAt
Endpoints
POST /
Cria uma nova categoria.
Body
name(string, obrigatorio, max 120)type(INCOME | EXPENSE, obrigatorio)
Respostas
- 201: categoria criada
- 400: dados invalidos
GET /
Lista categorias (paginado).
Query
type(INCOME | EXPENSE, opcional)includeArchived(boolean, opcional, default false)page(number, opcional, default 1)pageSize(number, opcional, default 20, max 100)
Resposta 200
total,page,pageSize,items(array de categorias)
GET /:id
Busca uma categoria por ID.
Params
id(UUID)
Respostas
- 200: categoria encontrada
- 404: categoria nao encontrada
PATCH /:id
Atualiza campos da categoria.
Params
id(UUID)
Body
name(string, opcional)type(INCOME | EXPENSE, opcional)
Respostas
- 200: categoria atualizada
- 404: categoria nao encontrada
PATCH /:id/archive
Arquiva a categoria.
Params
id(UUID)
Respostas
- 200: categoria arquivada
- 404: categoria nao encontrada
PATCH /:id/restore
Restaura a categoria arquivada.
Params
id(UUID)
Respostas
- 200: categoria restaurada
- 404: categoria nao encontrada
Observacoes
- O primeiro GET cria categorias padrao se o usuario ainda nao possuir (income/expense).
- Evite deletar categorias; use arquivamento para preservar historico.