Histórico da Página

Expandir

title	API de Validação de VPL

Título	API de Validação de VPL
Endpoint	http://localhost:8051/api/imb/v1/Sales/{Cod Coligada}_{Número da Venda}/VPL
Verbo	Get
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

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "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
        }    ]
}

Expandir

title	Parâmetros do Response

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;

Expandir

title	API de Solicitação de Aprovação de Proposta Reprovada- Validação de Parametrização

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

Título	API de Solicitação de Aprovação de Proposta Reprovada- Validação de Parametrização
Endpoint	http://localhost:8051/api/imb/v1/registrations/validate/salespi/proposalsenterprises/{Cod Coligada}_{Número da Venda}/approvalEmpreendimento}
Verbo	PostGET
Parameters
Key	Value
note
url	Informe 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
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 TCGI	Não tem Parãmetros no TCGI.	Parâmetros do TCGI	Image Removed

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

No Response

Expandir

title	API Aprovar Proposta Forçada

Título

API Aprovar Proposta Forçada

Endpoint

http://localhost:8051/api/imb/v1/sales/proposals/{Cod Coligada}_{Número da Venda}/forceapproval

Verbo

Post

Parameters

Key	Value
note	Informe a mensagem de observação do Supervisor para o Corretor
userld	Informe 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

Image Removed

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

No Response

Expandir

title	API - Inserir - Pessoas Adicionais

TítuloAPI - Inserir - Pessoas AdicionaisEndpointhttp://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteDataVerboPost

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.

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

[
 
{"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"
}
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "length": 1,
    "data": {
{
    "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,
            "iditemvalidado": "111",
Validar Configuração de Forçar Proposta ",
   "RESTDS_TEMP_ID": 111,
        "ID_ERPmensagemvalidacao": "1;001457",
        "COMUNHAODEBENS_ID": null,
},
        {
   "EMPREENDIMENTO_ID": null,
        "ESTADOCIVIL_IDcodcoligada": null0,
            "ESTANDEVENDA_IDcodempreendimento": null0,
            "MIDIA_IDaprovado": nulltrue,
        "MORADIA_ID    "itemvalidado": null,
"Validar Venda    Sequencial TCGI",
   "PROFISSAO_ID": null,
        "SITUACAOPESSOA_IDmensagemvalidacao": null,""
        "TIPOIMOVEL_ID": null},
        {
   "TIPOLOGIA_ID": null,
        "USUARIO_IDcodcoligada": null1,
            "TIPOcodempreendimento": 82057,
            "TIPOPESSOAaprovado": 0true,
            "DATAHORACADASTROitemvalidado": "2023-05-18T11:09:58.52-03:00Validar Código Sequencial Parâmetro Cli/For.",
            "NOMEmensagemvalidacao": "CLIENTE FIADOR 01",
        "RAZAOSOCIAL": " CLIENTE FIADOR 01",
},
         {
   "CPFCNPJ": "46185793237",
        "RGNUMEROcodcoligada": null1,
            "RGORGAOcodempreendimento": null2057,
            "RGUFaprovado": nulltrue,
            "INSCRICAOESTADUALitemvalidado": null,
"Validar Usuário PI Sincronizado     "INSCRICAOMUNICIPAL": nullcom Cli/For.",
            "TELEFONEmensagemvalidacao": "999999999",
        "CELULAR": null},
        "FAX": null,{
        "EMAIL": null,
        "SALTcodcoligada": null1,
        "HASH": null,
        "LOGRADOUROCOBRANCAcodempreendimento": null2057,
        "NUMEROCOBRANCA": null,
        "COMPLEMENTOCOBRANCAaprovado": nullfalse,
        "BAIRROCOBRANCA": null,
        "CIDADECOBRANCAitemvalidado": null,
"Validar Pessoa PI Sincronizado com Cli/For.",
   "UFCOBRANCA": null,
        "CEPCOBRANCAmensagemvalidacao": null,
"A pessoa do PI [10-ADRIANO NOVO PVI]  "MESMOENDERECOCOBRANCA": null,
        "LOGRADOURO": null,do Tipo [Propesct] não está sincronizado com Cli/For da coligada [1]\r\n"
        "NUMERO": null},
         "COMPLEMENTO": null,
{
            "BAIRROcodcoligada": null1,
            "CIDADEcodempreendimento": null2057,
            "UFaprovado": nulltrue,
            "CEPitemvalidado": null "Validar Tabela de Preço Vinculado ao Empreendimento",
            "SEXOmensagemvalidacao": null,""
        "DATANASCIMENTO": null},
        "CEI": null,{
            "NATURALIDADEcodcoligada": null1,
            "NACIONALIDADEcodempreendimento": null2057,
            "PAIaprovado": "PAI FIADOR 01",
true,
            "MAEitemvalidado": "MAEValidar FIADOR 01",
        "RENDA": null,
Modalidade de Venda Parametrizada e Vinculada ao Empreendimento",
            "CARTORIOFIRMAmensagemvalidacao": null,""
        "LIVROREGISTRO": null},
         "FOLHAREGISTRO": null,
{
            "EMPRESA_NOMEcodcoligada": null1,
        "EMPRESA_LOGRADOURO    "codempreendimento": null2057,
         "EMPRESA_NUMERO   "aprovado": nulltrue,
            "EMPRESA_COMPLEMENTOitemvalidado": null,
        "EMPRESA_BAIRRO": null,
        "EMPRESA_CIDADE": null,
        "EMPRESA_UF": null,
"Validar Modalidade de Comissão Vinculada ao Empreendimento",
             "EMPRESA_CEPmensagemvalidacao": null,
        "EMPRESA_TELEFONE": null,
        "EMPRESA_FAX": null,}
    ]
}

