# Grupo de Clientes grupoCliente ## GET /grupoCliente > Obter Listagem de Grupo de Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Clientes","description":"grupoCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"ListaGrupoCliente":{"type":"object","properties":{"continuationToken":{"type":"string","description":"Identificador da Paginação da Consulta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GrupoCliente"}}}},"GrupoCliente":{"required":["ListaClienteAgrupado","clienteAgrupador"],"type":"object","properties":{"clienteAgrupador":{"type":"integer","description":"Código do Cliente Agrupador"},"ListaClienteAgrupado":{"type":"array","description":"Clientes Agrupados","items":{"type":"integer"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente":{"get":{"tags":["Grupo de Clientes"],"summary":"Obter Listagem de Grupo de Cliente","operationId":"ObterGruposCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"continuationToken","in":"query","description":"Identificador da Paginação da Consulta","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListaGrupoCliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## PUT /grupoCliente > Cadastrar/Atualizar um Grupo de Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Clientes","description":"grupoCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"GrupoCliente":{"required":["ListaClienteAgrupado","clienteAgrupador"],"type":"object","properties":{"clienteAgrupador":{"type":"integer","description":"Código do Cliente Agrupador"},"ListaClienteAgrupado":{"type":"array","description":"Clientes Agrupados","items":{"type":"integer"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Cliente":{"type":"object","properties":{"codEmpresa":{"type":"integer","description":"Código da Empresa do Cliente"},"codCliente":{"type":"integer","description":"Código do Cliente"},"cpfCnpj":{"type":"string","description":"Código do CPF ou CNPJ do Cliente"},"nome":{"type":"string","description":"Nome do Cliente"},"codRepresentante":{"type":"integer","description":"Código do Primeiro Representante"},"codRepresentante2":{"type":"integer","description":"Código do Segundo Representante"},"codRepresentante3":{"type":"integer","description":"Código do Terceiro Representante"},"inscEstadual":{"type":"string","description":"Código da Inscrição Estadual do Representante"},"inscSuframa":{"type":"string","description":"Código da Inscrição Suframa Representante"},"contatoCompras":{"type":"string","description":"Contato de Compras do Cliente"},"situacao":{"type":"integer","description":"Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)","enum":[1,2,3,4]},"nomeFantasia":{"type":"string","description":"Nome Fantasia do Cliente"},"codRamoAtividade":{"type":"integer","description":"Código do Ramo de Atividade do Cliente"},"codSetorVenda":{"type":"integer","description":"Código do Setor de venda do Cliente"},"consumidorFinal":{"type":"integer","description":"Cliente é Consumidor Final? (0-Sim, 1-Não)","enum":[0,1]},"endereco":{"type":"string","description":"Endereço do Cliente"},"numero":{"type":"string","description":"Número do Endereço do Cliente"},"complemento":{"type":"string","description":"Complemento do Endereço do Cliente"},"bairro":{"type":"string","description":"Bairro do Cliente"},"cep":{"type":"string","description":"Código do CEP do Cliente"},"cidade":{"type":"string","description":"Cidade do Cliente"},"estado":{"type":"string","description":"Estado do Cliente"},"codIbge":{"type":"string","description":"Código do IBGE do Cliente"},"email":{"type":"string","description":"E-mail do Cliente"},"emailNfe":{"type":"string","description":"E-mail do Cliente para envio da Nota Fiscal Eletrônica"},"telefone":{"type":"string","description":"Telefone do Cliente"},"telefoneCobranca":{"type":"string","description":"Telefone de Cobrança do Cliente"},"fax":{"type":"string","description":"Fax do Cliente"},"telexCelular":{"type":"string","description":"Telefone Celular do Cliente"},"observacao":{"type":"string","description":"Observação do Cadastro do Cliente"},"aliqIcms":{"type":"string","description":"Aliquota de ICMS da UF do Cliente [Deprecado]"},"percAliqICMS":{"multipleOf":0.01,"type":"number","description":"Aliquota de ICMS da UF do Cliente"},"valorLimiteCredito":{"multipleOf":0.01,"type":"number","description":"Valor do Limite de Crédito do Cliente"},"valorMaiorAcumulo":{"type":"number","description":"Valor Maior Acumulado do Cliente"},"dataMaiorFatura":{"type":"string","description":"Data da Maior Fatura do Cliente","format":"date"},"dataPrimeiraCompra":{"type":"string","description":"Data da Primeira Compra do Cliente","format":"date"},"dataCadastro":{"type":"string","description":"Data do Cadastro do Cliente","format":"date"},"valorTotalFaturado":{"multipleOf":0.01,"type":"number","description":"Valor Total já Faturado do Cliente"},"prazoMedioVendas":{"type":"string","description":"Prazo médio de Vendas do Cliente"},"clienteCentralizador":{"type":"integer","description":"Código do Cliente Centralizador"},"cnpjClienteCentralizador":{"type":"string","description":"Código do CNPJ do Cliente Centralizador"},"codSubRamoAtiv":{"type":"integer","description":"Sub Ramo de Atividade"},"codBacen":{"type":"integer","description":"Código do Bacen"},"enderecoEntrega":{"type":"array","description":"Endereço de Entrega do Cliente","items":{"$ref":"#/components/schemas/ClienteEnderecoEntrega"}},"dadosCobranca":{"type":"array","description":"Dados de Cobrança do Cliente","items":{"$ref":"#/components/schemas/ClienteDadosCobranca"}},"clienteCompradorPrincipal":{"type":"array","description":"Dados do Comprador Principal do Cliente","items":{"$ref":"#/components/schemas/CompradorPrincipalCliente"}},"clienteCompradores":{"type":"array","description":"Contatos de Compra do Cliente","items":{"$ref":"#/components/schemas/CompradoresCliente"}},"informacoesComplementares":{"type":"array","description":"Informações Complementares do Cliente","items":{"$ref":"#/components/schemas/ClienteInfComplementares"}},"estruturaComercial":{"type":"array","description":"Estrutura Comercial do Cliente","items":{"$ref":"#/components/schemas/ClienteEstruturaComercial"}},"grupoComercial":{"type":"array","description":"Grupo Comercial do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoComercial"}},"grupoCNPJ":{"type":"array","description":"Grupo CNPJ do Cliente","items":{"$ref":"#/components/schemas/ListaGrupoCNPJ"}},"lucroPresIRPJ":{"type":"integer","description":"IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)","enum":[0,1]},"simplesNacional":{"type":"integer","description":"Cliente é do simples nacional? ( 0 - não / 1 - Sim)","enum":[0,1]},"clienteEquipContri":{"type":"integer","description":"Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)","enum":[0,1,2]},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"ClienteEnderecoEntrega":{"required":["bairro","cep","endereco","sequencia"],"type":"object","properties":{"sequencia":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Endereço de Entrega"},"localEntrega":{"maxLength":60,"type":"string","description":"Descrição do Local de Entrega"},"endereco":{"maxLength":60,"minLength":1,"type":"string","description":"Endereço de Entrega"},"bairro":{"maxLength":60,"minLength":1,"type":"string","description":"Bairro do Endereço de Entrega"},"numero":{"maxLength":10,"type":"string","description":"Número do Endereço de Entrega"},"cep":{"maxLength":8,"minLength":8,"type":"string","description":"Código do CEP do Endereço de Entrega"},"cidade":{"maxLength":60,"type":"string","description":"Cidade do Endereço de Entrega"},"estado":{"maxLength":2,"minLength":2,"type":"string","description":"Estado do Endereço de Entrega (SC / SP / RJ)"},"complemento":{"maxLength":60,"type":"string","description":"Complemento do Endereço de Entrega"},"cpfCnpjEntrega":{"maxLength":14,"type":"string","description":"Código do CPF ou CNPJ do Endereço de Entrega"},"inscEstadual":{"maxLength":18,"type":"string","description":"Inscrição Estadual do Endereço de Entrega"},"horario":{"maxLength":35,"type":"string","description":"Horário para Entrega"},"telefone":{"maxLength":20,"type":"string","description":"Telefone do Endereço de Entrega"},"email":{"maxLength":60,"type":"string","description":"E-mail do Endereço de Entrega"}}},"ClienteDadosCobranca":{"type":"object","properties":{"codPortador":{"maxLength":4,"type":"string","description":"Código do Portador"},"codTipoCobranca":{"maxLength":3,"type":"string","description":"Código do Tipo de Cobrança"},"codCondicaoPagamento":{"maxLength":3,"type":"string","description":"Código da Condição de Pagamento"}}},"CompradorPrincipalCliente":{"type":"object","properties":{"nomeCompraPrincipal":{"maxLength":35,"type":"string","description":"Nome do Comprador Principal"},"cargoCompraPrincipal":{"maxLength":40,"type":"string","description":"Cargo do Comprador Principal"},"hobbyCompraPrincipal":{"maxLength":30,"type":"string","description":"Hobby do Comprador Principal"},"nascimentoCompraPrincipal":{"type":"string","description":"Data Nascimento Comprador Principal (YYYY-MM-DD)","format":"date"},"familiaProdutoCompraPrincipal":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailCompraPrincipal":{"maxLength":60,"type":"string","description":"E-mail do Comprador Principal"},"telefoneCompraPrincipal":{"maxLength":60,"type":"string","description":"Telefone do Comprador Principal"},"faxCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador Principal"},"celularCompraPrincipal":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"}}},"CompradoresCliente":{"required":["sequenciaComprador"],"type":"object","properties":{"sequenciaComprador":{"maximum":99,"minimum":1,"type":"integer","description":"Sequencial do Comprador"},"nomeComprador":{"maxLength":35,"type":"string","description":"Nome do Comprador"},"cargoComprador":{"maxLength":40,"type":"string","description":"Cargo do Comprador"},"hobbyComprador":{"maxLength":30,"type":"string","description":"Hobby do Comprador"},"nascimentoComprador":{"type":"string","description":"Data Nascimento Comprador (YYYY-MM-DD)","format":"date"},"familiaProduto":{"maxLength":40,"type":"string","description":"Família de Produtos de Compra"},"emailComprador":{"maxLength":60,"type":"string","description":"E-mail do Comprador"},"telefoneComprador":{"maxLength":60,"type":"string","description":"Telefone do Comprador"},"faxComprador":{"maxLength":60,"type":"string","description":"Número do Fax do Comprador"},"celularComprador":{"maxLength":60,"type":"string","description":"Número do Celular do Comprador Principal"},"numWhatsAppComprador":{"maxLength":14,"type":"string","description":"Número Whatsapp do Comprador"}}},"ClienteInfComplementares":{"type":"object","properties":{"codAtendente":{"maxLength":4,"type":"string","description":"Código do Atendente"},"nomeAtendente":{"maxLength":60,"type":"string","description":"Nome do Atendente"}}},"ClienteEstruturaComercial":{"required":["mascara"],"type":"object","properties":{"mascara":{"maxLength":25,"type":"string","description":"Máscara da Estrutura Comercial"}}},"ListaGrupoComercial":{"type":"object","properties":{"clienteAgrupador":{"maximum":9999999,"type":"integer"},"clientesAgrupados":{"type":"array","items":{"$ref":"#/components/schemas/ListaClientesAgrupados"}}}},"ListaClientesAgrupados":{"type":"object","properties":{"clienteAgrupado":{"maximum":9999999,"type":"integer","description":"Código do Cliente Agrupado"}}},"ListaGrupoCNPJ":{"type":"object","properties":{"clienteAgrupado":{"type":"integer","description":"Código do Cliente Agrupado"},"cnpjAgrupado":{"type":"string","description":"CNPJ do Cliente Agrupado"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente":{"put":{"tags":["Grupo de Clientes"],"summary":"Cadastrar/Atualizar um Grupo de Cliente","operationId":"CadastrarAtualizarGrupoCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dados do grupo de Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrupoCliente"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## GET /grupoCliente/{id} > Obter um Grupo de Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Clientes","description":"grupoCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"GrupoCliente":{"required":["ListaClienteAgrupado","clienteAgrupador"],"type":"object","properties":{"clienteAgrupador":{"type":"integer","description":"Código do Cliente Agrupador"},"ListaClienteAgrupado":{"type":"array","description":"Clientes Agrupados","items":{"type":"integer"}},"dadosCustomizados":{"type":"array","items":{"$ref":"#/components/schemas/DadosCustomizados"}}}},"DadosCustomizados":{"required":["campo","valor"],"type":"object","properties":{"campo":{"type":"string"},"valor":{"type":"string"}}},"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente/{id}":{"get":{"tags":["Grupo de Clientes"],"summary":"Obter um Grupo de Cliente","operationId":"ObterGrupoCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Grupo de Cliente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrupoCliente"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` ## DELETE /grupoCliente/{id} > Excluir um Grupo de Cliente ```json {"openapi":"3.0.1","info":{"title":"Cadastros Gerais","version":"1.0"},"tags":[{"name":"Grupo de Clientes","description":"grupoCliente"}],"servers":[{"url":"https://localhost/cadastrosgerais/v10"},{"url":"http://localhost/cadastrosgerais/v10"}],"security":[{"csw_auth":[]}],"components":{"securitySchemes":{"csw_auth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Erro":{"type":"object","properties":{"mensagem":{"type":"string"}}}}},"paths":{"/grupoCliente/{id}":{"delete":{"tags":["Grupo de Clientes"],"summary":"Excluir um Grupo de Cliente","operationId":"ExcluirGrupoCliente","parameters":[{"name":"empresa","in":"header","description":"Código da Empresa","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Código do Grupo de Cliente","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Erro"}}}}},"429":{"description":"Too Many Requests","content":{}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://ajuda.consistem.com.br/consistem-api/consistem-erp-api/comercial/cadastros-gerais-v1.0/grupo-de-clientes.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.