API de Catálogos

Listagens de referência (naturezas, centros de custo, condições, unidades)

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

GET/cost-centers

Listar centros de custo

IDs usados em despesas (category_id).

expenses:readexpenses:writefinance: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)
`active`(query)	"true" \| "false"

Resposta 200 — Listagem paginada

`id`	string (uuid)
`name`	string
`active`	boolean
`color`	string \| null
`icon`	string \| null
`dre_group`	string \| null
`sort_order`	integer

Exemplo

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

POST/cost-centers

Criar centro de custo

finance:write

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`name`obrigatório	string
`color`	string
`icon`	string
`dre_group`	string
`sort_order`	integer
`active`	boolean

Resposta 201 — Centro de custo criado

`id`	string (uuid)
`name`	string
`active`	boolean
`color`	string \| null
`icon`	string \| null
`dre_group`	string \| null
`sort_order`	integer

Exemplo

curl -X POST "https://api.comando.one/v1/cost-centers" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"name":"<string>"}'

DELETE/cost-centers/{id}

Excluir centro de custo

finance:delete

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 204 — Excluído

Sem corpo.

Exemplo

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

PATCH/cost-centers/{id}

Atualizar centro de custo

finance:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`name`	string
`color`	string
`icon`	string
`dre_group`	string
`sort_order`	integer
`active`	boolean

Resposta 200 — Atualizado

`id`	string (uuid)
`name`	string
`active`	boolean
`color`	string \| null
`icon`	string \| null
`dre_group`	string \| null
`sort_order`	integer

Exemplo

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

GET/finance/natures

Listar naturezas financeiras

IDs usados em POST /v1/finance/movements (nature_id).

finance:readfinance:write

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)
`is_active`(query)	"true" \| "false"
`direction`(query)	"credit" \| "debit" \| "both"

Resposta 200 — Listagem paginada

`id`	string (uuid)
`code`	string
`name`	string
`description`	string \| null
`allowed_direction`	"credit" \| "debit" \| "both"
`is_active`	boolean
`sort_order`	integer

Exemplo

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

GET/payment-conditions

Listar condições de pagamento

invoices:readcontracts:readinvoices:createcontracts:write

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)
`active`(query)	"true" \| "false"

Resposta 200 — Listagem paginada

`id`	string (uuid)
`name`	string
`active`	boolean
`installments`	array de object	[{sequence, label, days, percentage}]

Exemplo

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

GET/service-units

Listar unidades de serviço

services:readservices:write

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)

Resposta 200 — Listagem paginada

`id`	string (uuid)
`name`	string

Exemplo

curl -X GET "https://api.comando.one/v1/service-units" \
  -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)Propostas (6)NFS-e (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