Atividades — Regras de Negócio

1. Conceito

A Atividade (Activity) é o registro de uma ação operacional a ser realizada pelo time de cobrança. Representa tarefas como ligações, e-mails, reuniões e outras interações vinculadas a contratos e títulos da carteira. É a unidade de trabalho do time de cobrança e o principal instrumento de rastreabilidade das interações com clientes devedores.

Atividades podem ser criadas de duas formas:

Criação automática — geradas pelo motor de execução das réguas de cobrança quando uma etapa com actionType = ACTIVITY é disparada (ver ReguasCobranca.md). A atividade herda o title, description, priority e activityType configurados no actionConfig da etapa.

Criação manual — registradas pelo usuário via interface ou API. Útil para ações ad-hoc fora do fluxo automático da régua (ex: contato de follow-up, reunião presencial, negociação de acordo).

1.1. Relação com outros módulos

A atividade é vinculada obrigatoriamente a um contrato e opcionalmente a um título específico. Através do contrato, o sistema resolve o cliente devedor, o que permite exibir o contexto financeiro (valor em aberto, dias de atraso) diretamente na atividade.

A atividade também é o elo entre a régua de cobrança e o histórico de interações do cliente:

Régua de Cobrança → (dispara etapa) → Atividade → (registra em) → Histórico de Interações do Cliente

2. Estruturas de Dados

2.1. Activity

Campo	Tipo	Obrigatório	Descrição
id	UUID	Sim	Identificador único da atividade.
companyId	UUID	Sim	Empresa à qual a atividade pertence.
contractId	UUID	Sim	Contrato vinculado.
receivableId	UUID	Não	Título específico vinculado. `null` quando a atividade é sobre o contrato como um todo.
clientId	UUID	Sim	Cliente devedor. Desnormalizado a partir do contrato para facilitar consultas e filtros.
type	Enum	Sim	Tipo da atividade: `CALL`, `EMAIL`, `MEETING`, `OTHER`.
typeDescription	String	Condicional	Descrição livre quando `type = OTHER`. Obrigatório nesse caso.
title	String	Sim	Título da atividade (ex: "Ligar para negociar acordo de pagamento").
description	String	Não	Descrição detalhada ou instrução para o responsável.
priority	Enum	Sim	Prioridade: `LOW`, `MEDIUM`, `HIGH`.
status	Enum	Sim	Status da atividade: `PENDING`, `SCHEDULED`, `OVERDUE`, `COMPLETED`, `CANCELLED`.
source	Enum	Sim	Origem: `MANUAL` (criada pelo usuário) ou `COLLECTION_RULE` (gerada por régua de cobrança).
collectionRuleId	UUID	Não	Régua que gerou a atividade. Preenchido quando `source = COLLECTION_RULE`.
collectionStepId	UUID	Não	Etapa da régua que gerou a atividade. Preenchido quando `source = COLLECTION_RULE`.
assignedTo	UUID	Não	Usuário responsável pela execução da atividade. `null` se não atribuída.
dueDate	Date	Sim	Data limite para conclusão da atividade.
dueTime	Time	Não	Hora agendada para a atividade (ex: `10:00`). `null` quando sem horário definido.
completedAt	DateTime	Não	Data e hora da conclusão. Preenchido ao mover para `COMPLETED`.
completedBy	UUID	Não	Usuário que concluiu a atividade.
outcome	Enum	Não	Resultado da interação ao concluir. Opcional. Ver seção 2.2.
outcomeNotes	String	Não	Observações livres sobre o resultado da interação.
cancelledAt	DateTime	Não	Data de cancelamento.
cancelledBy	UUID	Não	Usuário que cancelou.
cancellationReason	String	Não	Motivo do cancelamento.
notes	String	Não	Observações gerais sobre a atividade (visíveis antes da conclusão).
createdBy	UUID	Sim	Usuário que criou (manual) ou sistema (automática).
createdAt	DateTime	Sim	Data de criação.
updatedAt	DateTime	Sim	Data da última atualização.

2.2. Outcome (resultado da interação)

