Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleAPI de Dados do Usuário Logado no PDC
TítuloAPI de Dados do Usuário Logado no PDC
Endpointhttp://localhost:8051/api/imb/v1/users/contextuserweb
VerboGet.

Parameters

no parameters
Descrição 

Esta API utiliza o verbo GET e em sua resposta apresenta as informações abaixo, relativo relativas ao usuário que está logando no Portal do Cliente - PDC:

  • Entidade Usuario: dados básicos do usuário logado no PDC
    • codusuario: Código de acesso do usuário
    • nome: Nome do usuário
    • email: Email deste usuário
Entidade Empreendimentos:
  • company: Código da coligada do empreendimento
  • realEstate: Código do empreendimento em si
  • name: Nome do empreendimento 
  • trandingName: Nome de fantasia do empreendimento
  • launchDate: Data de lançamento deste empreendimento
  • origincontracttype: Tipo do Contrato, se:
    • 0 - Contrato de Venda; ou
    • 1 - Contrato de Aluguel.
  • contracts: Número dos contratos de venda e aluguel que o cliente possui neste empreendimento

    Bloco de código
    rootModelo Json Solicitação Geração Comissão
    titleAPI de Dados do Usuário Logado no PDCBODY
    collapsetrue
    No Body
    Bloco de código
    rootModelo Json Solicitação Geração Comissão
    titleRESPONSE - API de Dados do Usuário Logado no PDC
    collapsetrue
    {
        "usuario": {
            "codusuario": "teste",
            "nome": "CLIENTE API",
            "email": "[email protected]"
        },
        "empreendimentos": [
            {
                "company": 1,
                "realEstate": 2019,
                "name": "EMPREENDIMENTO TESTE",
                "trandingName": "EMPREENDIMENTO TESTE",
                "launchDate": "2010-06-01T00:00:00",
                "origincontracttype": 0,
                "contracts": [
                    10009
                ]
            },
            {
                "company": 6,
                "realEstate": 2054,
                "name": "Empreendimento Teste Automação",
                "trandingName": "Empreendimento Teste Automação",
                "launchDate": "0001-01-01T00:00:00",
                "origincontracttype": 0,
                "contracts": [
                    50000
                ]
            },
            {
                "company": 1,
                "realEstate": 3,
                "name": "ALUGUEL TESTE API",
                "trandingName": "ALUGUEL TESTE API",
                "launchDate": "0001-01-01T00:00:00",
                "origincontracttype": 1,
                "contracts": [
                    3
                ]
            }
        ]
    } 
    Expandir
    titleParâmetros do Response

    Parâmetros:

    • codcoligadaUsuario: 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;
    • dados básicos do usuário logado no PDC
      • codusuario: Código de acesso do usuário
      • nome: Nome do usuário
      • email: Email deste usuário
    • Empreendimentos:
      • company: Código da coligada do empreendimento
      • realEstate: Código do empreendimento em si
      • name: Nome do empreendimento 
      • trandingName: Nome de fantasia do empreendimento
      • launchDate: Data de lançamento deste empreendimento
      • origincontracttype: Tipo do contrato, sendo:
        • 0 - Contrato de venda; ou
        • 1 - Contrato de aluguel.
      • contracts: Número dos contratos de venda e aluguel que o cliente possui neste empreendimento
    • 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;