API de Despesas

Despesas operacionais

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

GET/expenses

Listar despesas

expenses: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)	"pendente" \| "pago" \| "cancelado"
`supplier_id`(query)	string (uuid)
`category_id`(query)	string (uuid)
`expense_date_from`(query)	string (date)
`expense_date_to`(query)	string (date)
`sort_by`(query)	"amount" \| "expense_date" \| "due_date" \| "created_at" \| "updated_at"	Coluna de ordenação. Use com sort_order para responder 'as maiores' ou 'as mais recentes'.
`sort_order`(query)	"asc" \| "desc"	Direção da ordenação. Padrão: desc quando sort_by é informado.

Resposta 200 — Listagem paginada

`id`	string (uuid)
`supplier_id`	string (uuid)
`description`	string
`amount`	number
`expense_date`	string (date)
`payment_date`	string \| null (date)
`category_id`	string \| null (uuid)
`status`	"pendente" \| "pago" \| "cancelado"
`bank_account_id`	string \| null (uuid)
`payment_method_id`	string \| null (uuid)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/expenses

Criar despesa

expenses:write

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`supplier_id`obrigatório	string (uuid)
`description`obrigatório	string
`amount`obrigatório	number
`expense_date`obrigatório	string (date)
`payment_date`	string (date)
`category_id`	string (uuid)
`status`	"pendente" \| "pago" \| "cancelado"
`bank_account_id`	string (uuid)
`payment_method_id`	string (uuid)
`notes`	string
`attachment_ids`	array de string (uuid)	Ids de anexos já enviados que devem ser vinculados à despesa criada. É o fluxo 'lance esse imposto e anexe o PDF' numa chamada só.

Resposta 201 — Despesa criada

`id`	string (uuid)
`supplier_id`	string (uuid)
`description`	string
`amount`	number
`expense_date`	string (date)
`payment_date`	string \| null (date)
`category_id`	string \| null (uuid)
`status`	"pendente" \| "pago" \| "cancelado"
`bank_account_id`	string \| null (uuid)
`payment_method_id`	string \| null (uuid)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/expenses" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"supplier_id":"<string (uuid)>","description":"<string>","amount":"<number>","expense_date":"<string (date)>"}'

DELETE/expenses/{id}

Excluir despesa

expenses: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/expenses/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

GET/expenses/{id}

Obter despesa

expenses:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Despesa

`id`	string (uuid)
`supplier_id`	string (uuid)
`description`	string
`amount`	number
`expense_date`	string (date)
`payment_date`	string \| null (date)
`category_id`	string \| null (uuid)
`status`	"pendente" \| "pago" \| "cancelado"
`bank_account_id`	string \| null (uuid)
`payment_method_id`	string \| null (uuid)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

PATCH/expenses/{id}

Atualizar despesa

expenses:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`supplier_id`	string (uuid)	Troca o fornecedor. Precisa ser fornecedor desta empresa (404 se não for).
`description`	string
`amount`	number
`expense_date`	string (date)
`payment_date`	string \| null (date)
`category_id`	string \| null (uuid)
`status`	"pendente" \| "pago" \| "cancelado"
`bank_account_id`	string \| null (uuid)
`payment_method_id`	string \| null (uuid)
`notes`	string \| null
`attachment_ids`	array de string (uuid)	ACRESCENTA anexos já enviados à despesa (não substitui os atuais). Anexo que a despesa já tem é ignorado, então repetir a chamada não duplica. Id inexistente nesta empresa → 404, sem gravar nada.

Resposta 200 — Despesa atualizada

`id`	string (uuid)
`supplier_id`	string (uuid)
`description`	string
`amount`	number
`expense_date`	string (date)
`payment_date`	string \| null (date)
`category_id`	string \| null (uuid)
`status`	"pendente" \| "pago" \| "cancelado"
`bank_account_id`	string \| null (uuid)
`payment_method_id`	string \| null (uuid)
`notes`	string \| null
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X PATCH "https://api.comando.one/v1/expenses/{id}" \
  -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)Propostas (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