Despesas da proposta

Corresponde à seção Despesas da página da proposta, na tela Propostas. Lista as despesas previstas para a proposta, por tipo de despesa.

Endpoints

Método	Caminho	Descrição
GET	/crm/proposals/{proposal_uuid}/expenses	Lista as despesas da proposta
POST	/crm/proposals/{proposal_uuid}/expenses	Inclui uma despesa na proposta
GET	/crm/proposals/{proposal_uuid}/expenses/{id}	Consulta uma despesa da proposta
PUT	/crm/proposals/{proposal_uuid}/expenses/{id}	Altera uma despesa da proposta
DELETE	/crm/proposals/{proposal_uuid}/expenses/{id}	Remove uma despesa da proposta
GET	/crm/proposals/expenses/types	Lista os tipos de despesa (apoio)
GET	/crm/proposals/expenses/customers	Lista os fornecedores e clientes (apoio)

GET /crm/proposals/{proposal_uuid}/expenses

Lista as despesas da proposta.

Parâmetros de URL

Parâmetro	Descrição
search	Texto no nome do tipo de despesa ou do fornecedor/cliente
per_page, page	Paginação, conforme Convenções

Resposta (200): a lista de despesas, com o tipo, o fornecedor ou cliente, o valor, a marca de faturado, os comentários e os nomes de quem criou e de quem alterou.

POST /crm/proposals/{proposal_uuid}/expenses

Inclui uma despesa na proposta.

Corpo

Campo	Obrigatório	Tipo	Descrição
type_id	Sim	uuid	Tipo de despesa (uuid do tipo, da lista de tipos de despesa)
customer_vendor_id	Não	inteiro	Fornecedor ou cliente ligado à despesa
amount	Sim	número	Valor da despesa
billed	Não	booleano	Se a despesa está faturada. Padrão: falso
comments	Não	texto	Comentários sobre a despesa

Exemplo

curl -X POST https://api.pedagogo.app/crm/proposals/<uuid-da-proposta>/expenses \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{
    "type_id": "<uuid-do-tipo-de-despesa>",
    "amount": 250.00,
    "comments": "Material didático"
  }'

Resposta (201): a despesa incluída na proposta.

PUT /crm/proposals/{proposal_uuid}/expenses/{id}

Altera a despesa da proposta. Envie apenas os campos que mudam.

Corpo

Campo	Obrigatório	Tipo	Descrição
type_id	Não	uuid	Tipo de despesa
customer_vendor_id	Não	inteiro	Fornecedor ou cliente ligado à despesa

Resposta (200): a despesa alterada.

Consultar e apagar

GET /crm/proposals/{proposal_uuid}/expenses/{id} traz a despesa. DELETE /crm/proposals/{proposal_uuid}/expenses/{id} remove a despesa da proposta. Resposta (200).

GET /crm/proposals/expenses/types

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

GET /crm/proposals/expenses/customers

Lista os fornecedores e clientes, para o campo customer_vendor_id. Resposta (200): a lista de fornecedores e clientes.