v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Pré-cadastro

Lista os pré-cadastros com filtros e paginação

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Retorna a listagem geral de pré-cadastros com suporte a filtros e paginação. Filtros disponíveis: idprecadastro, documento, idcorrespondente, idempresacorrespondente, idimobiliaria, idcorretor. Paginação: pagina, limite.

get/v3/comercial/precadastro/listar

Query parameters

idprecadastrointeger

Filtrar por id do pré-cadastro

documentostring

Filtrar por documento do cliente

idcorrespondenteinteger

Filtrar por id do correspondente

idempresacorrespondenteinteger

Filtrar por id da empresa correspondente

idimobiliariainteger

Filtrar por id da imobiliária

idcorretorinteger

Filtrar por id do corretor

paginainteger

Número da página

limiteinteger

Limite de itens por página

Response

Listagem de pré-cadastros retornada com sucesso.

totalinteger

limitestring

paginastring

Example response

{
  "total": 7329,
  "precadastros": [
    {
      "idprecadastro": 193,
      "codigointerno": "123456",
      "empreendimento": {
        "id": 3,
        "nome": "Empreendimento X"
      },
      "unidade": {
        "id": 12345,
        "nome": "Unidade Y"
      },
      "imobiliaria": {
        "id": 2,
        "nome": "Imobiliária de Imóveis"
      },
      "corretor": {
        "id": 6017,
        "nome": "João dos Santos",
        "email": "joaodossantos@souexemplo.com"
      },
      "leads_associados": [
        {
          "idlead": 17745,
          "idsituacao": 17,
          "data_cad": "2021-04-19 11:45:43"
        }
      ],
      "valor_avaliacao": "500000.00",
      "valor_aprovado": "300000.00",
      "valor_subsidio": "17000.00",
      "valor_fgts": "20000.00",
      "valor_total": "337000.00",
      "valor_prestacao": "3000.00",
      "saldo_devedor": "163000.00",
      "prazo": "20/06/2022",
      "prazo_financiamento": "descrição prazo do financiamento",
      "tabela": "Tabela 1",
      "carta_credito": "Carta credito 1",
      "renda_cliente_principal": "5000.00",
      "renda_total": 7000,
      "vencimento_aprovacao": "20/06/2027",
      "idintencao_compra": 1,
      "intencao_compra": "alta",
      "usuario_aprovou": {
        "idusuario_aprovou": 144,
        "nome": "Usuário X"
      },
      "correspondente": {
        "idusuario": 10,
        "nome": "Correspondente X"
      },
      "empresa_correspondente": {
        "idempresa": 20,
        "nome": "Banco X"
      },
      "situacao": {
        "id": 12,
        "nome": "Novo"
      },
      "cliente": {
        "id": 1010,
        "nome": "Cliente X",
        "documento": "12345678912",
        "telefone": "+5599999999999",
        "email": "clientex10@exemplo.com",
        "data_nasc": "1990-01-01",
        "estado_civil": 4
      },
      "fator_social": [
        {
          "nome": "José da Silva",
          "cpf": "12345678912",
          "grau_parentesco": "pai",
          "pessoa_estrangeira": "N"
        }
      ],
      "associados": {
        "idpessoa": 1001,
        "tipo_associacao": "Fiador",
        "nome": "Associado X",
        "documento": "12345678912",
        "telefone": "+5599999999998",
        "email": "associadox10@exemplo.com",
        "data_nasc": "1990-01-01",
        "estado_civil": 4
      },
      "campos_adicionais": {
        "Coordenador": "José Aloísio"
      },
      "mensagens": {
        "idmensagem": 456,
        "mensagem": "Mensagem exemplo",
        "usuario_adm": "Usuário X",
        "imobiliaria": "Imobiliaria X",
        "correspondente": "Correspondente X",
        "corretor": "Corretor X",
        "data_cad": "2021-01-01 17:56:14"
      },
      "data_cad": "2020-10-01 08:10:00",
      "data_fim": "2021-01-01 22:00:00",
      "data_cancelamento": "2021-01-01 22:00:00",
      "link": "{URL}/{PAINEL}/comercial/precadastro/193/administrar"
    }
  ]
}