Expandir

title	API de Solicitação de Aprovação de Proposta Reprovada

Título

API de Solicitação de Aprovação de Proposta Reprovada

Endpoint

http://localhost:8051/api/imb/v1/sales/proposals/{Cod Coligada}_{Número da Venda}/approval

Verbo

Post

Parameters

Key

Value

note

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

url

Informe 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

Image Added

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

No Response

Expandir

title	API Aprovar Proposta Forçada

Título

API Aprovar Proposta Forçada

Endpoint

http://localhost:8051/api/imb/v1/sales/proposals/{Cod Coligada}_{Número da Venda}/forceapproval

Verbo

Post

Parameters

Key	Value
note	Informe a mensagem de observação do Supervisor para o Corretor
userld	Informe 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

Image Added

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

No Response

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.

Expandir

title	API - Inserir - Pessoas Adicionais

Título	API - Inserir - Pessoas Adicionais
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPVIClienteData
Verbo	Post
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 TCGI	Não tem Parãmetros no TCGI.

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

[
 
{"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"
}
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "length": 1,
    "data": {    "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_UFid": null"111",
        "CONJUGERESTDS_EMPRESATEMP_CEPID": null111,
        "OBSERVACOESID_ERP": null"1;001457",
        "FAIXAVALORPRETENDIDOCOMUNHAODEBENS_ID": null,
        "FORMACONTATOEMPREENDIMENTO_ID": null,
        "USUARIOCRIACAOESTADOCIVIL_ID": null,
        "DATAESTANDEVENDA_ULTIMA_INTERACAOID": null,
        "IMPORTPARTICIPANTECAMPMIDIA_ID": null,
        "PESSOAMORADIA_NATURALIDADE_ID": null,
        "PROFISSAO_ID_CONJUGE_NATURALIDADE": null,
        "SITUACAOCADASTROPESSOASITUACAOPESSOA_ID": null,
        "MEXTIPOIMOVEL_NSSID": null,
        "MEXTIPOLOGIA_RFCID": null,
        "MEXUSUARIO_CURPID": null,
        "MEX_CONJUGE_NSSTIPO": null8,
        "MEX_CONJUGE_RFCTIPOPESSOA": null0,
        "MEX_CONJUGE_CURPDATAHORACADASTRO": null"2023-05-18T11:09:58.52-03:00",
        "TEMPOMORADIANOME": null"CLIENTE FIADOR 01",
        "DATACASAMENTORAZAOSOCIAL": null " CLIENTE FIADOR 01",
        "RENDACOMPROMETIDACPFCNPJ": null"46185793237",
        "TIPORENDA_IDRGNUMERO": null,
        "CREDITO_FINANCIAMENTORGORGAO": null,
        "CREDITO_FGTSRGUF": null,
        "CREDITO_SUBSIDIOINSCRICAOESTADUAL": null,
        "CREDITO_RECURSO_PROPRIOINSCRICAOMUNICIPAL": null,
        "VALOR_PARCELA_APROVADATELEFONE": null"999999999",
        "PRAZO_MAXIMO_FINANCIAMENTOCELULAR": null,
        "TIPO_AMORTIZACAOFAX": null,
        "VIGENCIA_AVALIACAOEMAIL": null,
        "VALOR_RENDA_INFORMALSALT": null,
        "JSON_LEAD_RDHASH": null,
        "SDR_IDLOGRADOUROCOBRANCA": null,
        "CORRESPONDENTE_IDNUMEROCOBRANCA": null,
        "MOTIVO_REPROVACAOCOMPLEMENTOCOBRANCA": null,
        "LEADBAIRROCOBRANCA": null,
        "LEAD_POTENCIALCIDADECOBRANCA": null,
        "COD_INTEG_EXTERNOUFCOBRANCA": null,
        "RD_UUIDCEPCOBRANCA": null,
        "DATA_MUDANCA_SITUACAOMESMOENDERECOCOBRANCA": null,
        "DATA_CONSULTA_SERASALOGRADOURO": null,
        "RESPOSTA_API_SERASANUMERO": null,
        "POSSUI_VENDA_ERPCOMPLEMENTO": null,
        "RECCREATEDBYBAIRRO": null,
        "RECCREATEDONCIDADE": null,
        "RECMODIFIEDBYUF": null,
        "RECMODIFIEDONCEP": null,
        }
}

