Activities
Entidade: Activity
Visão Geral
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
Status Disponíveis
| Status | Descrição |
|---|---|
open | Atividade em andamento |
completed | Atividade finalizada |
Casos de Uso Detalhados
1. Registro de Interações com Clientes
completed após o fimcompletedAt automaticamenteRegras de Negócio
Criação de Atividades
opencompletedAt é preenchido automaticamente ao alterar o status para completedControle de Acesso
Segurança
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 |