API de Fornecedores

Cadastro de fornecedores

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

GET/suppliers

Listar fornecedores

suppliers: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)
`search`(query)	string	Busca por nome, e-mail ou documento
`status`(query)	"ativo" \| "inativo"
`type`(query)	"fisica" \| "juridica" \| "estrangeira"

Resposta 200 — Listagem paginada

`id`	string (uuid)
`name`	string	Título / rótulo de exibição do fornecedor
`legal_name`	string \| null	Razão social (PJ) ou nome completo (PF/estrangeira)
`surname`	string \| null	Sobrenome (pessoa física)
`email`	string \| null
`phone`	string \| null
`document`	string \| null	CPF ou CNPJ
`type`	"fisica" \| "juridica" \| "estrangeira"	Natureza JURÍDICA do cadastro, não a categoria de atividade: fisica = pessoa física (CPF); juridica = pessoa jurídica (CNPJ), o que inclui empresas, órgãos públicos, prefeituras e a Receita Federal; estrangeira = sem CNPJ/CPF. Na dúvida, OMITA o campo — o padrão já cobre o caso comum.
`company_name`	string \| null
`trade_name`	string \| null
`state_registration`	string \| null
`municipal_registration`	string \| null
`payment_terms_label`	string \| null
`payment_terms_days`	integer \| null
`status`	"ativo" \| "inativo"
`notes`	string \| null
`pagarme_recipient_id`	string \| null	ID do recebedor Pagar.me (re_…) para split nativo. Criado pela aplicação.
`pagarme_kyc_status`	"pending" \| "registration" \| "approved" \| "refused" \| "suspended" \| "blocked" \| null	Status de KYC do recebedor Pagar.me.
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/suppliers

Criar fornecedor

suppliers:write

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`name`obrigatório	string	Título / rótulo de exibição. Se omitido, derivado de legal_name.
`legal_name`	string	Razão social (PJ) ou nome completo (PF/estrangeira)
`surname`	string	Sobrenome (pessoa física)
`email`	string
`phone`	string
`document`	string
`type`	"fisica" \| "juridica" \| "estrangeira"	Natureza JURÍDICA do cadastro, não a categoria de atividade: fisica = pessoa física (CPF); juridica = pessoa jurídica (CNPJ), o que inclui empresas, órgãos públicos, prefeituras e a Receita Federal; estrangeira = sem CNPJ/CPF. Na dúvida, OMITA o campo — o padrão já cobre o caso comum.
`company_name`	string
`trade_name`	string
`state_registration`	string
`municipal_registration`	string
`payment_terms_label`	string
`payment_terms_days`	integer
`status`	"ativo" \| "inativo"
`notes`	string

Resposta 201 — Fornecedor criado

`id`	string (uuid)
`name`	string	Título / rótulo de exibição do fornecedor
`legal_name`	string \| null	Razão social (PJ) ou nome completo (PF/estrangeira)
`surname`	string \| null	Sobrenome (pessoa física)
`email`	string \| null
`phone`	string \| null
`document`	string \| null	CPF ou CNPJ
`type`	"fisica" \| "juridica" \| "estrangeira"	Natureza JURÍDICA do cadastro, não a categoria de atividade: fisica = pessoa física (CPF); juridica = pessoa jurídica (CNPJ), o que inclui empresas, órgãos públicos, prefeituras e a Receita Federal; estrangeira = sem CNPJ/CPF. Na dúvida, OMITA o campo — o padrão já cobre o caso comum.
`company_name`	string \| null
`trade_name`	string \| null
`state_registration`	string \| null
`municipal_registration`	string \| null
`payment_terms_label`	string \| null
`payment_terms_days`	integer \| null
`status`	"ativo" \| "inativo"
`notes`	string \| null
`pagarme_recipient_id`	string \| null	ID do recebedor Pagar.me (re_…) para split nativo. Criado pela aplicação.
`pagarme_kyc_status`	"pending" \| "registration" \| "approved" \| "refused" \| "suspended" \| "blocked" \| null	Status de KYC do recebedor Pagar.me.
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

DELETE/suppliers/{id}

Excluir fornecedor

suppliers: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/suppliers/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

GET/suppliers/{id}

Obter fornecedor

suppliers:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Fornecedor

`id`	string (uuid)
`name`	string	Título / rótulo de exibição do fornecedor
`legal_name`	string \| null	Razão social (PJ) ou nome completo (PF/estrangeira)
`surname`	string \| null	Sobrenome (pessoa física)
`email`	string \| null
`phone`	string \| null
`document`	string \| null	CPF ou CNPJ
`type`	"fisica" \| "juridica" \| "estrangeira"	Natureza JURÍDICA do cadastro, não a categoria de atividade: fisica = pessoa física (CPF); juridica = pessoa jurídica (CNPJ), o que inclui empresas, órgãos públicos, prefeituras e a Receita Federal; estrangeira = sem CNPJ/CPF. Na dúvida, OMITA o campo — o padrão já cobre o caso comum.
`company_name`	string \| null
`trade_name`	string \| null
`state_registration`	string \| null
`municipal_registration`	string \| null
`payment_terms_label`	string \| null
`payment_terms_days`	integer \| null
`status`	"ativo" \| "inativo"
`notes`	string \| null
`pagarme_recipient_id`	string \| null	ID do recebedor Pagar.me (re_…) para split nativo. Criado pela aplicação.
`pagarme_kyc_status`	"pending" \| "registration" \| "approved" \| "refused" \| "suspended" \| "blocked" \| null	Status de KYC do recebedor Pagar.me.
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

PATCH/suppliers/{id}

Atualizar fornecedor

suppliers:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`name`obrigatório	string	Título / rótulo de exibição. Se omitido, derivado de legal_name.
`legal_name`	string	Razão social (PJ) ou nome completo (PF/estrangeira)
`surname`	string	Sobrenome (pessoa física)
`email`	string
`phone`	string
`document`	string
`type`	"fisica" \| "juridica" \| "estrangeira"	Natureza JURÍDICA do cadastro, não a categoria de atividade: fisica = pessoa física (CPF); juridica = pessoa jurídica (CNPJ), o que inclui empresas, órgãos públicos, prefeituras e a Receita Federal; estrangeira = sem CNPJ/CPF. Na dúvida, OMITA o campo — o padrão já cobre o caso comum.
`company_name`	string
`trade_name`	string
`state_registration`	string
`municipal_registration`	string
`payment_terms_label`	string
`payment_terms_days`	integer
`status`	"ativo" \| "inativo"
`notes`	string

Resposta 200 — Fornecedor atualizado

`id`	string (uuid)
`name`	string	Título / rótulo de exibição do fornecedor
`legal_name`	string \| null	Razão social (PJ) ou nome completo (PF/estrangeira)
`surname`	string \| null	Sobrenome (pessoa física)
`email`	string \| null
`phone`	string \| null
`document`	string \| null	CPF ou CNPJ
`type`	"fisica" \| "juridica" \| "estrangeira"	Natureza JURÍDICA do cadastro, não a categoria de atividade: fisica = pessoa física (CPF); juridica = pessoa jurídica (CNPJ), o que inclui empresas, órgãos públicos, prefeituras e a Receita Federal; estrangeira = sem CNPJ/CPF. Na dúvida, OMITA o campo — o padrão já cobre o caso comum.
`company_name`	string \| null
`trade_name`	string \| null
`state_registration`	string \| null
`municipal_registration`	string \| null
`payment_terms_label`	string \| null
`payment_terms_days`	integer \| null
`status`	"ativo" \| "inativo"
`notes`	string \| null
`pagarme_recipient_id`	string \| null	ID do recebedor Pagar.me (re_…) para split nativo. Criado pela aplicação.
`pagarme_kyc_status`	"pending" \| "registration" \| "approved" \| "refused" \| "suspended" \| "blocked" \| null	Status de KYC do recebedor Pagar.me.
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

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