Expandir

title	API - Associar Pessoa na Proposta

Título

API - Associar Pessoa na Proposta

Endpoint

http://localhost:8051/api/imb/v1/sales/proposals/{Cod Coligada}_{Número da Venda}

Verbo

Put ou Post

Parameters

Não tem Parãmetros.

Descrição

Parãmetros TCGI

Não tem Parãmetros no TCGI.

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

{
    "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": ["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,
            "idcliente"EMPRESA_RAMAL": 4null,
            "clienteprincipal"EMPRESA_DATAADMISSAO": 1null,
        "EMPRESA_CARGO": null,
   "pessoasadicionais": [{"idpessoa": 111,"tipopessoa     "CONJUGE_PROFISSAO_ID": 8}null,
        "CONJUGE_NOME": "ESPOSA FIADOR 01",
        "CONJUGE_EMAIL": null,
        "CONJUGE_DATANASCIMENTO": null,
        {"idpessoaCONJUGE_CPF": 112,"tipopessoa53976044610":,
 7}
       "CONJUGE_RGNUMERO": null,
    
    "CONJUGE_RGORGAO": null,
        ]"CONJUGE_RGUF": null,
        }"CONJUGE_SEXO": null,
    ],
    "codempreendimentoCONJUGE_PAI": 2057null,
     "nomeempreendimento   "CONJUGE_MAE": null,
 "Emp Nova API Automação",
    "dataentregaCONJUGE_TELEFONE": "2022-01-01T00:00:00"null,
        "codunidadeCONJUGE_CELULAR": "1"null,
        "nomeunidadeCONJUGE_NATURALIDADE": "Bloco 01"null,
     "codsubunidade   "CONJUGE_NACIONALIDADE": "000005"null,
        "nomesubunidadeCONJUGE_CARTORIOFIRMA": "Apto 000005"null,
        "nrovagasCONJUGE_RENDA": 0null,
    "areasubunidade    "CONJUGE_EMPRESA_NOME": 180.0000null,
    "idcorretorpvi": 1,
    "idusuariopropostapviCONJUGE_EMPRESA_CARGO": 1null,
    "idimobiliariapvi    "CONJUGE_EMPRESA_DATAADMISSAO": 1null,
        "nomecorretorpviCONJUGE_EMPRESA_TELEFONE": "Corretor"null,
     "idsuperiorpvi   "CONJUGE_EMPRESA_LOGRADOURO": 2null,
        "nomesuperiorpviCONJUGE_EMPRESA_NUMERO": "Superior"null,
      "idmidia  "CONJUGE_EMPRESA_COMPLEMENTO": 1null,
        "idmotivocompraCONJUGE_EMPRESA_BAIRRO": 1null,
     "valordesconto   "CONJUGE_EMPRESA_CIDADE": 0.0000null,
    "propostaforcada": 0,
    "propostaforcadadataCONJUGE_EMPRESA_UF": "0001-01-01T00:00:00"null,
    "propostaforcadaobs":    "CONJUGE_EMPRESA_CEP"
}

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
: null,
        "codcoligadaOBSERVACOES": 1null,
        "idpropostapviFAIXAVALORPRETENDIDO_ID": 19null,
    "idpropostavenda": 10013,
    "datavendaFORMACONTATO_ID": "2023-03-20T00:00:00"null,
    "idmodalidade": 906,
    "numtabprecoUSUARIOCRIACAO_ID": 144null,
    "statuspvi": 1,
    "descricaostatuspviDATA_ULTIMA_INTERACAO": "Aprovada"null,
    "corletra": "#FFFFFF",
    "corfundoIMPORTPARTICIPANTECAMP_ID": "#5CB85C"null,
    "valorproposta    "PESSOA_NATURALIDADE_ID": 500000.0000null,
     "valortabelapreco   "ID_CONJUGE_NATURALIDADE": 500000.0000null,
    "datacriacao": "2023-03-20T11:15:44.313",
    "dataalteracaoSITUACAOCADASTROPESSOA_ID": "2023-05-19T11:33:49"null,
    "diasdaproposta": "60 dia(s)",
    "diasdapropostaporextensoMEX_NSS": "60 dia(s) 0 hora(s) 18 minuto(s)",
