Linha RM

Atalhos

Páginas filhas
  • API de Propostas
TítuloAPI de Validação de VPL
Endpointhttp://localhost:8051/api/imb/v1/Sales/{Cod Coligada}_{Número da Venda}/VPL
VerboGet

Parameters

no parameters
Descrição 

API que retornar o cálculo da análise da proposta do cliente comparando com a proposta padrão, entre os indicadores a VPL.

Baixe aqui a planilha excel com o cálculo

Para o  cálculo da VPL os campos da modalidade da proposta do TCGI → Portal do Imóveis

Ao validar a VPL  os campos da tabela  de venda e regras serão espelhados nas tabelas antigas do PI (XPIPROPOSTA, XPIPESSOA_PROPOSTA, XPIPROPOSTACOMPOSICAOHIST)

para manter o funcionamento dos relatórios e telas antigas

Modalidade

da Venda TCGI

image.png

Body 
No Body
RESPONSE 
{
    "codcoligada": 20,
    "numvenda": 1914,
    "valortabelaprecopadrao": "R$ 148.800,00",
    "valortabelaprecoproposta": "R$ 148.800,00",
    "valorfinanciadoatulizadopadrao": "R$ 263.867,02",
    "valorfinanciadoatulizadoproposta": "R$ 259.486,41",
    "valorpadraovpl": "R$ 187.885,42",
    "valorpropostavpl": "R$ 184.919,64",
    "percentualtma": "0,500000%",
    "percentualperdavplproposta": "158,000000%",
    "vrTabelaPrecoPadrao": 148800.0,
    "vrTabelaPrecoProposta": 148800.0,
    "vrFinanciadoAtulizadoPadrao": 263867.02,
    "vrFinanciadoAtulizadoProposta": 259486.41,
    "vrPadraoVpl": 187885.42,
    "vrPropostaVpl": 184919.64,
    "vrPercentualTma": 0.005,
    "vrPercentualPerdaVPLProposta": 1.58,
    "mensagem": "Proposta Reprovada",
    "log": "A taxa de perda do VPL da proposta 1,58% é superior ao máximo da(o) Modalidade 1,00%; ",
    "aprovada": false,
    "itensvpl": [
        {
            "nomeparametro": "Prazo de Financiamento",
            "valortabela": "160",
            "valorproposta": "160",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "% Captação a Vista",
            "valortabela": "10,00%",
            "valorproposta": "10,00%",
            "parametrodeaprovacao": "%Mín 1,00% - %Máx 50,00%"
        },
        {
            "nomeparametro": "% Captação até Entrega",
            "valortabela": "0,00%",
            "valorproposta": "0,00%",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "Nro Máx Meses Após Entrega",
            "valortabela": "285",
            "valorproposta": "285",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "% Captação até 1 mês Antes Entrega",
            "valortabela": "0,00%",
            "valorproposta": "0,00%",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "% Captação até Metade da proposta em relação a Entrega da Subunidade",
            "valortabela": "0,00%",
            "valorproposta": "0,00%",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "Valor m2",
            "valortabela": "R$ 586,37",
            "valorproposta": "R$ 576,64",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "Valor m2 VPL",
            "valortabela": "R$ 417,52",
            "valorproposta": "R$ 410,93",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "% Arrecadação",
            "valortabela": "77,33%",
            "valorproposta": "74,39%",
            "parametrodeaprovacao": "%Mín 50,00% - %Máx 100,00%"
        },
        {
            "nomeparametro": "% Desconto",
            "valortabela": "0,00%",
            "valorproposta": "1,66%",
            "parametrodeaprovacao": "%Máx 10,00%"
        },
        {
            "nomeparametro": "% Diferenca de Perda do VPL Modalidade",
            "valortabela": "0,00%",
            "valorproposta": "1,58%",
            "parametrodeaprovacao": "%Máx 1,00%"
        }
    ],
    "parcelaspadrao": [
        {
            "datavencimento": "2022-02-01T00:00:00",
            "valorparcela": 3720.0,
            "valorpresente": 3720.0
        },
        {
            "datavencimento": "2022-03-01T00:00:00",
            "valorparcela": 3720.0,
            "valorpresente": 3701.49
        }       
    ],
    "parcelasproposta": [
        {
            "datavencimento": "2022-02-01T00:00:00",
            "valorparcela": 3720.0,
            "valorpresente": 3720.0
        },
        {
            "datavencimento": "2022-03-01T00:00:00",
            "valorparcela": 3720.0,
            "valorpresente": 3701.49
        }    ]
}

