API de DDA

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

GET/dda-boletos

Listar boletos do DDA

dda: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)
`match_status`(query)	string	Situação do casamento com uma conta a pagar.
`supplier_id`(query)	string (uuid)	Fornecedor casado.
`overdue`(query)	"true" \| "false"	Somente vencidos (true).
`beneficiary_name`(query)	string	Beneficiário (busca parcial).
`due_from`(query)	string (date)	Vencimento a partir de.
`due_to`(query)	string (date)	Vencimento até.

Resposta 200 — Listagem paginada

`id`	string (uuid)
`supplier_id`	string (uuid)
`purchase_invoice_id`	string (uuid)
`barcode`	string
`beneficiary_name`	string
`beneficiary_document`	string
`payer_name`	string
`payer_document`	string
`bank_code`	string
`bank_name`	string
`amount`	number
`due_date`	string (date)
`overdue`	boolean
`match_status`	string
`match_method`	string
`match_confidence`	number
`error_message`	string
`triaged_at`	string (date-time)
`triage_note`	string
`card_statement_id`	string (uuid)
`first_seen_at`	string (date-time)
`last_seen_at`	string (date-time)
`created_at`	string (date-time)

Exemplo

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

GET/dda-boletos/{id}

Obter boleto de dda

dda:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Boleto de DDA

`id`	string (uuid)
`supplier_id`	string (uuid)
`purchase_invoice_id`	string (uuid)
`barcode`	string
`beneficiary_name`	string
`beneficiary_document`	string
`payer_name`	string
`payer_document`	string
`bank_code`	string
`bank_name`	string
`amount`	number
`due_date`	string (date)
`overdue`	boolean
`match_status`	string
`match_method`	string
`match_confidence`	number
`error_message`	string
`triaged_at`	string (date-time)
`triage_note`	string
`card_statement_id`	string (uuid)
`first_seen_at`	string (date-time)
`last_seen_at`	string (date-time)
`created_at`	string (date-time)

Exemplo

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

POST/dda-boletos/{id}/triage

Arquivar ou reabrir boleto do DDA

`ignore` arquiva; `reopen` devolve à fila. As ações que criam ou vinculam documento (conta a pagar, fatura de cartão) e o bloqueio de beneficiário ficam no aplicativo — registram quem fez, e uma chave de API não tem usuário.

dda:triage

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`action`obrigatório	"ignore" \| "reopen"
`note`	string	Observação da triagem (só em `ignore`).

Resposta 200 — Boleto triado

`id`	string (uuid)
`supplier_id`	string (uuid)
`purchase_invoice_id`	string (uuid)
`barcode`	string
`beneficiary_name`	string
`beneficiary_document`	string
`payer_name`	string
`payer_document`	string
`bank_code`	string
`bank_name`	string
`amount`	number
`due_date`	string (date)
`overdue`	boolean
`match_status`	string
`match_method`	string
`match_confidence`	number
`error_message`	string
`triaged_at`	string (date-time)
`triage_note`	string
`card_statement_id`	string (uuid)
`first_seen_at`	string (date-time)
`last_seen_at`	string (date-time)
`created_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/dda-boletos/{id}/triage" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"action":"<\"ignore\" | \"reopen\">"}'

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