null,
         "clientesMEX_RFC": [null,
        {"MEX_CURP": null,
            "idcliente"MEX_CONJUGE_NSS": 4null,
            "clienteprincipalMEX_CONJUGE_RFC": 1null,
            "pessoasadicionais"MEX_CONJUGE_CURP": [null,
        "TEMPOMORADIA": null,
       {
 "DATACASAMENTO": null,
        "RENDACOMPROMETIDA": null,
         "idpessoaTIPORENDA_ID": 111null,
          "CREDITO_FINANCIAMENTO": null,
          "tipopessoaCREDITO_FGTS": 8null,
        "CREDITO_SUBSIDIO": null,
        }"CREDITO_RECURSO_PROPRIO": null,
        "VALOR_PARCELA_APROVADA": null,
       {
    "PRAZO_MAXIMO_FINANCIAMENTO": null,
        "TIPO_AMORTIZACAO": null,
        "idpessoaVIGENCIA_AVALIACAO": 112null,
            "VALOR_RENDA_INFORMAL": null,
        "tipopessoaJSON_LEAD_RD": 7null,
        "SDR_ID": null,
       }
   "CORRESPONDENTE_ID": null,
          ]"MOTIVO_REPROVACAO": null,
        }"LEAD": null,
    ],
    "codempreendimentoLEAD_POTENCIAL": 2057null,
        "nomeempreendimentoCOD_INTEG_EXTERNO": null,
 "Emp Nova API Automação",
    "dataentregaRD_UUID": "2022-01-01T00:00:00",
null,
        "codunidadeDATA_MUDANCA_SITUACAO": "1"null,
      "nomeunidade  "DATA_CONSULTA_SERASA": "Bloco 01"null,
        "codsubunidadeRESPOSTA_API_SERASA": "000005"null,
    "nomesubunidade    "POSSUI_VENDA_ERP": "Apto 000005"null,
        "nrovagasRECCREATEDBY": 0null,
    "areasubunidade": 180.0000,
    "idcorretorpviRECCREATEDON": 1null,
    "idimobiliariapvi": 1,
    "nomecorretorpviRECMODIFIEDBY": "Corretor"null,
    "idsuperiorpvi": 2,
    "nomesuperiorpviRECMODIFIEDON": "Superior",null
    "idmidia": 1,
    "idmotivocompra": 1,
    "valordesconto": 0.0000,
    "propostaforcada": 0,
    "propostaforcadadata": "0001-01-01T00:00:00",
    "propostaforcadaobs": ""
}}
}

Expandir

title	API de Usuário Portal de Imóveis- Associar Pessoa na Proposta

Título	API de Usuário Portal de Imóveis - GET- Associar Pessoa na Proposta
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/api/imb/v1/sales/proposals/{Cod Coligada}_{Número da Venda}
VerboGet	Put ou Post
Parameters No parameters	Não tem Parãmetros.
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

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

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 TCGI

Não tem Parãmetros no TCGI.

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

{
    "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": [
        {

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "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",
            "RESERVASidcliente": 34,
            "ATIVOclienteprincipal": 1,
            "DATAHORACADASTROpessoasadicionais": "2023-03-13T16:33:06-03:00"[{"idpessoa": 111,"tipopessoa": 8},
            "DATAHORAULTIMOLOGIN": "2023-03-22T08:31:08.863-03:00",
              "DATAHORAALTERACAO": "2023-03-22T08:31:08.917-03:00",
           {"idpessoa": "PERGUNTAR_NOTIFICAR_SUPERIOR112,"tipopessoa": 1,7}
            "LISTAS_DISPOSICAO": 2,
            "LISTAS_VISAO": 3,]
        }
    "PERCENTUAL_COMISSAO": 2.0000],
            "CRECI"codempreendimento": null2057,
    "nomeempreendimento": "Emp Nova API Automação",
    "IMOBILIARIA_IDdataentrega": null"2022-01-01T00:00:00",
            "PODE_ATUALIZAR_SISTEMA"codunidade": "1",
    "nomeunidade":    "Bloco 01",
    "TIPOPESSOAcodsubunidade": 1"000005",
            "CPFCNPJnomesubunidade": "34360165510Apto 000005",
        "nrovagas": 0,
    "FORCAR_ALTERAR_SENHAareasubunidade": 0180.0000,
    "idcorretorpvi": 1,
       "DATA_VIGENCIA_CRECI"idusuariopropostapvi": null1,
        "idimobiliariapvi": 1,
    "QTD_MAX_PROSPECTSnomecorretorpvi": 0"Corretor",
    "idsuperiorpvi": 2,
    "nomesuperiorpvi": "Superior",
    "RECCREATEDBYidmidia": null1,
    "idmotivocompra": 1,
    "valordesconto": 0.0000,
    "RECCREATEDONpropostaforcada": null0,
    "propostaforcadadata": "0001-01-01T00:00:00",
    "propostaforcadaobs": ""
}

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "RECMODIFIEDBYcodcoligada": null1,
       "idpropostapvi": 19,
     "RECMODIFIEDONidpropostavenda": null10013,
        }
}

