v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Pré-cadastro

Retorna o Pré-cadastro

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

A interface viabiliza a consulta de pré-cadastro. A consulta é realizada através dos dados enviados na URL, podendo conter idprecadastro ou documento do cliente, podendo também passar o limite e a página por parâmetro. A requisição retorna os dados do pré-cadastro caso seja especificado um idprecadastro ou documento do cliente, caso não, retorna todos os pré-cadastros.

get/v1/comercial/precadastro/{idPrecadastroOuDocumento}

Path parameters

idPrecadastroOuDocumentostring required

Id do pré-cadastro ou documento do cliente

Query parameters

limiteinteger

Limite de itens exibido por página

Example:30
paginainteger

Quantidade de páginas para exibir os dados

Example:1

Headers

emailstring required
Example:email@email.com
tokenstring required
Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Response

Operação realizada 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"
    }
  ]
}