Documentação da API

API de Conciliação

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

GET/reconciliation/entries

Listar lançamentos do extrato

reconciliation:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

page(query)integerNúmero da página (default: 1)
per_page(query)integerItens por página (default: 20, máx: 100)
bank_account_id(query)string (uuid)Conta bancária.
entry_type(query)stringEntrada ou saída.
reconciliation_period_id(query)string (uuid)Período de conciliação.
is_ignored(query)"true" | "false"Somente ignorados (true) ou não ignorados (false).
description(query)stringDescrição (busca parcial).
date_from(query)string (date)Data do lançamento a partir de.
date_to(query)string (date)Data do lançamento até.

Resposta 200 — Listagem paginada

idstring (uuid)
bank_account_idstring (uuid)
entry_datestring (date)
amountnumber
entry_typestring
operation_typestring
transaction_typestring
descriptionstring
balancenumber
external_idstring (uuid)
is_ignoredboolean
reconciliation_period_idstring (uuid)
card_statement_idstring (uuid)
end_to_end_idstring (uuid)
counterparty_namestring
counterparty_documentstring
created_atstring (date-time)

Exemplo

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

Obter lançamento de extrato

reconciliation:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path)string (uuid)

Resposta 200 — Lançamento de extrato

idstring (uuid)
bank_account_idstring (uuid)
entry_datestring (date)
amountnumber
entry_typestring
operation_typestring
transaction_typestring
descriptionstring
balancenumber
external_idstring (uuid)
is_ignoredboolean
reconciliation_period_idstring (uuid)
card_statement_idstring (uuid)
end_to_end_idstring (uuid)
counterparty_namestring
counterparty_documentstring
created_atstring (date-time)

Exemplo

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

Conciliar um lançamento do extrato

Concilia pela mesma rotina que a tela usa. As recusas vêm de lá e são específicas: período fechado, lançamento ignorado, lançamento já conciliado, e a direção do dinheiro por ação (recebimento só resolve entrada; despesa e pagamento a fornecedor, só saída). Omitindo `period_id`, usa o período do lançamento ou o período ABERTO da conta. Criar REGRA de automação junto não é exposto: é outra decisão e fica no aplicativo.

reconciliation:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path)string (uuid)

Corpo (JSON)

actionobrigatório"match_existing" | "create_payment_from_customer_charge" | "create_supplier_payment_from_purchase_charge" | "create_expense" | "create_financial_movement"
period_idstring (uuid)Opcional: o período. Omitido, resolve sozinho.
target_kind"existing_payment" | "existing_supplier_payment" | "existing_expense" | "existing_split_payout"Só em `match_existing`. O destino precisa existir nesta empresa.
target_idstring (uuid)Só em `match_existing`.
payloadobjectCampos da ação (ex.: `supplier_id` e `category_id` em `create_expense`; `charge_id` nas que partem de uma parcela).

Resposta 201 — Conciliado

idstring (uuid)
company_idstring (uuid)
reconciliation_period_idstring (uuid)
bank_statement_entry_idstring (uuid)
ledger_originstring
ledger_origin_idstring (uuid)
match_typestring
created_ledger_originstring
created_ledger_origin_idstring (uuid)
matched_atstring (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/reconciliation/entries/{id}/resolve" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"action":"<\"match_existing\" | \"create_payment_from_customer_charge\" | \"create_supplier_payment_from_purchase_charge\" | \"create_expense\" | \"create_financial_movement\">"}'
DELETE/reconciliation/matches/{id}

Desfazer uma conciliação

Desconcilia o lançamento, pela mesma rotina que o botão da tela usa. CONCILIAR não é exposto na API: depende de ação/alvo/payload e merece desenho próprio.

reconciliation:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path)string (uuid)

Resposta 200 — Desconciliado

okboolean
match_idstring (uuid)
desconciliadoboolean

Exemplo

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

Listar períodos de conciliação

reconciliation:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

page(query)integerNúmero da página (default: 1)
per_page(query)integerItens por página (default: 20, máx: 100)
bank_account_id(query)string (uuid)Conta bancária.
status(query)stringEstado do período (open, closed…).

Resposta 200 — Listagem paginada

idstring (uuid)
bank_account_idstring (uuid)
start_datestring (date)
end_datestring (date)
statusstring
opening_balancenumber
closing_balancenumber
notesstring
closed_atstring (date-time)
created_atstring (date-time)
updated_atstring (date-time)

Exemplo

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

Obter período de conciliação

reconciliation:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path)string (uuid)

Resposta 200 — Período de conciliação

idstring (uuid)
bank_account_idstring (uuid)
start_datestring (date)
end_datestring (date)
statusstring
opening_balancenumber
closing_balancenumber
notesstring
closed_atstring (date-time)
created_atstring (date-time)
updated_atstring (date-time)

Exemplo

curl -X GET "https://api.comando.one/v1/reconciliation/periods/{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

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