Parâmetros:

  • codcoligada: coligada do empreendimento;
  • numvenda : Número da venda;
  • valortabelaprecopadrao:  Valor da Tabela de Preço Padrão da modalidade padrão
  • valortabelaprecoproposta: Valor da Tabela de Preço Padrão da modalidade padrão
  • valorfinanciadoatulizadopadrao: Valor sumarizado dos componentes de Entrada e Principal da modalidade padrão
  • valorfinanciadoatulizadoproposta: Valor sumarizado dos componentes de Entrada e Principal da modalidade proposta
  • valorpadraovpl: Valor sumarizado das parcelas da modalidade padrão - Inclui todos os valores de todos os componentes
  • valorpropostavpl: Valor sumarizado das parcelas da modalidade proposta- Inclui todos os valores de todos os componentes
  • percentualtma: Percentual da TMA - Taxa mínima de atratividade. A TMA é basicamente uma taxa de desconto que representa o retorno mínimo que o investidor deseja obter.
  • aprovada:  O VPL foi aprovado, true ou false
  • mensagem: Proposta AProvada ou Reprovada
  • log: Detalhe da mensagem quando for reprovada
  • itensvpl: 
    • nomeparametro: Prazo de Financiamento;
    • valortabela: Nro de Meses do componente principal;
    • valorproposta:  Nro de Meses do componente principal;

    • parametrodeaprovacao: Não valida para esse tipo de parâmetro;

    • nomeparametro: % Captação a Vista;
    • valortabela: Percentual do componente de entrada;
    • valorproposta:  Percentual do componente de entrada;
    • parametrodeaprovacao: Pode validar entre %mínimo  e %máximo, se configurado com valor na modalidade;
    • nomeparametro: % Captação até Entrega;
    • valortabela: Percentual do valor previsto para receber até a entrega;
    • valorproposta:  Percentual do valor previsto para receber até a entrega;
    • parametrodeaprovacao: Não valida para esse tipo de parâmetro;
    • nomeparametro: % Captação até 1 mês Antes Entrega;
    • valortabela: Percentual do valor previsto para receber até um mês antes da entrega;
    • valorproposta:  Percentual do valor previsto para receber até um mês antes da entrega;
    • parametrodeaprovacao: Não valida para esse tipo de parâmetro;
    • nomeparametro: % Captação até Metade da proposta em relação a Entrega da Subunidade;
    • valortabela: Percentual do valor previsto para receber até a metade do tempo que falta para entrega;
    • valorproposta:  Percentual do valor previsto para receber até a metade do tempo que falta para entrega;
    • parametrodeaprovacao: Não valida para esse tipo de parâmetro;
    • nomeparametro: Valor m2;
    • valortabela: Valor do m2 ;
    • valorproposta:  Valor do m2 ;
    • parametrodeaprovacao: Não valida para esse tipo de parâmetro;
    • nomeparametro: Valor m2 VPL;
    • valortabela: Valor do m2 com a VPL;
    • valorproposta:  Valor do m2 com a VPL;
    • parametrodeaprovacao: Não valida para esse tipo de parâmetro;
    • nomeparametro: % Arrecadação;
    • valortabela: (Valor do total financiado / Valor Tabela Preço) - 1;
    • valorproposta:  (Valor do total financiado proposta / Valor Tabela Preço Proposta) - 1;
    • parametrodeaprovacao: Pode validar entre %mínimo  e %máximo, se configurado com valor na modalidade;
    • nomeparametro: % Desconto;
    • valortabela: 1- (Valor do total original / Valor Tabela Preço) ;
    • valorproposta:  1- (Valor do total original proposta / Valor Tabela Preço Proposta) ;
    • parametrodeaprovacao: Pode validar entre %mínimo  e %máximo, se configurado com valor na modalidade;
    • nomeparametro: % Diferença do VPL;
    • valortabela: Percentual de diferença da VPL em reação ao padrão, nesse caso sempre será 0, pois é a coluna do padrão;
    • valorproposta:  Percentual de diferença da VPL em reação ao padrão,  se for maior que 0, está abaixo da tabela padrão e se for maior que 0, está acima da padrão;
    • parametrodeaprovacao: Pode validar entre %mínimo  e %máximo, se configurado com valor na modalidade;
