Propostas

Corresponde à tela Propostas. Uma proposta de treinamento para uma empresa cliente reúne os cursos oferecidos, os contatos que vão recebê-la, as despesas previstas e o arquivo da proposta para envio ao cliente. Cada proposta tem um código sequencial, gerado pelo sistema. Os cursos, os contatos, as despesas e o histórico têm páginas próprias: Cursos, Contatos, Despesas e Auditorias.

Endpoints

Método	Caminho	Descrição
GET	/crm/proposals	Lista as propostas
POST	/crm/proposals	Cria uma proposta
GET	/crm/proposals/{uuid}	Consulta uma proposta
PUT	/crm/proposals/{uuid}	Altera uma proposta
DELETE	/crm/proposals/{uuid}	Apaga uma proposta
GET	/crm/proposals/{uuid}/print	Gera o arquivo da proposta para download
GET	/crm/proposals/statuses	Lista os status de proposta (apoio)
GET	/crm/proposals/types	Lista os tipos de proposta (apoio)
GET	/crm/proposals/customers	Lista os clientes (apoio)
GET	/crm/proposals/companies	Lista as filiais das empresas (apoio)

GET /crm/proposals

Lista as propostas da empresa cliente, da mais recente para a mais antiga, pelo código.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre: nome da empresa, nome do cliente, referência e nome do status
customer_vendor_uuid	uuid do cliente da proposta
not_status	Lista de ids de status a deixar de fora do resultado (por exemplo, not_status[]=2)
per_page, page	Paginação, conforme Convenções

Exemplo

curl "https://api.pedagogo.app/crm/proposals?per_page=15&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

Resposta (200): a lista de propostas, sem per_page, ou a página de propostas, com per_page. Cada proposta traz o código, o nome do cliente, a filial, o tipo, o status, o valor bruto e os nomes de quem criou e de quem alterou.

POST /crm/proposals

Cria uma proposta. Sem status_id e type_id, a proposta recebe os valores padrão do cadastro.

Corpo

Campo	Obrigatório	Tipo	Descrição
customer_vendor_id	Sim	inteiro	Empresa cliente da proposta (id do cliente)
company_id	Não	inteiro	Filial da empresa, quando houver
contact_id	Não	inteiro	Pessoa de contato do cliente
status_id	Não	inteiro	Status da proposta (id da lista de status)
type_id	Não	inteiro	Tipo da proposta (id da lista de tipos)
reference	Não	texto	Referência ou identificação interna da proposta
revision	Não	texto	Número da revisão da proposta
means_of_payment	Não	texto	Forma de pagamento combinada
comments	Não	texto	Comentários da proposta
observations	Não	texto	Observações da proposta

Exemplo

curl -X POST https://api.pedagogo.app/crm/proposals \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_vendor_id": 1,
    "reference": "Proposta exemplo",
    "means_of_payment": "30 dias"
  }'

Resposta (201): a proposta criada, com o uuid e o code.

GET /crm/proposals/{uuid}

Consulta uma proposta. Resposta (200): a proposta, com a empresa, o cliente, o tipo, os cursos e os contatos.

PUT /crm/proposals/{uuid}

Altera uma proposta. Envie apenas os campos que mudam.

Corpo

Campo	Obrigatório	Tipo	Descrição
customer_vendor_id	Sim	inteiro	Empresa cliente da proposta
company_id	Não	inteiro	Filial da empresa
contact_id	Não	inteiro	Pessoa de contato do cliente
status_id	Não	inteiro	Status da proposta
type_id	Não	inteiro	Tipo da proposta
reference	Não	texto	Referência da proposta
revision	Não	texto	Número da revisão
means_of_payment	Não	texto	Forma de pagamento
comments	Não	texto	Comentários. Quando preenchido, gera um registro na auditoria da proposta
observations	Não	texto	Observações da proposta

Resposta (200): a proposta alterada.

DELETE /crm/proposals/{uuid}

Remove a proposta da lista. Resposta (200).

GET /crm/proposals/{uuid}/print

Gera o arquivo da proposta para download. O modelo do arquivo depende da configuração de relatórios da empresa cliente. Resposta (200): o arquivo da proposta, em PDF, para download.

GET /crm/proposals/statuses

Lista os status de proposta, para o campo status_id. Resposta (200): a lista de status.

GET /crm/proposals/types

Lista os tipos de proposta, para o campo type_id. Resposta (200): a lista de tipos.

GET /crm/proposals/customers

Lista os clientes, para escolher a empresa cliente da proposta. Resposta (200): a lista de clientes.

GET /crm/proposals/companies

Lista as filiais das empresas, para escolher a filial da proposta. Resposta (200): a lista de filiais.