Título

API de Usuário Portal de Imóveis - POST

Endpoint

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

Verbo

Post

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

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

[
    {        
          "ID":-1,
         "NOME": "Itamar",         
         "SOBRENOME": "Morais",    
         "ID_SUPERIOR": 1,
         "GRUPOUSUARIO_ID": 1,"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": [
        {
            "CPFCNPJidcliente": "860.672.580-30"4,
            "celularclienteprincipal": "999999999"1,
            "pessoasadicionais": [
          "EMAIL" : "[email protected]",      {
           
         "TIPOPESSOAidpessoa": 0111,
         
    }
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "lengthtipopessoa": 1,8
      "data": {
        "id": "37" },
         "RESTDS_TEMP_ID": 37,
      {
  "ID_ERP": "1;001456",
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID"idpessoa": 1112,
           "NOME": "Itamar",
        "SOBRENOMEtipopessoa": "Morais",7
        "EMAIL": "[email protected]",
        }
  "CELULAR": "999999999",
        "SALT": null, ]
        "HASH": null,}
    ],
    "RESERVAScodempreendimento": null2057,
    "nomeempreendimento": "Emp Nova API "ATIVOAutomação": null,
        "DATAHORACADASTROdataentrega": null"2022-01-01T00:00:00",
        "DATAHORAULTIMOLOGINcodunidade": null"1",
        "DATAHORAALTERACAOnomeunidade": null"Bloco 01",
        "PERGUNTAR_NOTIFICAR_SUPERIORcodsubunidade": null"000005",
        "LISTAS_DISPOSICAOnomesubunidade": null"Apto 000005",
        "LISTAS_VISAOnrovagas": null0,
        "PERCENTUAL_COMISSAOareasubunidade": null180.0000,
        "CRECIidcorretorpvi": null1,
        "IMOBILIARIA_ID"idimobiliariapvi": null1,
        "PODE_ATUALIZAR_SISTEMAnomecorretorpvi": null"Corretor",
        "TIPOPESSOAidsuperiorpvi": 02,
        "CPFCNPJnomesuperiorpvi": "86067258030Superior",
    "idmidia": 1,
    "FORCAR_ALTERAR_SENHAidmotivocompra": null1,
        "DATA_VIGENCIA_CRECI": null"valordesconto": 0.0000,
        "QTD_MAX_PROSPECTS"propostaforcada": null0,
        "RECCREATEDBYpropostaforcadadata": null,
        "RECCREATEDON": null,
  "0001-01-01T00:00:00",
       "RECMODIFIEDBYpropostaforcadaobs": null,
        "RECMODIFIEDON": null
    }
}}

Expandir

title	API de Usuário Portal de Imóveis