TítuloAPI - Validação de Parametrização
Endpointhttp://localhost:8051/api/imb/v1/registrations/validate/pi/enterprises/{Cod Empreendimento}
VerboGET

Parameters

Não tem Parãmetros.
Descrição 

No preenchimento da proposta existem algumas validações ( parâmetro do financeiro sequência, corretor vinculado ao Cli/for, tabela de preço para unidade, modalidade de venda parametrizada) que ajudam o corretor a não continuar a proposta caso os mesmos já não estiverem já definidos. Essa API seria facilitadora para que o corretor não preencha cada campo para descobrir que falta parametrização padrão


Api geral - Valida todos Empreendimentos :  http://localhost:8051/api/imb/v1/registrations/validate/pi

Api por empreendimento : http://localhost:8051/api/imb/v1/registrations/validate/pi/enterprises/2057 Neste exemplo passando pelo Empreendimento 2057


Neste exemplo da API , passou pelo empreendimento 2057 e o Response mostrando as parametrizações que precisam sem feitas.

Parãmetros TCGINão tem Parãmetros no TCGI.
Body 
No Body
RESPONSE 
{
    "aprovado": false,
    "mensagemvalidacao": "Erro no Item Validar Pessoa PI Sincronizado com Cli/For.\r\n",
    "itensvalidados": [
        {
            "codcoligada": 0,
            "codempreendimento": 0,
            "aprovado": true,
            "itemvalidado": "Validar Tabela [XPISITUACAOPROPOSTA] com Dados no Portal de Imóveis.",
            "mensagemvalidacao": ""
        },
        {
            "codcoligada": 0,
            "codempreendimento": 0,
            "aprovado": true,
            "itemvalidado": "Validar Tabela [XPISITUACAOUNIDADE] com Dados no Portal de Imóveis.",
            "mensagemvalidacao": ""
        },
        {
            "codcoligada": 0,
            "codempreendimento": 0,
            "aprovado": true,
            "itemvalidado": "Validar Tabela [XPIPARAMETRO] com Dados no Portal de Imóveis.",
            "mensagemvalidacao": ""
        },
        {
            "codcoligada": 0,
            "codempreendimento": 0,
            "aprovado": true,
            "itemvalidado": "Validar Configuração de Forçar Proposta ",
            "mensagemvalidacao": ""
        },
        {
            "codcoligada": 0,
            "codempreendimento": 0,
            "aprovado": true,
            "itemvalidado": "Validar Venda Sequencial TCGI",
            "mensagemvalidacao": ""
        },
        {
            "codcoligada": 1,
            "codempreendimento": 2057,
            "aprovado": true,
            "itemvalidado": "Validar Código Sequencial Parâmetro Cli/For.",
            "mensagemvalidacao": ""
        },
        {
            "codcoligada": 1,
            "codempreendimento": 2057,
            "aprovado": true,
            "itemvalidado": "Validar Usuário PI Sincronizado com Cli/For.",
            "mensagemvalidacao": ""
        },
        {
            "codcoligada": 1,
            "codempreendimento": 2057,
            "aprovado": false,
            "itemvalidado": "Validar Pessoa PI Sincronizado com Cli/For.",
            "mensagemvalidacao": "A pessoa do PI [10-ADRIANO NOVO PVI]  do Tipo [Propesct] não está sincronizado com Cli/For da coligada [1]\r\n"
        },
        {
            "codcoligada": 1,
            "codempreendimento": 2057,
            "aprovado": true,
            "itemvalidado": "Validar Tabela de Preço Vinculado ao Empreendimento",
            "mensagemvalidacao": ""
        },
        {
            "codcoligada": 1,
            "codempreendimento": 2057,
            "aprovado": true,
            "itemvalidado": "Validar Modalidade de Venda Parametrizada e Vinculada ao Empreendimento",
            "mensagemvalidacao": ""
        },
        {
            "codcoligada": 1,
            "codempreendimento": 2057,
            "aprovado": true,
            "itemvalidado": "Validar Modalidade de Comissão Vinculada ao Empreendimento",
            "mensagemvalidacao": ""
        }
    ]
}



TítuloAPI de Solicitação de Aprovação de Proposta Reprovada
Endpointhttp://localhost:8051/api/imb/v1/sales/proposals/{Cod Coligada}_{Número da Venda}/approval
VerboPost

