Sign in
Cliente

Retorna a lista de clientes

Retorno JSON da lista de clientes do convênio (pessoas físicas e/ou jurídicas), com filtros por tipo de pessoa, tipo de relacionamento, período de inclusão e período de última alteração. O período de última alteração permite carga incremental.

get/Cliente/RetornarClientes

Query parameters

numeroPaginainteger required

Usado para paginação, enviar o nº da página atual (1 para a primeira)

numeroRegistrosinteger required

Nº de registros para retorno, máximo 20

tipoPessoainteger

Informe 1-Jurídica, 2-Física ou 0 para ambos

tipoRelacionamentostring string

Códigos dos tipos de relacionamento separados por vírgula: 1-Lead, 2-Locador, 3-Locatário, 4-Fiador, 5-Síndico, 6-Proprietário, 7-Comprador, 8-Administradora condomínio, 9-Porteiro, 10-Zelador, 11-Parceiro, 12-Prestador serviço, 13-Fornecedor. Não informar para todos

dataInclusaoIniciostring string

Data inicial do período de inclusão do cliente no formato (dd/MM/yyyy)

dataInclusaoFimstring string

Data final do período de inclusão do cliente no formato (dd/MM/yyyy)

dataHoraInicialUltimaAlteracaostring string

Data/hora inicial da última alteração no formato (dd/MM/yyyy HH:mm:ss)

dataHoraFinalUltimaAlteracaostring string

Data/hora final da última alteração no formato (dd/MM/yyyy HH:mm:ss)

ordenacaointeger

Informe 0-Data/hora alteração, 1-Tipo, 2-Código, 3-Código auxiliar, 4-CPF/CNPJ, 5-Nome, 6-E-mail, 7-Telefone, 8-Classificação, 9-Nome fantasia. Envie o valor negativo para ordem decrescente. Não informar = por código

Response

Dados retornados com sucesso

quantidadeinteger

Example response

{
  "lista": [
    {
      "tipo": "string",
      "nome": "string",
      "fantasia": "string",
      "cpfoucnpj": "string",
      "datanascimento": "string",
      "datafundacao": "string",
      "sexo": "string",
      "estadocivil": "string",
      "naturalidade": "string",
      "nacionalidade": "string",
      "profissao": "string",
      "cargo": "string",
      "localtrabalho": "string",
      "conjuge": "string",
      "filiacaopai": "string",
      "filiacaomae": "string",
      "numerofilhos": "string",
      "facebook": "string",
      "linkedin": "string",
      "instagram": "string",
      "datainclusao": "string",
      "dataultimaalteracao": "string",
      "telefones": [
        {
          "tipo": "string",
          "numero": "string"
        }
      ],
      "emails": [
        {
          "tipo": "string",
          "email": "string"
        }
      ],
      "enderecos": [
        {
          "tipo": "string",
          "endereco": "string",
          "bairro": "string",
          "cidade": "string",
          "estado": "string",
          "cep": "string"
        }
      ],
      "documentos": [
        {
          "tipo": "string",
          "numero": "string",
          "dataemissao": "string",
          "orgao": "string"
        }
      ]
    }
  ]
}

Changes