Visão Geral#
A entidade Atividade representa interações com clientes como chamadas, reuniões ou mensagens. Cada atividade está vinculada a uma empresa, a um usuário e, opcionalmente, a uma negociação. Ela serve para rastrear a jornada do cliente no sistema.Estrutura da Entidade#
Campos Principais#
| Campo | Tipo | Descrição | Obrigatório |
|---|
id | number | Identificador único da atividade | ✅ (auto) |
title | string | Título descritivo da atividade | ✅ |
type | string | Tipo da atividade (ex.: whatsapp, call) | ✅ |
start | DateTime | Data/hora de início da atividade | ✅ |
end | DateTime | Data/hora de término | ❌ |
status | enum | Estado atual da atividade (open, completed) | ✅ |
userId | number | ID do usuário responsável | ✅ (auto) |
companyId | number | ID da empresa vinculada | ✅ (auto) |
dealId | number | ID da negociação associada | ❌ |
completedAt | DateTime | Data/hora da conclusão (quando status for completed) | ❌ (auto) |
createdAt | DateTime | Data/hora de criação | ✅ (auto) |
updatedAt | DateTime | Data/hora da última atualização | ✅ (auto) |
Relacionamentos#
Empresa: Empresa vinculada
Usuário: Responsável pela atividade
Negociação: Negociação associada (opcional)
Anotação: Comentários relacionados à atividade
Status Disponíveis#
| Status | Descrição |
|---|
open | Atividade em andamento |
completed | Atividade finalizada |
Casos de Uso Detalhados#
Cenário: Um usuário deseja registrar uma reunião feita com um cliente.O usuário cria a atividade com título, tipo e horário
Pode associar a uma negociação existente
Marca como completed após o fim
O sistema registra completedAt automaticamente
Regras de Negócio#
Criação de Atividades#
Vinculação automática à empresa e ao usuário autenticado
completedAt é preenchido automaticamente ao alterar o status para completed
Controle de Acesso#
Usuários só visualizam atividades de sua empresa
Usuários comuns só podem ver suas próprias atividades
Segurança#
Validação das datas para integridade temporal
Exclusão de atividades não afeta negociações associadas
Operações Disponíveis#
| Operação | Descrição | Método HTTP |
|---|
| Listar | Retorna lista paginada de atividades | GET |
| Criar | Cria uma nova atividade | POST |
| Visualizar | Detalha uma atividade específica | GET |
| Atualizar | Altera dados ou status da atividade | PUT/PATCH |
| Excluir | Remove uma atividade | DELETE |
Fluxo de Uso#
Modificado em 2025-06-16 14:36:09
