API de Relatórios
2 endpoints · base https://api.comando.one/v1 · autenticação por chave cmd_live_…
/reports/aging-actionsAging de inadimplência com ações sugeridas
invoices:readfinance:read
Parâmetros, corpo, resposta e exemplo
Parâmetros
limit(query) | integer | |
min_overdue_days(query) | integer | |
include_shared(query) | boolean | Incluir clientes compartilhados |
customer_id(query) | string (uuid) | |
search(query) | string | |
company_id(query) | string (uuid) | Restringe a UMA empresa: a sua, ou a dona de um cliente compartilhado. Aplicado SOBRE o escopo permitido — nunca amplia acesso. |
query(query) | string | Apelido de 'search' — o código já aceitava os dois nomes; agora está documentado. |
Resposta 200 — Faturas em atraso + ações recomendadas
count | integer | |
limit | integer | |
min_overdue_days | integer | |
total_overdue_amount | number | Soma do SALDO em aberto (valor da fatura menos o que já foi pago) — o que ainda dá para cobrar. |
total_invoiced_amount | number | Soma do valor cheio das mesmas faturas, ignorando pagamentos parciais. |
actions | array de object |
Exemplo
curl -X GET "https://api.comando.one/v1/reports/aging-actions" \
-H "Authorization: Bearer cmd_live_SUA_CHAVE"/reports/cashflow-forecastPrevisão de fluxo de caixa
Projeta o caixa dia a dia pelas parcelas em aberto. `total_inflow`/`total_outflow` e a `timeline` usam o **saldo devedor** de cada parcela (valor menos o que já foi baixado) — é o que de fato entra e sai; `total_inflow_full`/`total_outflow_full` trazem o valor cheio. Parcela de fatura/compra **cancelada ou em rascunho** não entra: o título foi desfeito ou ainda não foi emitido.
finance:read
Parâmetros, corpo, resposta e exemplo
Parâmetros
horizon_days(query) | integer | |
opening_balance(query) | number | |
include_receivables(query) | boolean | |
include_payables(query) | boolean |
Resposta 200 — Projeção diária de caixa (timeline). Cada linha de `receivables_preview`/`payables_preview` traz `amount` (cheio), `paid_amount` e `outstanding_amount` (o que falta).
Sem corpo.
Exemplo
curl -X GET "https://api.comando.one/v1/reports/cashflow-forecast" \
-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