Parameters

KeyValue
note


Informe a mensagem de observação do corretor para o supervisor

urlInforme o endereço da web para realizar a aprovação da proposta
Descrição 

Api para solicitar aprovação de proposta de venda quando a mesma foi reprovada pela validação.

Ao solicitar a aprovação da proposta o sistema enviára um e-mail para o supervisor do corretor solicitadando a sua aprovação, desde que o parâmetro "Permite Forçar Proposta" esteja marcado.

Para o envio do e-mail os campos dos parâmetros do TCGI → Portal do Imóvel→ Porposta de Venda devem ser preenchidos 

Baixe aqui o modelo do corpo do e-mail

Parâmetros

do TCGI

Body 
No Body
RESPONSE 
No Response
TítuloAPI Aprovar Proposta Forçada
Endpointhttp://localhost:8051/api/imb/v1/sales/proposals/{Cod Coligada}_{Número da Venda}/forceapproval
VerboPost

Parameters

KeyValue
note

Informe a mensagem de observação do Supervisor para o Corretor

userldInforme Id do Superior vinculado ao Corretor da Proposta
Descrição 

Api para forçar a aprovação de uma Proposta reprovada, caso seja aprovada pelo Superior informado no cadastro dos parametros do Corretor.

Lembrando que o parâmetro no PI da Proposta ( Reprovada ) tem que estar marcada o parâmetro - Permite forçar proposta.

E-mail será enviado para Superior cadastrado configurado no cadastro do Corretor no Portal de Imóveis. 

Uma proposta que foi reprovada , o Corretor envia um e-mail para seu Supervisor , conforme API : API de Solicitação de Aprovação de Proposta Reprovada citada 

no exemplo acima , essa API força que uma proposta Reprovda possa se tornar APROVADA , fazendo que o e-mail possa ser enviado alterando a proposta de Reprovada para 

Aprovada.

Baixe TCGIRELPI0002 - Corpo de E-mail para Forçar Aprovação de Proposta.TotvsReport aqui 

Parâmetros

do TCGI

Body 
No Body
RESPONSE 
No Response
TítuloAPI - Inserir - Pessoas Adicionais
Endpointhttp://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteData
VerboPost

Parameters

Não tem Parãmetros.
Descrição 

Api para tratamento para criar um Fiador.

Tabela XPIPESSOA.TIPO

Incluído esses Típos de Fiadores.

5 = Procurador
6 = Procurador Cônjuge
7 = Representante Legal
8 = Fiador


No exemplo do Código Body - Inserindo um Fiador com código = 8 ( Fiador ) TIPO = 8

Cadastro de Pessoas Adicionais:

Contrato de Venda | Anexo | Pessoas Adicionais