Enum opcional preenchido ao concluir a atividade. Permite classificar o resultado para relatórios e análise de efetividade.

Valor	Label	Descrição
`CONTACT_MADE`	Contato realizado	Cliente foi contactado com sucesso.
`NO_ANSWER`	Não atendeu	Tentativa de contato sem resposta.
`PAYMENT_PROMISE`	Promessa de pagamento	Cliente prometeu pagar até uma data específica.
`AGREEMENT_PROPOSED`	Proposta de acordo	Proposta de renegociação enviada ao cliente.
`AGREEMENT_FORMALIZED`	Acordo formalizado	Acordo de pagamento/renegociação formalizado.
`PAYMENT_CONFIRMED`	Pagamento confirmado	Cliente informou que pagamento já foi efetuado.
`DISPUTE`	Contestação	Cliente contestou o débito ou os valores.
`WRONG_CONTACT`	Contato incorreto	Dados de contato do cliente estão incorretos/desatualizados.
`OTHER`	Outro	Resultado não classificado nas opções anteriores. Usar `outcomeNotes` para detalhar.

2.3. Ciclo de vida da atividade

PENDING ──► SCHEDULED ──► COMPLETED
   │            │
   │            ├──► OVERDUE ──► COMPLETED
   │            │           └──► CANCELLED
   │            └──► CANCELLED
   ├──► OVERDUE ──► COMPLETED
   │           └──► CANCELLED
   └──► CANCELLED

Transição	Tipo	Descrição
PENDING → SCHEDULED	Manual	Atividade atribuída a um usuário e/ou com `dueTime` definido.
PENDING → OVERDUE	Automática (job)	`dueDate` ultrapassado sem conclusão.
PENDING → COMPLETED	Manual	Concluída diretamente sem passar por agendamento.
PENDING → CANCELLED	Manual	Cancelada antes da execução.
SCHEDULED → COMPLETED	Manual	Atividade executada e concluída.
SCHEDULED → OVERDUE	Automática (job)	`dueDate` ultrapassado sem conclusão.
SCHEDULED → CANCELLED	Manual	Cancelada.
OVERDUE → COMPLETED	Manual	Concluída com atraso.
OVERDUE → CANCELLED	Manual	Cancelada após atraso.

A transição PENDING → SCHEDULED ocorre automaticamente quando a atividade é atualizada com assignedTo e/ou dueTime. Atividades criadas já com esses campos nascem diretamente como SCHEDULED.

2.4. ActivitySummary (indicadores da listagem)

Objeto retornado no endpoint de listagem como header de contadores.

Campo	Tipo	Descrição
totalCount	Integer	Total de atividades no escopo do filtro aplicado.
pendingCount	Integer	Atividades com `status = PENDING`.
scheduledCount	Integer	Atividades com `status = SCHEDULED`.
completedCount	Integer	Atividades com `status = COMPLETED`.
overdueCount	Integer	Atividades com `status = OVERDUE`.
cancelledCount	Integer	Atividades com `status = CANCELLED`.

2.5. Contexto financeiro na atividade (campos enriquecidos)

Para exibição na interface, os endpoints de listagem e detalhe retornam campos enriquecidos calculados a partir do contrato e título vinculados:

Campo	Tipo	Descrição
clientName	String	Nome do cliente devedor.
clientDocument	String	CPF/CNPJ do cliente.
clientEmail	String	E-mail do cliente.
clientPhone	String	Telefone do cliente.
contractCode	String	Código do contrato vinculado.
receivableCode	String	Código do título vinculado. `null` se sem título específico.
clientOpenAmount	Decimal	Valor total em aberto do cliente na carteira.
receivableOverdueDays	Integer	Dias em atraso do título vinculado. `null` se sem título ou título não vencido.
activityOverdueDays	Integer	Dias de atraso da atividade (diferença entre data atual e `dueDate`). `0` se não atrasada.

3. Regras de Negócio

Criação