Título	API de Usuário Portal de Imóveis - PUTGET
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
Verbo	PutGet
Parameters	No parameters
Descrição	Utilizando esta API com o verbo PutGet, 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. retorna a lista de usuários cadastrados na Tabela XPIUSUARIO do Portal de Imóveis.
Parâmetros do TCGI

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
[
    {        "messages": [],
    "length": 1,
    "iddata": "37",[
        "RESTDS{
            "id": "1",
            "RESTDS_TEMP_ID": 371,
            "ID_ERP": "1;00145601455",
            "ID_SUPERIOR": 1null,
            "GRUPOUSUARIO_ID": 1,
            "NOME": "Itamarmestre",
            "SOBRENOME": "Moraistotvs",
            "EMAIL": "itamar.morais@totvsmestre@totvs.com.br",
            "CELULAR": "319349400003134940000",
            "SALT": null"Ay3+rprtuHjBQjA3vAqlJn8SyfqYovB7",
            "HASH": null"wsCmCTzMluub+Hls5oNDCc6O2zXevPBm",
            "RESERVAS": null3,
            "ATIVO": null1,
            "DATAHORACADASTRO": null,
"2023-03-13T16:33:06-03:00",
            "DATAHORAULTIMOLOGIN": null,
"2023-03-22T08:31:08.863-03:00",
            "DATAHORAALTERACAO": null"2023-03-22T08:31:08.917-03:00",
            "PERGUNTAR_NOTIFICAR_SUPERIOR": null1,
            "LISTAS_DISPOSICAO": null2,
            "LISTAS_VISAO": null3,
            "PERCENTUAL_COMISSAO": null2.0000,
            "CRECI": null,
            "IMOBILIARIA_ID": null,
            "PODE_ATUALIZAR_SISTEMA": null1,
            "TIPOPESSOA": 01,
            "CPFCNPJ": "8606725803034360165510",
            "FORCAR_ALTERAR_SENHA": null0,
            "DATA_VIGENCIA_CRECI": null,
            "QTD_MAX_PROSPECTS": null0,
    }
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "lengthRECCREATEDBY": 1null,
    "data": {
        "idRECCREATEDON": "37"null,
        "RESTDS_TEMP_ID": 37,
        "ID_ERPRECMODIFIEDBY": "1;001456"null,
        "ID_SUPERIOR": 1,
        "GRUPOUSUARIO_ID"RECMODIFIEDON": 1,null
        "NOME": "Itamar",
        "SOBRENOME": "Morais",
        "EMAIL": "[email protected]",
        "CELULAR": "31934940000",
        "SALT": null,
        "HASH": null,
}
}

Título	API de Usuário Portal de Imóveis - POST
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData
Verbo	Post
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

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

[
    {        
          "RESERVASID": null-1,
         "ATIVONOME": null"Itamar",
        "DATAHORACADASTRO": null,
         "DATAHORAULTIMOLOGINSOBRENOME": null,"Morais",    
         "DATAHORAALTERACAOID_SUPERIOR": null1,
         "PERGUNTARGRUPOUSUARIO_NOTIFICAR_SUPERIORID": null1,
         "LISTAS_DISPOSICAOCPFCNPJ": null"860.672.580-30",
         "LISTAS_VISAOcelular": null"999999999",
        "PERCENTUAL_COMISSAO": null,
          "CRECIEMAIL" : null,
"[email protected]",        "IMOBILIARIA_ID": null,
         "PODE_ATUALIZAR_SISTEMATIPOPESSOA": null,0
        "TIPOPESSOA": 0,
    }
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "CPFCNPJmessages": "86067258030"[],
        "FORCAR_ALTERAR_SENHA": null"length": 1,
    "data": {
        "id": "37",
        "RESTDS_TEMP_ID": 37,
        "DATA_VIGENCIA_CRECIID_ERP": "1;001456",
        "ID_SUPERIOR": null1,
        "QTDGRUPOUSUARIO_MAX_PROSPECTSID": null1,
        "RECCREATEDBYNOME": null"Itamar",
        "RECCREATEDONSOBRENOME": null"Morais",
        "RECMODIFIEDBYEMAIL": null"[email protected]",
        "RECMODIFIEDONCELULAR": null"999999999",
     }
}

Título

API de Usuário Portal de Imóveis - PATCH

Endpoint

http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]

Verbo

Patch

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

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

[
    {        
    "SALT": null,
        "HASH": null,
        "RESERVAS": null,
        "ATIVO": null,
        "DATAHORACADASTRO": null,
        "idDATAHORAULTIMOLOGIN": "37"null,
        "CELULARDATAHORAALTERACAO": "31934940000"null,
    }
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messagesPERGUNTAR_NOTIFICAR_SUPERIOR": []null,
      "length": 1,
    "data": {
        "id": "37"  "LISTAS_DISPOSICAO": null,
        "RESTDSLISTAS_TEMP_IDVISAO": 37null,
        "IDPERCENTUAL_ERPCOMISSAO": "1;001456"null,
        "ID_SUPERIORCRECI": 1null,
        "GRUPOUSUARIOIMOBILIARIA_ID": 1null,
        "NOMEPODE_ATUALIZAR_SISTEMA": "Itamar"null,
        "SOBRENOMETIPOPESSOA": "Morais"0,
        "EMAILCPFCNPJ": "[email protected]86067258030",
        "CELULARFORCAR_ALTERAR_SENHA": "31934940000"null,
        "SALTDATA_VIGENCIA_CRECI": null,
        "HASHQTD_MAX_PROSPECTS": null,
        "RESERVASRECCREATEDBY": null,
        "ATIVORECCREATEDON": null,
        "DATAHORACADASTRORECMODIFIEDBY": null,
        "DATAHORAULTIMOLOGINRECMODIFIEDON": null,
    }
}