Parãmetros TCGINão tem Parãmetros no TCGI.
Body 
[
 
{"ID":-1,
"NOME": "CLIENTE FIADOR 01",
"RAZAOSOCIAL": " CLIENTE FIADOR 01",
"CPFCNPJ": "46185793237",
"TELEFONE": "999999999",
"PAI": "PAI FIADOR 01",
"MAE": "MAE FIADOR 01",
"CONJUGE_NOME": "ESPOSA FIADOR 01",
"CONJUGE_CPF": "53976044610",
"TIPO": 8,
"TIPOPESSOA": 0,
"DATAHORACADASTRO":"2023-05-18T11:09:58.52-03:00"
}
]
RESPONSE 
{
    "messages": [],
    "length": 1,
    "data": {
        "id": "111",
        "RESTDS_TEMP_ID": 111,
        "ID_ERP": "1;001457",
        "COMUNHAODEBENS_ID": null,
        "EMPREENDIMENTO_ID": null,
        "ESTADOCIVIL_ID": null,
        "ESTANDEVENDA_ID": null,
        "MIDIA_ID": null,
        "MORADIA_ID": null,
        "PROFISSAO_ID": null,
        "SITUACAOPESSOA_ID": null,
        "TIPOIMOVEL_ID": null,
        "TIPOLOGIA_ID": null,
        "USUARIO_ID": null,
        "TIPO": 8,
        "TIPOPESSOA": 0,
        "DATAHORACADASTRO": "2023-05-18T11:09:58.52-03:00",
        "NOME": "CLIENTE FIADOR 01",
        "RAZAOSOCIAL": " CLIENTE FIADOR 01",
        "CPFCNPJ": "46185793237",
        "RGNUMERO": null,
        "RGORGAO": null,
        "RGUF": null,
        "INSCRICAOESTADUAL": null,
        "INSCRICAOMUNICIPAL": null,
        "TELEFONE": "999999999",
        "CELULAR": null,
        "FAX": null,
        "EMAIL": null,
        "SALT": null,
        "HASH": null,
        "LOGRADOUROCOBRANCA": null,
        "NUMEROCOBRANCA": null,
        "COMPLEMENTOCOBRANCA": null,
        "BAIRROCOBRANCA": null,
        "CIDADECOBRANCA": null,
        "UFCOBRANCA": null,
        "CEPCOBRANCA": null,
        "MESMOENDERECOCOBRANCA": null,
        "LOGRADOURO": null,
        "NUMERO": null,
        "COMPLEMENTO": null,
        "BAIRRO": null,
        "CIDADE": null,
        "UF": null,
        "CEP": null,
        "SEXO": null,
        "DATANASCIMENTO": null,
        "CEI": null,
        "NATURALIDADE": null,
        "NACIONALIDADE": null,
        "PAI": "PAI FIADOR 01",
        "MAE": "MAE FIADOR 01",
        "RENDA": null,
        "CARTORIOFIRMA": null,
        "LIVROREGISTRO": null,
        "FOLHAREGISTRO": null,
        "EMPRESA_NOME": null,
        "EMPRESA_LOGRADOURO": null,
        "EMPRESA_NUMERO": null,
        "EMPRESA_COMPLEMENTO": null,
        "EMPRESA_BAIRRO": null,
        "EMPRESA_CIDADE": null,
        "EMPRESA_UF": null,
        "EMPRESA_CEP": null,
        "EMPRESA_TELEFONE": null,
        "EMPRESA_FAX": null,
        "EMPRESA_RAMAL": null,
        "EMPRESA_DATAADMISSAO": null,
        "EMPRESA_CARGO": null,
        "CONJUGE_PROFISSAO_ID": null,
        "CONJUGE_NOME": "ESPOSA FIADOR 01",
        "CONJUGE_EMAIL": null,
        "CONJUGE_DATANASCIMENTO": null,
        "CONJUGE_CPF": "53976044610",
        "CONJUGE_RGNUMERO": null,
        "CONJUGE_RGORGAO": null,
        "CONJUGE_RGUF": null,
        "CONJUGE_SEXO": null,
        "CONJUGE_PAI": null,
        "CONJUGE_MAE": null,
        "CONJUGE_TELEFONE": null,
        "CONJUGE_CELULAR": null,
        "CONJUGE_NATURALIDADE": null,
        "CONJUGE_NACIONALIDADE": null,
        "CONJUGE_CARTORIOFIRMA": null,
        "CONJUGE_RENDA": null,
        "CONJUGE_EMPRESA_NOME": null,
        "CONJUGE_EMPRESA_CARGO": null,
        "CONJUGE_EMPRESA_DATAADMISSAO": null,
        "CONJUGE_EMPRESA_TELEFONE": null,
        "CONJUGE_EMPRESA_LOGRADOURO": null,
        "CONJUGE_EMPRESA_NUMERO": null,
        "CONJUGE_EMPRESA_COMPLEMENTO": null,
        "CONJUGE_EMPRESA_BAIRRO": null,
        "CONJUGE_EMPRESA_CIDADE": null,
        "CONJUGE_EMPRESA_UF": null,
        "CONJUGE_EMPRESA_CEP": null,
        "OBSERVACOES": null,
        "FAIXAVALORPRETENDIDO_ID": null,
        "FORMACONTATO_ID": null,
        "USUARIOCRIACAO_ID": null,
        "DATA_ULTIMA_INTERACAO": null,
        "IMPORTPARTICIPANTECAMP_ID": null,
        "PESSOA_NATURALIDADE_ID": null,
        "ID_CONJUGE_NATURALIDADE": null,
        "SITUACAOCADASTROPESSOA_ID": null,
        "MEX_NSS": null,
        "MEX_RFC": null,
        "MEX_CURP": null,
        "MEX_CONJUGE_NSS": null,
        "MEX_CONJUGE_RFC": null,
        "MEX_CONJUGE_CURP": null,
        "TEMPOMORADIA": null,
        "DATACASAMENTO": null,
        "RENDACOMPROMETIDA": null,
        "TIPORENDA_ID": null,
        "CREDITO_FINANCIAMENTO": null,
        "CREDITO_FGTS": null,
        "CREDITO_SUBSIDIO": null,
        "CREDITO_RECURSO_PROPRIO": null,
        "VALOR_PARCELA_APROVADA": null,
        "PRAZO_MAXIMO_FINANCIAMENTO": null,
        "TIPO_AMORTIZACAO": null,
        "VIGENCIA_AVALIACAO": null,
        "VALOR_RENDA_INFORMAL": null,
        "JSON_LEAD_RD": null,
        "SDR_ID": null,
        "CORRESPONDENTE_ID": null,
        "MOTIVO_REPROVACAO": null,
        "LEAD": null,
        "LEAD_POTENCIAL": null,
        "COD_INTEG_EXTERNO": null,
        "RD_UUID": null,
        "DATA_MUDANCA_SITUACAO": null,
        "DATA_CONSULTA_SERASA": null,
        "RESPOSTA_API_SERASA": null,
        "POSSUI_VENDA_ERP": null,
        "RECCREATEDBY": null,
        "RECCREATEDON": null,
        "RECMODIFIEDBY": null,
        "RECMODIFIEDON": null
    }
}
TítuloAPI - Associar Pessoa na Proposta
Endpointhttp://localhost:8051/api/imb/v1/sales/proposals/{Cod Coligada}_{Número da Venda}
VerboPut ou Post

