Adueladocumentação

CRM e oportunidades

Contactos, oportunidades e o funil, antes de haver venda.

É o que acontece antes do comercial: quem ainda não comprou. Uma oportunidade ganha passa a cliente e a venda, sem ninguém copiar nada.

O que a licença destranca

Este módulo exige a funcionalidade crm na licença. Sem ela, as rotas dele respondem 403 e o menu não o mostra.

O que se consegue ver a acontecer

  • Uma oportunidade percorre as fases do funil, e cada mudança fica datada
  • Uma oportunidade ganha cria o cliente e a venda, com as linhas que tinha
  • As atividades marcadas aparecem na agenda de quem as tem

Os 15 endpoints

Saem da árvore de rotas montada, que é a mesma que serve os pedidos. A referência completa, com corpos e respostas, está em /api.

Método Caminho O que faz
POST /api/v1/crm/atividades Regista uma chamada, uma visita ou uma mensagem
POST /api/v1/crm/atividades/:id/feito Fecha o próximo passo
GET /api/v1/crm/atividades/por-fazer O que está marcado e por dar
GET /api/v1/crm/contactos Lista as pessoas
POST /api/v1/crm/contactos Regista uma pessoa
GET /api/v1/crm/funil Quanto está em cada fase
GET /api/v1/crm/oportunidades Lista os negócios
POST /api/v1/crm/oportunidades Abre um negócio
GET /api/v1/crm/oportunidades/:id Mostra um negócio
POST /api/v1/crm/oportunidades/:id/mover Move o negócio no funil
POST /api/v1/crm/oportunidades/:id/orcamento Guarda o orçamento que nasceu deste negócio
GET /api/v1/crm/organizacoes Lista as organizações
POST /api/v1/crm/organizacoes Regista uma empresa com quem se fala
GET /api/v1/crm/organizacoes/:id Mostra uma organização
GET /api/v1/crm/organizacoes/:id/historico A linha do tempo de um cliente

Esta página é gerada a partir do código do módulo, com make docs-modulos. O que aqui está muda no mesmo commit em que o módulo muda.