Título	API de Usuário Portal de Imóveis - PUT
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
Verbo	Put
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

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

[
    {     "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,

         "RECCREATEDONid": null,
        "RECMODIFIEDBY37": null,
        "RECMODIFIEDON": null
    }
}

TítuloAPI de usuário Portal de Imóveis - DELETEEndpointhttp://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

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "length": 1,
    "data": {  "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,
        "idHASH": null,
 "37"       "RESERVAS": null,
        "RESTDS_TEMP_IDATIVO": 37null,
        "ID_ERPDATAHORACADASTRO": "1;001456"null,
        "ID_SUPERIORDATAHORAULTIMOLOGIN": 1null,
        "GRUPOUSUARIO_IDDATAHORAALTERACAO": 1null,
        "NOMEPERGUNTAR_NOTIFICAR_SUPERIOR": "Itamar"null,
        "SOBRENOMELISTAS_DISPOSICAO": "Morais"null,
        "EMAILLISTAS_VISAO": "[email protected]"null,
        "CELULARPERCENTUAL_COMISSAO": "31934940000"null,
        "SALTCRECI": null,
        "HASHIMOBILIARIA_ID": null,
        "RESERVASPODE_ATUALIZAR_SISTEMA": null,
        "ATIVOTIPOPESSOA": null0,
        "DATAHORACADASTROCPFCNPJ": null"86067258030",
        "DATAHORAULTIMOLOGINFORCAR_ALTERAR_SENHA": null,
        "DATAHORAALTERACAODATA_VIGENCIA_CRECI": null,
        "PERGUNTARQTD_NOTIFICARMAX_SUPERIORPROSPECTS": null,
    }
]

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.

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "LISTAS_DISPOSICAOmessages": null[],
    "length": 1,
    "LISTAS_VISAOdata": null,{
        "PERCENTUAL_COMISSAOid": null"37",
        "CRECIRESTDS_TEMP_ID": null37,
        "IMOBILIARIAID_IDERP": null"1;001456",
        "PODEID_ATUALIZAR_SISTEMASUPERIOR": null1,
        "TIPOPESSOAGRUPOUSUARIO_ID": 01,
        "CPFCNPJNOME": "86067258030Itamar",
        "FORCAR_ALTERAR_SENHASOBRENOME": null"Morais",
        "DATA_VIGENCIA_CRECIEMAIL": null"[email protected]",
        "QTD_MAX_PROSPECTSCELULAR": null"31934940000",
        "RECCREATEDBYSALT": "mestre"null,
        "RECCREATEDON": "2023-03-22T10:02:45-03:00"  "HASH": null,
        "RECMODIFIEDBYRESERVAS": "mestre"null,
        "RECMODIFIEDONATIVO": "2023-03-22T10:02:45-03:00"
    }
}

Expandir

title	API - Validação de Parametrização

Título

API - Validação de Parametrização

Endpoint

http://localhost:8051/api/imb/v1/registrations/validate/pi/enterprises/{Cod Empreendimento}

Verbo

GET

Parameters

Não tem Parãmetros.

Descrição

Parãmetros TCGI

Não tem Parãmetros no TCGI.

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{ "aprovado": false, "mensagemvalidacao": "Erro no Item Validar Pessoa PI Sincronizado com Cli/For.\r\n", "itensvalidados": [

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,
        "

codcoligada

RECCREATEDBY":

0

null,

codempreendimento

RECCREATEDON":

0

null,

aprovado

RECMODIFIEDBY":

true

null,

itemvalidado

RECMODIFIEDON": null
    }
}

Título	API de Usuário Portal de Imóveis - PATCH
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
Verbo	Patch
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

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

"Validar Tabela [XPISITUACAOPROPOSTA] com Dados no Portal de Imóveis.",

"mensagemvalidacao": "" }, {

codcoligada

id":

0

"37",

codempreendimento

CELULAR":

0,

"31934940000"
    }
]

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "

aprovado

length":

true

1,
    "data": {
        "

itemvalidado

id": "37"

Validar

Tabela

[XPISITUACAOUNIDADE]

com

Dados

no

Portal

de Imóveis."

 "RESTDS_TEMP_ID": 37,

"mensagemvalidacao

"ID_ERP": "1;001456",

}

 "ID_SUPERIOR": 1,

{

"GRUPOUSUARIO_ID": 1,
        "

codcoligada

NOME":

0

"Itamar",

codempreendimento

SOBRENOME":

0

"Morais",

aprovado

EMAIL":

true

"[email protected]",

itemvalidado

CELULAR": "31934940000"

Validar

Tabela

[XPIPARAMETRO]

com

Dados

no

Portal

de

Imóveis."

"SALT": null,

mensagemvalidacao

HASH":

""

null,
        "RESERVAS":

}

