API de Recorrentes

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

GET/recurring-expenses

Listar despesas recorrentes

recurring: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)	string	Estado da regra (ativa, pausada…).
`supplier_id`(query)	string (uuid)	Fornecedor.
`frequency`(query)	string	Periodicidade.
`next_from`(query)	string (date)	Próxima geração a partir de.
`next_to`(query)	string (date)	Próxima geração até.

Resposta 200 — Listagem paginada

`id`	string (uuid)
`supplier_id`	string (uuid)
`description`	string
`amount`	number
`category_id`	string (uuid)
`bank_account_id`	string (uuid)
`payment_method_id`	string (uuid)
`frequency`	string
`start_date`	string (date)
`end_date`	string (date)
`next_generation_date`	string (date)
`status`	string
`notes`	string
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

GET/recurring-expenses/{id}

Obter despesa recorrente

recurring:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Despesa recorrente

`id`	string (uuid)
`supplier_id`	string (uuid)
`description`	string
`amount`	number
`category_id`	string (uuid)
`bank_account_id`	string (uuid)
`payment_method_id`	string (uuid)
`frequency`	string
`start_date`	string (date)
`end_date`	string (date)
`next_generation_date`	string (date)
`status`	string
`notes`	string
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

PATCH/recurring-expenses/{id}/status

Pausar ou retomar despesa recorrente

Só `ativo` ↔ `pausado`. Regra `finalizado` é terminal: não volta a gerar documentos, e reativar seria ressuscitar um ciclo encerrado — crie uma regra nova.

recurring:update

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

statusobrigatório "ativo" | "pausado"

Resposta 200 — Regra atualizada

`id`	string (uuid)
`supplier_id`	string (uuid)
`description`	string
`amount`	number
`category_id`	string (uuid)
`bank_account_id`	string (uuid)
`payment_method_id`	string (uuid)
`frequency`	string
`start_date`	string (date)
`end_date`	string (date)
`next_generation_date`	string (date)
`status`	string
`notes`	string
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X PATCH "https://api.comando.one/v1/recurring-expenses/{id}/status" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"status":"<\"ativo\" | \"pausado\">"}'

GET/recurring-purchase-invoices

Listar contas a pagar recorrentes

recurring: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)	string	Estado da regra.
`supplier_id`(query)	string (uuid)	Fornecedor.
`frequency`(query)	string	Periodicidade.
`next_from`(query)	string (date)	Próxima geração a partir de.
`next_to`(query)	string (date)	Próxima geração até.

Resposta 200 — Listagem paginada

`id`	string (uuid)
`supplier_id`	string (uuid)
`payment_condition_id`	string (uuid)
`payment_method_id`	string (uuid)
`supplier_payment_method_id`	string (uuid)
`frequency`	string
`start_date`	string (date)
`end_date`	string (date)
`next_generation_date`	string (date)
`status`	string
`notes`	string
`adjust_due_to_business_day`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

GET/recurring-purchase-invoices/{id}

Obter conta a pagar recorrente

recurring:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Conta a pagar recorrente

`id`	string (uuid)
`supplier_id`	string (uuid)
`payment_condition_id`	string (uuid)
`payment_method_id`	string (uuid)
`supplier_payment_method_id`	string (uuid)
`frequency`	string
`start_date`	string (date)
`end_date`	string (date)
`next_generation_date`	string (date)
`status`	string
`notes`	string
`adjust_due_to_business_day`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

PATCH/recurring-purchase-invoices/{id}/status

Pausar ou retomar conta a pagar recorrente

Só `ativo` ↔ `pausado`; `finalizado` é terminal.

recurring:update

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

statusobrigatório "ativo" | "pausado"

Resposta 200 — Regra atualizada

`id`	string (uuid)
`supplier_id`	string (uuid)
`payment_condition_id`	string (uuid)
`payment_method_id`	string (uuid)
`supplier_payment_method_id`	string (uuid)
`frequency`	string
`start_date`	string (date)
`end_date`	string (date)
`next_generation_date`	string (date)
`status`	string
`notes`	string
`adjust_due_to_business_day`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X PATCH "https://api.comando.one/v1/recurring-purchase-invoices/{id}/status" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"status":"<\"ativo\" | \"pausado\">"}'

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