UniversidadeNovidadesPoliticasAtendimento

Grupo de Clientes

grupoCliente

Obter Listagem de Grupo de Cliente

get
/grupoCliente
Autorizações
AuthorizationstringObrigatório
Parâmetros de consulta
continuationTokenstringOpcional

Identificador da Paginação da Consulta

Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Respostas
200

OK

application/json
get
/grupoCliente
GET /cadastrosgerais/v10/grupoCliente HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "clienteAgrupador": 1,
      "ListaClienteAgrupado": [
        1
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar/Atualizar um Grupo de Cliente

put
/grupoCliente
Autorizações
AuthorizationstringObrigatório
Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Corpo
clienteAgrupadorintegerObrigatório

Código do Cliente Agrupador

ListaClienteAgrupadointeger[]Obrigatório

Clientes Agrupados

Respostas
200

OK

application/json
put
/grupoCliente
PUT /cadastrosgerais/v10/grupoCliente HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "clienteAgrupador": 1,
  "ListaClienteAgrupado": [
    1
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}
{
  "codEmpresa": 1,
  "codCliente": 1,
  "cpfCnpj": "text",
  "nome": "text",
  "codRepresentante": 1,
  "codRepresentante2": 1,
  "codRepresentante3": 1,
  "inscEstadual": "text",
  "inscSuframa": "text",
  "contatoCompras": "text",
  "situacao": 1,
  "nomeFantasia": "text",
  "codRamoAtividade": 1,
  "codSetorVenda": 1,
  "consumidorFinal": 0,
  "endereco": "text",
  "numero": "text",
  "complemento": "text",
  "bairro": "text",
  "cep": "text",
  "cidade": "text",
  "estado": "text",
  "codIbge": "text",
  "email": "text",
  "emailNfe": "text",
  "telefone": "text",
  "telefoneCobranca": "text",
  "fax": "text",
  "telexCelular": "text",
  "observacao": "text",
  "aliqIcms": "text",
  "percAliqICMS": 1,
  "valorLimiteCredito": 1,
  "valorMaiorAcumulo": 1,
  "dataMaiorFatura": "2025-11-28",
  "dataPrimeiraCompra": "2025-11-28",
  "dataCadastro": "2025-11-28",
  "valorTotalFaturado": 1,
  "prazoMedioVendas": "text",
  "clienteCentralizador": 1,
  "cnpjClienteCentralizador": "text",
  "codSubRamoAtiv": 1,
  "codBacen": 1,
  "enderecoEntrega": [
    {
      "sequencia": 1,
      "localEntrega": "text",
      "endereco": "text",
      "bairro": "text",
      "numero": "text",
      "cep": "text",
      "cidade": "text",
      "estado": "text",
      "complemento": "text",
      "cpfCnpjEntrega": "text",
      "inscEstadual": "text",
      "horario": "text",
      "telefone": "text",
      "email": "text"
    }
  ],
  "dadosCobranca": [
    {
      "codPortador": "text",
      "codTipoCobranca": "text",
      "codCondicaoPagamento": "text"
    }
  ],
  "clienteCompradorPrincipal": [
    {
      "nomeCompraPrincipal": "text",
      "cargoCompraPrincipal": "text",
      "hobbyCompraPrincipal": "text",
      "nascimentoCompraPrincipal": "2025-11-28",
      "familiaProdutoCompraPrincipal": "text",
      "emailCompraPrincipal": "text",
      "telefoneCompraPrincipal": "text",
      "faxCompraPrincipal": "text",
      "celularCompraPrincipal": "text"
    }
  ],
  "clienteCompradores": [
    {
      "sequenciaComprador": 1,
      "nomeComprador": "text",
      "cargoComprador": "text",
      "hobbyComprador": "text",
      "nascimentoComprador": "2025-11-28",
      "familiaProduto": "text",
      "emailComprador": "text",
      "telefoneComprador": "text",
      "faxComprador": "text",
      "celularComprador": "text",
      "numWhatsAppComprador": "text"
    }
  ],
  "informacoesComplementares": [
    {
      "codAtendente": "text",
      "nomeAtendente": "text"
    }
  ],
  "estruturaComercial": [
    {
      "mascara": "text"
    }
  ],
  "grupoComercial": [
    {
      "clienteAgrupador": 1,
      "clientesAgrupados": [
        {
          "clienteAgrupado": 1
        }
      ]
    }
  ],
  "grupoCNPJ": [
    {
      "clienteAgrupado": 1,
      "cnpjAgrupado": "text"
    }
  ],
  "lucroPresIRPJ": 0,
  "simplesNacional": 0,
  "clienteEquipContri": 0,
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obter um Grupo de Cliente

get
/grupoCliente/{id}
Autorizações
AuthorizationstringObrigatório
Parâmetros de rota
idstringObrigatório

Código do Grupo de Cliente

Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Respostas
200

OK

application/json
get
/grupoCliente/{id}
GET /cadastrosgerais/v10/grupoCliente/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "clienteAgrupador": 1,
  "ListaClienteAgrupado": [
    1
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Excluir um Grupo de Cliente

delete
/grupoCliente/{id}
Autorizações
AuthorizationstringObrigatório
Parâmetros de rota
idstringObrigatório

Código do Grupo de Cliente

Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa

Respostas
200

OK

delete
/grupoCliente/{id}
DELETE /cadastrosgerais/v10/grupoCliente/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo
AnteriorClientesPróximoFornecedor

Atualizado