API de Propostas

Propostas comerciais

6 endpoints · base https://api.comando.one/v1 · autenticação por chave cmd_live_…

GET/proposals

Listar propostas

proposals:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

`page`(query)	integer	Número da página (default: 1)
`per_page`(query)	integer	Itens por página (default: 20, máx: 100)
`status`(query)	"rascunho" \| "enviada" \| "aceita" \| "recusada" \| "cancelada" \| "faturada"	Filtrar por status
`customer_id`(query)	string (uuid)	Filtrar por cliente

Resposta 200 — Listagem paginada

`id`	string (uuid)
`customer_id`	string (uuid)
`customers`	object
`status`	"rascunho" \| "enviada" \| "aceita" \| "recusada" \| "cancelada" \| "faturada"
`total_amount`	number
`valid_until`	string \| null (date)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X GET "https://api.comando.one/v1/proposals" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

POST/proposals

Criar proposta

proposals:write

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`customer_id`obrigatório	string (uuid)
`status`	"rascunho" \| "enviada" \| "aceita" \| "recusada" \| "cancelada"
`total_amount`	number
`valid_until`	string (date)
`notes`	string

Resposta 201 — Proposta criada

`id`	string (uuid)
`customer_id`	string (uuid)
`customers`	object
`status`	"rascunho" \| "enviada" \| "aceita" \| "recusada" \| "cancelada" \| "faturada"
`total_amount`	number
`valid_until`	string \| null (date)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/proposals" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"customer_id":"<string (uuid)>"}'

DELETE/proposals/{id}

Excluir proposta

proposals:delete

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 204 — Excluída

Sem corpo.

Exemplo

curl -X DELETE "https://api.comando.one/v1/proposals/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

GET/proposals/{id}

Obter proposta

proposals:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Proposta com itens

`id`	string (uuid)
`customer_id`	string (uuid)
`customers`	object
`status`	"rascunho" \| "enviada" \| "aceita" \| "recusada" \| "cancelada" \| "faturada"
`total_amount`	number
`valid_until`	string \| null (date)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)
`proposal_items`	array de ProposalItem

Exemplo

curl -X GET "https://api.comando.one/v1/proposals/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

PATCH/proposals/{id}

Atualizar proposta

proposals:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`customer_id`	string (uuid)	Troca o cliente da proposta. Precisa ser cliente desta empresa (404 se não for).
`status`	"rascunho" \| "enviada" \| "aceita" \| "recusada" \| "cancelada"
`total_amount`	number
`valid_until`	string \| null (date)
`notes`	string \| null

Resposta 200 — Proposta atualizada

`id`	string (uuid)
`customer_id`	string (uuid)
`customers`	object
`status`	"rascunho" \| "enviada" \| "aceita" \| "recusada" \| "cancelada" \| "faturada"
`total_amount`	number
`valid_until`	string \| null (date)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X PATCH "https://api.comando.one/v1/proposals/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

POST/proposals/{id}/send

Enviar proposta

Apenas MUDA O STATUS da proposta para 'enviada'. NÃO dispara e-mail — não existe envio de proposta por e-mail no sistema (conferido: email_schedules só tem invoice e charge). Depois de chamar, não afirme ao usuário que a proposta foi enviada ao cliente.

proposals:send

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Proposta enviada

`id`	string (uuid)
`customer_id`	string (uuid)
`customers`	object
`status`	"rascunho" \| "enviada" \| "aceita" \| "recusada" \| "cancelada" \| "faturada"
`total_amount`	number
`valid_until`	string \| null (date)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/proposals/{id}/send" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

Início rápido, autenticação, SDK, servidor MCP e o playground para testar sem escrever código estão na documentação completa. A especificação em OpenAPI está em api.comando.one/openapi.json.

Outros recursos da API

Clientes (16)Contratos (13)Faturas (12)Webhooks (12)Serviços (9)Split de Pagamentos (9)Catálogos (7)NFS-e (6)

Ou deixe a IA usar a API por você

O servidor MCP expõe estes mesmos recursos ao ChatGPT, Claude ou Gemini — com OAuth, sem chave de API.

Conectar um assistente