null,

{

"ATIVO": null,

codcoligada

DATAHORACADASTRO":

0

null,

codempreendimento

DATAHORAULTIMOLOGIN":

0

null,

aprovado

DATAHORAALTERACAO":

true

null,

itemvalidado

PERGUNTAR_NOTIFICAR_SUPERIOR":

"Validar Configuração de Forçar Proposta "

 null,
        "LISTAS_DISPOSICAO": null,

"mensagemvalidacao

"LISTAS_VISAO":

""

null,

}

 "PERCENTUAL_COMISSAO": null,

{

"CRECI": null,

codcoligada

IMOBILIARIA_ID":

0

null,

"codempreendimento

"PODE_ATUALIZAR_SISTEMA":

0

null,

aprovado

TIPOPESSOA":

true

0,

itemvalidado

CPFCNPJ": "

Validar Venda Sequencial TCGI

86067258030",

"mensagemvalidacao

"FORCAR_ALTERAR_SENHA":

""

null,

}

"DATA_VIGENCIA_CRECI": null,

{

"QTD_MAX_PROSPECTS": null,
        "

codcoligada

RECCREATEDBY":

1

null,

codempreendimento

RECCREATEDON":

2057

null,

aprovado

RECMODIFIEDBY":

true

null,
        "RECMODIFIEDON": null

"itemvalidado": "Validar Código Sequencial Parâmetro Cli/For.", "mensagemvalidacao": "" }, { "codcoligada": 1, "codempreendimento": 2057, "aprovado": true,

}
}

Título	API de usuário Portal de Imóveis - DELETE
Endpoint	http://localhost:8051/rmsrestdataserver/rest/ImbPIUsuarioData/{ID_do_Usuário_na_XPIUSUARIO]
Verbo	Delete
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

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	Body
collapse	true

No Body

Bloco de código

root	Modelo Json Solicitação Geração Comissão
title	RESPONSE
collapse	true

{
    "messages": [],
    "length": 1,
    "data": {
        "

itemvalidado

id": "

Validar Usuário PI Sincronizado com Cli/For.

37",

"mensagemvalidacao

"RESTDS_TEMP_ID":

"" }

37,

{

"codcoligada

"ID_ERP": "1;001456",

codempreendimento

ID_SUPERIOR":

2057

1,

"aprovado

"GRUPOUSUARIO_ID":

false

1,

itemvalidado

NOME": "

Validar Pessoa PI Sincronizado com Cli/For.

Itamar",

mensagemvalidacao

SOBRENOME": "Morais"

A

pessoa

do

PI

[10-ADRIANO

NOVO

PVI]

do Tipo [Propesct] não está sincronizado com Cli/For da coligada [1]\r\n"

"EMAIL": "[email protected]",
        "CELULAR": "31934940000",

}

"SALT": null,

{

"HASH": null,

codcoligada

RESERVAS":

1

null,

codempreendimento

ATIVO":

2057,

 null,
        "

aprovado

DATAHORACADASTRO":

true

null,

itemvalidado

DATAHORAULTIMOLOGIN":

"Validar Tabela de Preço Vinculado ao Empreendimento",

null,
        "DATAHORAALTERACAO": null,
        "

mensagemvalidacao

PERGUNTAR_NOTIFICAR_SUPERIOR":

""

null,

}

"LISTAS_DISPOSICAO": null,

{

"LISTAS_VISAO": null,
        "

codcoligada

PERCENTUAL_COMISSAO":

1

null,

codempreendimento

CRECI":

2057

null,

aprovado

IMOBILIARIA_ID":

true

null,

"itemvalidado

"PODE_ATUALIZAR_SISTEMA":

"Validar

null,

Modalidade

de

Venda

Parametrizada

e

Vinculada

ao

Empreendimento",

"TIPOPESSOA": 0,
        "

mensagemvalidacao

CPFCNPJ": "86067258030",

}

"FORCAR_ALTERAR_SENHA": null,

{

"DATA_VIGENCIA_CRECI": null,
        "

codcoligada

QTD_MAX_PROSPECTS":

1

null,

codempreendimento

RECCREATEDBY":

2057

"mestre",

aprovado

RECCREATEDON":

true

"2023-03-22T10:02:45-03:00",

itemvalidado

RECMODIFIEDBY": "

Validar Modalidade de Comissão Vinculada ao Empreendimento

mestre",

mensagemvalidacao

RECMODIFIEDON": "2023-03-22T10:02:45-03:00"

]

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 36

Nova versão Atual

Chave

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters