Grupo de Clientes

grupoCliente

Obter Listagem de Grupo de Cliente

get

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/grupoCliente

Autorizações

csw_auth

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

continuationTokenstringOpcional

Identificador da Paginação da Consulta

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/grupoCliente

HTTPcURLJavaScriptPython

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

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/grupoCliente

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

clienteAgrupadorintegerObrigatório

Código do Cliente Agrupador

ListaClienteAgrupadointeger[]Obrigatório

Clientes Agrupados

Respostas

200

OK

application/json

codEmpresaintegerOpcional

Código da Empresa do Cliente

codClienteintegerOpcional

Código do Cliente

cpfCnpjstringOpcional

Código do CPF ou CNPJ do Cliente

nomestringOpcional

Nome do Cliente

codRepresentanteintegerOpcional

Código do Primeiro Representante

codRepresentante2integerOpcional

Código do Segundo Representante

codRepresentante3integerOpcional

Código do Terceiro Representante

inscEstadualstringOpcional

Código da Inscrição Estadual do Representante

inscSuframastringOpcional

Código da Inscrição Suframa Representante

contatoComprasstringOpcional

Contato de Compras do Cliente

situacaointeger · enumOpcional

Situação do Cliente (1-Ativo, 2-Inativo, 3-Bloqueado, 4-Excluído)

Valores possíveis:

nomeFantasiastringOpcional

Nome Fantasia do Cliente

codRamoAtividadeintegerOpcional

Código do Ramo de Atividade do Cliente

codSetorVendaintegerOpcional

Código do Setor de venda do Cliente

consumidorFinalinteger · enumOpcional

Cliente é Consumidor Final? (0-Sim, 1-Não)

Valores possíveis:

enderecostringOpcional

Endereço do Cliente

numerostringOpcional

Número do Endereço do Cliente

complementostringOpcional

Complemento do Endereço do Cliente

bairrostringOpcional

Bairro do Cliente

cepstringOpcional

Código do CEP do Cliente

cidadestringOpcional

Cidade do Cliente

estadostringOpcional

Estado do Cliente

codIbgestringOpcional

Código do IBGE do Cliente

emailstringOpcional

E-mail do Cliente

emailNfestringOpcional

E-mail do Cliente para envio da Nota Fiscal Eletrônica

telefonestringOpcional

Telefone do Cliente

telefoneCobrancastringOpcional

Telefone de Cobrança do Cliente

faxstringOpcional

Fax do Cliente

telexCelularstringOpcional

Telefone Celular do Cliente

observacaostringOpcional

Observação do Cadastro do Cliente

aliqIcmsstringOpcional

Aliquota de ICMS da UF do Cliente [Deprecado]

percAliqICMSnumberOpcional

Aliquota de ICMS da UF do Cliente

valorLimiteCreditonumberOpcional

Valor do Limite de Crédito do Cliente

valorMaiorAcumulonumberOpcional

Valor Maior Acumulado do Cliente

dataMaiorFaturastring · dateOpcional

Data da Maior Fatura do Cliente

dataPrimeiraComprastring · dateOpcional

Data da Primeira Compra do Cliente

dataCadastrostring · dateOpcional

Data do Cadastro do Cliente

valorTotalFaturadonumberOpcional

Valor Total já Faturado do Cliente

prazoMedioVendasstringOpcional

Prazo médio de Vendas do Cliente

clienteCentralizadorintegerOpcional

Código do Cliente Centralizador

cnpjClienteCentralizadorstringOpcional

Código do CNPJ do Cliente Centralizador

codSubRamoAtivintegerOpcional

Sub Ramo de Atividade

codBacenintegerOpcional

Código do Bacen

lucroPresIRPJinteger · enumOpcional

IRPJ Lucro Presumido? ( 0 - não / 1 - Sim)

Valores possíveis:

simplesNacionalinteger · enumOpcional

Cliente é do simples nacional? ( 0 - não / 1 - Sim)

Valores possíveis:

clienteEquipContriinteger · enumOpcional

Cliente Equiparado (0-Nulo, 1-Isento, 2-IE do Cliente)

Valores possíveis:

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/grupoCliente

HTTPcURLJavaScriptPython

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": "2026-05-08",
  "dataPrimeiraCompra": "2026-05-08",
  "dataCadastro": "2026-05-08",
  "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": "2026-05-08",
      "familiaProdutoCompraPrincipal": "text",
      "emailCompraPrincipal": "text",
      "telefoneCompraPrincipal": "text",
      "faxCompraPrincipal": "text",
      "celularCompraPrincipal": "text"
    }
  ],
  "clienteCompradores": [
    {
      "sequenciaComprador": 1,
      "nomeComprador": "text",
      "cargoComprador": "text",
      "hobbyComprador": "text",
      "nascimentoComprador": "2026-05-08",
      "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

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/grupoCliente/{id}

Autorizações

csw_auth

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

clienteAgrupadorintegerObrigatório

Código do Cliente Agrupador

ListaClienteAgrupadointeger[]Obrigatório

Clientes Agrupados

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/grupoCliente/{id}

HTTPcURLJavaScriptPython

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

https://localhost/cadastrosgerais/v10http://localhost/cadastrosgerais/v10

/grupoCliente/{id}

Autorizações

csw_auth

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

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/grupoCliente/{id}

HTTPcURLJavaScriptPython

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

Sem conteúdo