API
Categorias de serviço
Categorias de serviço usadas no faturamento.
Visao geral
Rotas para criar, listar, obter, atualizar, arquivar e restaurar categorias de servico usadas no faturamento (Debt).
- Base:
https://api.ascendteam.cloud/api/v1/service-categories - Autenticacao: requer sessao/credenciais validas do Better Auth (ver
/docs/api/auth).
Modelo (campos principais)
id(UUID)userId(UUID)name(string)archivedAt(opcional)createdAtupdatedAt
Endpoints
POST /
Cria uma nova categoria de servico.
Body
name(string, obrigatorio, max 120)
Respostas
- 201: categoria criada
- 400: dados invalidos
GET /
Lista categorias de servico (paginado).
Query
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 de servico)
GET /:id
Busca uma categoria de servico por ID.
Params
id(UUID)
Respostas
- 200: categoria encontrada
- 404: categoria nao encontrada
PATCH /:id
Atualiza campos da categoria de servico.
Params
id(UUID)
Body
name(string, opcional)
Respostas
- 200: categoria atualizada
- 404: categoria nao encontrada
PATCH /:id/archive
Arquiva a categoria de servico.
Params
id(UUID)
Respostas
- 200: categoria arquivada
- 404: categoria nao encontrada
PATCH /:id/restore
Restaura a categoria de servico 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.
- Dividas so podem referenciar categorias do mesmo usuario e nao arquivadas.