Parameters

Não tem Parãmetros.
Descrição 

API para inserir a Pessoa cadastrada na API http://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteData em uma proposta no TCGI.


No BODY , informo :

[
{
"idcliente": 4,
"clienteprincipal": 1,
"pessoasadicionais": [{"idpessoa": 111,"tipopessoa": 8},
{"idpessoa": 112,"tipopessoa": 7}

]


IDPESSOA cadastrada na API Pessoas Adicionais com seu TIPO. 

Ao inserir uma Pessoa Adicional via API , retorna seu ID como mostra o cadastro da API acima.

Parãmetros TCGINão tem Parãmetros no TCGI.
Body 
{
    "codcoligada": 1,
    "idpropostapvi": 19,
    "idpropostavenda": 10013,
    "datavenda": "2023-03-20T00:00:00",
    "idmodalidade": 906,
    "numtabpreco": 144,
    "statuspvi": 1,
    "descricaostatuspvi": "Aprovada",
    "corletra": "#FFFFFF",
    "corfundo": "#5CB85C",
    "valorproposta": 500000.0000,
    "valortabelapreco": 500000.0000,
    "datacriacao": "2023-03-20T11:15:44.313",
    "dataalteracao": "2023-03-20T11:16:42",
    "diasdaproposta": "59 dia(s)",
    "diasdapropostaporextenso": "59 dia(s) 0 hora(s) 53 minuto(s)",
    "clientes": [
        {
            "idcliente": 4,
            "clienteprincipal": 1,
            "pessoasadicionais": [{"idpessoa": 111,"tipopessoa": 8},
                                  {"idpessoa": 112,"tipopessoa": 7}
            
            ]
        }
    ],
    "codempreendimento": 2057,
    "nomeempreendimento": "Emp Nova API Automação",
    "dataentrega": "2022-01-01T00:00:00",
    "codunidade": "1",
    "nomeunidade": "Bloco 01",
    "codsubunidade": "000005",
    "nomesubunidade": "Apto 000005",
    "nrovagas": 0,
    "areasubunidade": 180.0000,
    "idcorretorpvi": 1,
    "idusuariopropostapvi": 1,
    "idimobiliariapvi": 1,
    "nomecorretorpvi": "Corretor",
    "idsuperiorpvi": 2,
    "nomesuperiorpvi": "Superior",
    "idmidia": 1,
    "idmotivocompra": 1,
    "valordesconto": 0.0000,
    "propostaforcada": 0,
    "propostaforcadadata": "0001-01-01T00:00:00",
    "propostaforcadaobs": ""
}
RESPONSE 
{
    "codcoligada": 1,
    "idpropostapvi": 19,
    "idpropostavenda": 10013,
    "datavenda": "2023-03-20T00:00:00",
    "idmodalidade": 906,
    "numtabpreco": 144,
    "statuspvi": 1,
    "descricaostatuspvi": "Aprovada",
    "corletra": "#FFFFFF",
    "corfundo": "#5CB85C",
    "valorproposta": 500000.0000,
    "valortabelapreco": 500000.0000,
    "datacriacao": "2023-03-20T11:15:44.313",
    "dataalteracao": "2023-05-19T11:33:49",
    "diasdaproposta": "60 dia(s)",
    "diasdapropostaporextenso": "60 dia(s) 0 hora(s) 18 minuto(s)",
    "clientes": [
        {
            "idcliente": 4,
            "clienteprincipal": 1,
            "pessoasadicionais": [
                {
                    "idpessoa": 111,
                    "tipopessoa": 8
                },
                {
                    "idpessoa": 112,
                    "tipopessoa": 7
                }
            ]
        }
    ],
    "codempreendimento": 2057,
    "nomeempreendimento": "Emp Nova API Automação",
    "dataentrega": "2022-01-01T00:00:00",
    "codunidade": "1",
    "nomeunidade": "Bloco 01",
    "codsubunidade": "000005",
    "nomesubunidade": "Apto 000005",
    "nrovagas": 0,
    "areasubunidade": 180.0000,
    "idcorretorpvi": 1,
    "idimobiliariapvi": 1,
    "nomecorretorpvi": "Corretor",
    "idsuperiorpvi": 2,
    "nomesuperiorpvi": "Superior",
    "idmidia": 1,
    "idmotivocompra": 1,
    "valordesconto": 0.0000,
    "propostaforcada": 0,
    "propostaforcadadata": "0001-01-01T00:00:00",
    "propostaforcadaobs": ""
}
TítuloAPI de Usuário Portal de Imóveis - GET
Endpointhttp://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData
VerboGet

Parameters

No parameters
Descrição 

Utilizando esta API com o verbo Get, o sistema retorna a lista de usuários cadastrados na Tabela XPIUSUARIO do Portal de Imóveis.

Parâmetros

do TCGI


Body 
No Body
RESPONSE 
{
    "messages": [],
    "length": 1,
    "data": [
        {
            "id": "1",
            "RESTDS_TEMP_ID": 1,
            "ID_ERP": "1;01455",
            "ID_SUPERIOR": null,
            "GRUPOUSUARIO_ID": 1,
            "NOME": "mestre",
            "SOBRENOME": "totvs",
            "EMAIL": "[email protected]",
            "CELULAR": "3134940000",
            "SALT": "Ay3+rprtuHjBQjA3vAqlJn8SyfqYovB7",
            "HASH": "wsCmCTzMluub+Hls5oNDCc6O2zXevPBm",
            "RESERVAS": 3,
            "ATIVO": 1,
            "DATAHORACADASTRO": "2023-03-13T16:33:06-03:00",
            "DATAHORAULTIMOLOGIN": "2023-03-22T08:31:08.863-03:00",
            "DATAHORAALTERACAO": "2023-03-22T08:31:08.917-03:00",
            "PERGUNTAR_NOTIFICAR_SUPERIOR": 1,
            "LISTAS_DISPOSICAO": 2,
            "LISTAS_VISAO": 3,
            "PERCENTUAL_COMISSAO": 2.0000,
            "CRECI": null,
            "IMOBILIARIA_ID": null,
            "PODE_ATUALIZAR_SISTEMA": 1,
            "TIPOPESSOA": 1,
            "CPFCNPJ": "34360165510",
            "FORCAR_ALTERAR_SENHA": 0,
            "DATA_VIGENCIA_CRECI": null,
            "QTD_MAX_PROSPECTS": 0,
            "RECCREATEDBY": null,
            "RECCREATEDON": null,
            "RECMODIFIEDBY": null,
            "RECMODIFIEDON": null
        }
}
TítuloAPI de Usuário Portal de Imóveis - POST
Endpointhttp://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData
VerboPost

Parameters

No parameters

Descrição 

Utilizando esta API com o verbo Post, o sistema irá cadastrar o usuário do Portal de Imóveis alimentando as seguintes tabelas:

  • XPIUSUARIO: Tabelas que armazena os dados dos usuários do PI;
  • FCFO: Tabela (principal) que armazena os dados dos Clientes no financeiro;
  • XPESSOACONJUGE: Tabela que  armazena os dados do cônjuge dos clientes no TCGI; e
  • XCLIENTEPESSOAFISICA: Tabela que armazena os dados complementares dos clientes no TCGI;

Parâmetros

do TCGI


Body 
[
    {        
          "ID":-1,
         "NOME": "Itamar",         
         "SOBRENOME": "Morais",    
         "ID_SUPERIOR": 1,
         "GRUPOUSUARIO_ID": 1,
         "CPFCNPJ": "860.672.580-30",
         "celular": "999999999",         
          "EMAIL" : "[email protected]",         
         "TIPOPESSOA": 0
         
    }
]
RESPONSE 
{
    "messages": [],
    "length": 1,
    "data": {
        "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "999999999",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
        "RECCREATEDBY": null,
        "RECCREATEDON": null,
        "RECMODIFIEDBY": null,
        "RECMODIFIEDON": null
    }
}



TítuloAPI de Usuário Portal de Imóveis - PUT
Endpointhttp://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
VerboPut

Parameters

No parameters
Descrição 

Utilizando esta API com o verbo Put, o sistema irá atualizar os dados informados, para o usuário repassado na ID, na tabela XPIUSUARIO, que armazena os dados dos usuários do PI.

Ao utilizar este verbo é preciso informar todos os campos/tags do cadastro do usuário porque os campos que não forem informados serão setados como nulos.

Para atualizar somente um campo/tag, utilize o verbo Patch descrito mais abaixo.

Parâmetros

do TCGI


Body 
[
    {        
         "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "31934940000",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
    }
]
RESPONSE 
{
    "messages": [],
    "length": 1,
    "data": {
        "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "31934940000",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
        "RECCREATEDBY": null,
        "RECCREATEDON": null,
        "RECMODIFIEDBY": null,
        "RECMODIFIEDON": null
    }
}



TítuloAPI de Usuário Portal de Imóveis - PATCH
Endpointhttp://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
VerboPatch

Parameters

No parameters
Descrição 

Utilizando esta API com o verbo Patch, o sistema irá atualizar os dados informados, para o usuário repassado na ID, na tabela XPIUSUARIO, que armazena os dados dos usuários do PI.

Este verbo deve ser utilizado para atualizar os campos especificados, sem alterar o valor dos demais campos da tabela.

Parâmetros

do TCGI


Body 
[
    {        
         "id": "37",
        "CELULAR": "31934940000"
    }
]
RESPONSE 
{
    "messages": [],
    "length": 1,
    "data": {
        "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "31934940000",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
        "RECCREATEDBY": null,
        "RECCREATEDON": null,
        "RECMODIFIEDBY": null,
        "RECMODIFIEDON": null
    }
}
TítuloAPI de usuário Portal de Imóveis - DELETE
Endpointhttp://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
VerboDelete

Parameters

No parameters.
Descrição 

Utilizando esta API com o verbo Delete, o sistema irá excluir os dados do usuário repassado no ID, na tabela XPIUSUARIO.

No exemplo de resposta abaixo, excluímos o usuário de ID 37, criado nos exemplos acima:

http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/37

Parâmetros

do TCGI


Body 
No Body
RESPONSE 
{
    "messages": [],
    "length": 1,
    "data": {
        "id": "37",
        "RESTDS_TEMP_ID": 37,
        "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID": 1,
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "31934940000",
        "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "DATAHORAULTIMOLOGIN": null,
        "DATAHORAALTERACAO": null,
        "PERGUNTAR_NOTIFICAR_SUPERIOR": null,
        "LISTAS_DISPOSICAO": null,
        "LISTAS_VISAO": null,
        "PERCENTUAL_COMISSAO": null,
        "CRECI": null,
        "IMOBILIARIA_ID": null,
        "PODE_ATUALIZAR_SISTEMA": null,
        "TIPOPESSOA": 0,
        "CPFCNPJ": "86067258030",
        "FORCAR_ALTERAR_SENHA": null,
        "DATA_VIGENCIA_CRECI": null,
        "QTD_MAX_PROSPECTS": null,
        "RECCREATEDBY": "mestre",
        "RECCREATEDON": "2023-03-22T10:02:45-03:00",
        "RECMODIFIEDBY": "mestre",
        "RECMODIFIEDON": "2023-03-22T10:02:45-03:00"
    }
}







  • Sem rótulos