openthorDocumentação

list_customers

Clientes (cadastro) · domínio Clientes · escopo mcp:customers

O que faz

Lista/pesquisa o cadastro de clientes ativos: nome, fantasia, documento (CGCENT), município, RCA principal, bloqueio. Filtre por cliente, RCA, rede, atividade ou município. Use para 'qual o cadastro do cliente X?'.

Exemplo de pergunta

qual o cadastro do cliente X?” — o assistente escolhe esta ferramenta sozinho; você não digita o nome dela.

Parâmetros

ParâmetroTipoObrigatórioPadrãoSignificado
customer_codeintegernão
rep_codeintegernão
network_codeintegernão
municipality_codeintegernão
limitinteger (1–1000)não100

O que você recebe

  • customer_code — Cliente (cód.)
  • name — Nome
  • trade_name — Nome fantasia
  • tax_id — CNPJ/CPF
  • municipality_name — Município
  • state — UF
  • rep_code — Vendedor (RCA)
  • is_blocked — Bloqueado

Cuidados ao ler o resultado

Leia antes de interpretar
  • Documento = CGCENT (CNPJ/CPF). Apenas cadastro ativo (DTEXCLUSAO nula).
  • rep_code = RCA principal (CODUSUR1); a carteira completa está em get_rep_portfolio.

Por trás da ferramenta

Esta ferramenta consulta o endpoint /v1/customers da API REST — as mesmas permissões e o mesmo recorte da sua credencial valem nos dois caminhos.