RN-ACT-001: Vínculo obrigatório com contrato
Toda atividade deve estar vinculada a um contrato existente via contractId. O contrato deve pertencer à mesma empresa. O clientId é resolvido automaticamente a partir do contrato. Erro: CONTRACT_NOT_FOUND.

RN-ACT-002: Vínculo opcional com título
O receivableId, quando informado, deve pertencer ao contrato vinculado. Erro: RECEIVABLE_NOT_FOUND ou RECEIVABLE_CONTRACT_MISMATCH.

RN-ACT-003: Criação por régua de cobrança
Quando a atividade é criada pelo motor de execução da régua, o sistema preenche automaticamente source = COLLECTION_RULE, collectionRuleId, collectionStepId, e os campos title, description, priority, type a partir do actionConfig da etapa. As variáveis de template ({{clientName}}, {{contractCode}}, etc.) são resolvidas no momento da criação. O dueDate é calculado como data do disparo + dueDaysAfterTrigger configurado na etapa.

RN-ACT-004: Status inicial
Atividades criadas com assignedTo e/ou dueTime preenchidos nascem com status = SCHEDULED. Atividades sem esses campos nascem como PENDING.

RN-ACT-005: Atribuição a usuário
O assignedTo deve ser um usuário tenant da mesma empresa. Quando não informado na criação, a atividade fica não atribuída (PENDING) e pode ser atribuída posteriormente via PATCH. Erro: USER_NOT_FOUND.

Ciclo de vida

RN-ACT-006: Transição automática para OVERDUE
O sistema move automaticamente atividades com status = PENDING ou SCHEDULED para OVERDUE quando a data atual ultrapassar dueDate. Executado por job diário — o mesmo job que processa títulos e contratos.

RN-ACT-007: Conclusão da atividade
A transição para COMPLETED é sempre manual (via endpoint PATCH /status). O campo outcome é opcional mas recomendado — permite classificar o resultado da interação para análise de efetividade. O campo outcomeNotes permite detalhar o resultado em texto livre. Os campos completedAt e completedBy são preenchidos automaticamente.

RN-ACT-008: Cancelamento
A transição para CANCELLED é permitida de qualquer status exceto COMPLETED. O campo cancellationReason é opcional mas recomendado. Atividades geradas por régua de cobrança que são canceladas registram o cancelamento no CollectionStepExecution — o log de execução da régua permanece com status = SUCCESS (a atividade foi criada com sucesso; o cancelamento é posterior).

RN-ACT-009: Reagendamento
A dueDate e dueTime podem ser alterados via PATCH enquanto a atividade estiver em PENDING, SCHEDULED ou OVERDUE. Reagendar uma atividade OVERDUE com uma data futura move-a de volta para SCHEDULED. O histórico de reagendamentos é registrado no ActivityHistory.

Edição

RN-ACT-010: Campos editáveis
Os seguintes campos podem ser alterados via PATCH enquanto a atividade não estiver COMPLETED ou CANCELLED: title, description, priority, type, typeDescription, assignedTo, dueDate, dueTime, notes, receivableId.

RN-ACT-011: Atividades concluídas e canceladas são imutáveis
Atividades com status = COMPLETED ou CANCELLED não podem ser editadas. Erro: ACTIVITY_IMMUTABLE.

Exclusão

RN-ACT-012: Exclusão lógica
Atividades nunca são deletadas fisicamente. Encerramento via COMPLETED ou CANCELLED.

4. Padrão de Erros

Erros comuns herdados

Todos os erros de autenticação, autorização e servidor seguem Carteiras.md.

Códigos de erro específicos

Status	Código	Descrição
404 Not Found	`ACTIVITY_NOT_FOUND`	Atividade não encontrada ou não pertence à empresa.
404 Not Found	`CONTRACT_NOT_FOUND`	Contrato vinculado não encontrado ou não pertence à empresa.
404 Not Found	`RECEIVABLE_NOT_FOUND`	Título vinculado não encontrado.
422 Unprocessable Entity	`RECEIVABLE_CONTRACT_MISMATCH`	O título informado não pertence ao contrato vinculado.
422 Unprocessable Entity	`MISSING_TYPE_DESCRIPTION`	`type = OTHER` sem `typeDescription`.
422 Unprocessable Entity	`INVALID_STATUS_TRANSITION`	Transição de status não permitida.
422 Unprocessable Entity	`ACTIVITY_IMMUTABLE`	Atividade em status final (`COMPLETED`, `CANCELLED`).
422 Unprocessable Entity	`USER_NOT_FOUND`	`assignedTo` não é um usuário válido da empresa.
422 Unprocessable Entity	`INVALID_DUE_DATE`	`dueDate` é anterior à data atual na criação.

5. Endpoints

5.1. Criar Atividade

POST /v2/companies/:companyId/portfolio/activities

Cria uma nova atividade manual.

Permissão requerida: activity:create

Request body:

{
  "contractId": "b9d3f1aa-22cc-4e72-b430-1e45a3d6e001",
  "receivableId": "r1a2b3c4-0000-0000-0000-000000000001",
  "type": "CALL",
  "title": "Ligar para negociar acordo de pagamento",
  "description": "Cliente possui 2 títulos em atraso totalizando R$ 85.000. Verificar possibilidade de acordo com desconto.",
  "priority": "HIGH",
  "assignedTo": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "dueDate": "2025-01-15",
  "dueTime": "10:00",
  "notes": null
}

Response 201 Created:

{
  "id": "act1a2b3c4-0000-0000-0000-000000000001",
  "companyId": "a1b2c3d4-0000-0000-0000-000000000001",
  "contractId": "b9d3f1aa-22cc-4e72-b430-1e45a3d6e001",
  "receivableId": "r1a2b3c4-0000-0000-0000-000000000001",
  "clientId": "a3f1c2d4-0000-0000-0000-000000000010",
  "type": "CALL",
  "typeDescription": null,
  "title": "Ligar para negociar acordo de pagamento",
  "description": "Cliente possui 2 títulos em atraso totalizando R$ 85.000. Verificar possibilidade de acordo com desconto.",
  "priority": "HIGH",
  "status": "SCHEDULED",
  "source": "MANUAL",
  "collectionRuleId": null,
  "collectionStepId": null,
  "assignedTo": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "dueDate": "2025-01-15",
  "dueTime": "10:00",
  "completedAt": null,
  "completedBy": null,
  "outcome": null,
  "outcomeNotes": null,
  "cancelledAt": null,
  "cancelledBy": null,
  "cancellationReason": null,
  "notes": null,
  "createdBy": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "createdAt": "2025-01-14T09:00:00Z",
  "updatedAt": "2025-01-14T09:00:00Z",
  "clientName": "Agropecuária Horizonte",
  "clientDocument": "12.345.678/0001-90",
  "clientEmail": "contato@agrohorizonte.com.br",
  "clientPhone": "(11) 99999-9999",
  "contractCode": "CT-2024-002",
  "receivableCode": "NF-001",
  "clientOpenAmount": 85000.00,
  "receivableOverdueDays": 10,
  "activityOverdueDays": 0
}

Erros específicos:

Status	Código
404	`CONTRACT_NOT_FOUND`
404	`RECEIVABLE_NOT_FOUND`
422	`RECEIVABLE_CONTRACT_MISMATCH`
422	`MISSING_TYPE_DESCRIPTION`
422	`USER_NOT_FOUND`
422	`INVALID_DUE_DATE`

5.2. Listar Atividades

GET /v2/companies/:companyId/portfolio/activities

Lista as atividades da carteira com indicadores de resumo, filtros e paginação.

Permissão requerida: activity:read

Query params:

Parâmetro	Tipo	Obrigatório	Descrição
search	String	Não	Busca por nome do cliente, código do contrato ou descrição da atividade.
status	Enum (multi)	Não	Filtrar por status. Aceita múltiplos valores.
type	Enum (multi)	Não	Filtrar por tipo: `CALL`, `EMAIL`, `MEETING`, `OTHER`.
priority	Enum (multi)	Não	Filtrar por prioridade: `LOW`, `MEDIUM`, `HIGH`.
source	Enum	Não	Filtrar por origem: `MANUAL`, `COLLECTION_RULE`.
assignedTo	UUID	Não	Filtrar por usuário responsável.
clientId	UUID	Não	Filtrar por cliente.
contractId	UUID	Não	Filtrar por contrato.
dueDateStart	Date (ISO)	Não	Atividades com `dueDate >=` esta data.
dueDateEnd	Date (ISO)	Não	Atividades com `dueDate <=` esta data.
sortBy	Enum	Não	Ordenação: `dueDate`, `priority`, `createdAt`, `clientName`. Default: `dueDate`.
sortOrder	Enum	Não	`asc` ou `desc`. Default: `asc`.
page	Integer	Não	Default: 1.
pageSize	Integer	Não	Default: 20. Máximo: 100.

Response 200 OK:

{
  "summary": {
    "totalCount": 8,
    "pendingCount": 5,
    "scheduledCount": 2,
    "completedCount": 1,
    "overdueCount": 5,
    "cancelledCount": 0
  },
  "data": [
    {
      "id": "act1a2b3c4-0000-0000-0000-000000000001",
      "contractId": "b9d3f1aa-22cc-4e72-b430-1e45a3d6e001",
      "receivableId": "r1a2b3c4-0000-0000-0000-000000000001",
      "clientId": "a3f1c2d4-0000-0000-0000-000000000010",
      "type": "CALL",
      "title": "Ligar para negociar acordo de pagamento",
      "description": "Cliente possui 2 títulos em atraso totalizando R$ 85.000.",
      "priority": "HIGH",
      "status": "SCHEDULED",
      "source": "COLLECTION_RULE",
      "assignedTo": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "assignedToName": "João Silva",
      "dueDate": "2025-01-15",
      "dueTime": "10:00",
      "outcome": null,
      "createdAt": "2025-01-14T09:00:00Z",
      "clientName": "Agropecuária Horizonte",
      "clientDocument": "12.345.678/0001-90",
      "clientEmail": "contato@agrohorizonte.com.br",
      "clientPhone": "(11) 99999-9999",
      "contractCode": "CT-2024-002",
      "receivableCode": "NF-001",
      "clientOpenAmount": 85000.00,
      "receivableOverdueDays": 10,
      "activityOverdueDays": 0
    },
    {
      "id": "act1a2b3c4-0000-0000-0000-000000000002",
      "contractId": "c7e2a1bb-33dd-4f83-c541-2f56b4e7f999",
      "receivableId": null,
      "clientId": "b4g2d3e5-0000-0000-0000-000000000020",
      "type": "EMAIL",
      "title": "Enviar proposta de renegociação",
      "description": null,
      "priority": "LOW",
      "status": "PENDING",
      "source": "MANUAL",
      "assignedTo": null,
      "assignedToName": null,
      "dueDate": "2025-01-15",
      "dueTime": "14:00",
      "outcome": null,
      "createdAt": "2025-01-14T10:00:00Z",
      "clientName": "João Silva",
      "clientDocument": "123.456.789-00",
      "clientEmail": "joao.silva@email.com",
      "clientPhone": "(11) 97777-6666",
      "contractCode": "CT-2024-005",
      "receivableCode": null,
      "clientOpenAmount": 85000.00,
      "receivableOverdueDays": null,
      "activityOverdueDays": 0
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "nextPage": false
  }
}

O summary é calculado sobre todos os registros que atendem aos filtros aplicados (não apenas a página atual), permitindo que a interface exiba os cards de contadores.

5.3. Detalhe da Atividade

GET /v2/companies/:companyId/portfolio/activities/:activityId

Retorna o detalhe completo de uma atividade.

Permissão requerida: activity:read

Response 200 OK: Mesmo formato da resposta do POST (seção 5.1), com todos os campos preenchidos.

5.4. Atualizar Atividade

PATCH /v2/companies/:companyId/portfolio/activities/:activityId

Atualiza campos editáveis da atividade. Permitido apenas para atividades com status != COMPLETED e status != CANCELLED.

Permissão requerida: activity:update

Campos editáveis: title, description, priority, type, typeDescription, assignedTo, dueDate, dueTime, receivableId, notes.

Request body (exemplo — reagendar e reatribuir):

{
  "assignedTo": "e4a5b6c7-7g99-6b05-e763-4178d6g9h334",
  "dueDate": "2025-01-20",
  "dueTime": "09:00",
  "notes": "Reagendada — responsável anterior em férias."
}

Quando uma atividade OVERDUE é reagendada com dueDate futura, o status transita automaticamente para SCHEDULED.

Response 200 OK: Retorna a atividade atualizada.

Erros específicos:

Status	Código
422	`ACTIVITY_IMMUTABLE`
422	`USER_NOT_FOUND`
422	`RECEIVABLE_CONTRACT_MISMATCH`

5.5. Alterar Status da Atividade

PATCH /v2/companies/:companyId/portfolio/activities/:activityId/status

Executa transição de status manual. Usado para concluir ou cancelar atividades.

Permissão requerida: activity:update

Request body — concluir com resultado:

{
  "status": "COMPLETED",
  "outcome": "PAYMENT_PROMISE",
  "outcomeNotes": "Cliente informou que efetuará pagamento via PIX até 20/01. Valor acordado: R$ 85.000 sem desconto."
}

Request body — concluir sem resultado (apenas marcar como feita):

{
  "status": "COMPLETED"
}

Request body — cancelar:

{
  "status": "CANCELLED",
  "cancellationReason": "Título foi pago antes da atividade ser executada."
}

Response 200 OK:

{
  "id": "act1a2b3c4-0000-0000-0000-000000000001",
  "status": "COMPLETED",
  "outcome": "PAYMENT_PROMISE",
  "outcomeNotes": "Cliente informou que efetuará pagamento via PIX até 20/01.",
  "completedAt": "2025-01-15T10:30:00Z",
  "completedBy": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "updatedAt": "2025-01-15T10:30:00Z"
}

Erros específicos:

Status	Código
422	`INVALID_STATUS_TRANSITION`
422	`ACTIVITY_IMMUTABLE`

5.6. Exportar Atividades

GET /v2/companies/:companyId/portfolio/activities/export

Exporta a listagem de atividades em CSV ou XLSX. Respeita os mesmos filtros da listagem.

Permissão requerida: activity:read

Query params: Mesmos filtros do GET /activities, acrescidos de:

Parâmetro	Tipo	Obrigatório	Descrição
format	Enum	Sim	`CSV` ou `XLSX`.

Response 200 OK: Arquivo binário.

6. Permissões RBAC

O módulo de Atividades adiciona o seguinte resource ao catálogo RBAC:

Resource	Domínio	Descrição
`activity`	TENANT	CRUD e gestão de atividades de cobrança.

Resource	Actions
`activity`	`create`, `read`, `update`, `delete`

A action delete cobre cancelamento (não existe exclusão física).

7. Impacto em Outros Módulos

7.1. Réguas de Cobrança

A ação ACTIVITY da régua de cobrança (ver ReguasCobranca.md, seção 2.3) cria atividades neste módulo. O resultRef no CollectionStepExecution aponta para o id da atividade criada. O assignedTo da atividade gerada por régua é:

O usuário gestor da sub-carteira à qual o contrato pertence, quando definido.

null (não atribuída) quando o contrato não está em sub-carteira ou a sub-carteira não tem gestor.

7.2. Clientes na Carteira

O endpoint GET /portfolio/clients/:clientId/interactions (ver ClientesCarteira.md) é uma fachada que consulta este módulo com filtro clientId implícito. Os campos lastInteractionAt e lastInteractionType do PortfolioClientSummary são calculados a partir da atividade COMPLETED mais recente do cliente.

7.3. Indicadores da Carteira Global

O PortfolioSummary (ver Carteiras.md) inclui indicadores de efetividade por ação (actionEffectiveness). Esses indicadores são calculados cruzando pagamentos de títulos com a última atividade COMPLETED registrada antes do pagamento — ex: se a última atividade antes de um pagamento foi do tipo CALL, o valor recuperado é atribuído ao tipo CALL.

8. Roadmap

8.1. Atividades recorrentes

Status: Fora do escopo da v1.

Permitir configurar atividades que se repetem automaticamente (ex: ligação semanal enquanto título estiver em atraso). Diferente da régua de cobrança, que dispara em pontos fixos — a recorrência seria contínua enquanto a condição for verdadeira.

8.2. Integração com canais

Status: Fora do escopo da v1.

Integração com canais de comunicação para executar ações diretamente da atividade: click-to-call (VoIP), envio de e-mail com template, envio de SMS/WhatsApp. Na v1, a atividade é um registro — a execução é feita fora do sistema.

8.3. SLA e escalação automática

Status: Fora do escopo da v1.

Definir SLAs por tipo e prioridade de atividade. Atividades que excedam o SLA são escaladas automaticamente (ex: reatribuídas ao gestor, prioridade elevada, notificação enviada).

Regras das Atividades

Atividades — Regras de Negócio#

1. Conceito#

1.1. Relação com outros módulos#

2. Estruturas de Dados#

2.1. Activity#

2.2. Outcome (resultado da interação)#

2.3. Ciclo de vida da atividade#

2.4. ActivitySummary (indicadores da listagem)#

2.5. Contexto financeiro na atividade (campos enriquecidos)#

3. Regras de Negócio#

Criação#

Ciclo de vida#

Edição#

Exclusão#

4. Padrão de Erros#

Erros comuns herdados#

Códigos de erro específicos#

5. Endpoints#

5.1. Criar Atividade#

POST /v2/companies/:companyId/portfolio/activities#

5.2. Listar Atividades#

GET /v2/companies/:companyId/portfolio/activities#

5.3. Detalhe da Atividade#

GET /v2/companies/:companyId/portfolio/activities/:activityId#

5.4. Atualizar Atividade#

PATCH /v2/companies/:companyId/portfolio/activities/:activityId#

5.5. Alterar Status da Atividade#

PATCH /v2/companies/:companyId/portfolio/activities/:activityId/status#

5.6. Exportar Atividades#

GET /v2/companies/:companyId/portfolio/activities/export#

6. Permissões RBAC#

7. Impacto em Outros Módulos#

7.1. Réguas de Cobrança#

7.2. Clientes na Carteira#

7.3. Indicadores da Carteira Global#

8. Roadmap#

8.1. Atividades recorrentes#

8.2. Integração com canais#

8.3. SLA e escalação automática#

Atividades — Regras de Negócio

1. Conceito

1.1. Relação com outros módulos

2. Estruturas de Dados

2.1. Activity

2.2. Outcome (resultado da interação)

2.3. Ciclo de vida da atividade

2.4. ActivitySummary (indicadores da listagem)

2.5. Contexto financeiro na atividade (campos enriquecidos)

3. Regras de Negócio

Criação

Ciclo de vida

Edição

Exclusão

4. Padrão de Erros

Erros comuns herdados

Códigos de erro específicos

5. Endpoints

5.1. Criar Atividade

POST /v2/companies/:companyId/portfolio/activities

5.2. Listar Atividades

GET /v2/companies/:companyId/portfolio/activities

5.3. Detalhe da Atividade

GET /v2/companies/:companyId/portfolio/activities/:activityId

5.4. Atualizar Atividade

PATCH /v2/companies/:companyId/portfolio/activities/:activityId

5.5. Alterar Status da Atividade

PATCH /v2/companies/:companyId/portfolio/activities/:activityId/status

5.6. Exportar Atividades

GET /v2/companies/:companyId/portfolio/activities/export

6. Permissões RBAC

7. Impacto em Outros Módulos

7.1. Réguas de Cobrança

7.2. Clientes na Carteira

7.3. Indicadores da Carteira Global

8. Roadmap

8.1. Atividades recorrentes

8.2. Integração com canais

8.3. SLA e escalação automática