Versões comparadas

Chave

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

Configurando APIs

API de Propostas


Deck of Cards
idApiss
Card
accessKey773520485
id773520485
labelComissões

HTML Include
urlhttps://tdn.totvs.com/plugins/viewsource/viewpagesrc.action?pageId=773520795

Card
accessKey773520485
id773520485
labelComissões
HTML
{html-include:url=}<a href="http://www.exampleatlassian.com">Click here</a> to see the <b>Atlassian</b> website.{html}




Card
labelAPI's da Comissão |

Tipo de API's 


Deck of Cards
idTipos de Apis
Card
accessKey773520485
id773520485
labelComissões

HTML Include
urlhttps://tdn.totvs.com/plugins/viewsource/viewpagesrc.action?pageId=773520485

Card
labelPlano de Financiamento

Apis de Plano de Financiamento 

API: GET: http://localhost:8051/api/imb/v1/modalities/1/enterprises/20_28

API que retorna os valores das condições de financiamento de todas as subunidades de um empreendimento, utilizando uma modalidade para simular


API: GET: http://localhost:8051/api/imb/v1/modalities/1/enterprises/20_28_000001

API que retorna os valores das condições de financiamento de todas as subunidades de uma unidade de um empreendimento, utilizando uma modalidade para simular


API: GET: http://localhost:8051/api/imb/v1/modalities/1/enterprises/20_28_000001_000101

API que retorna os valores das condições de financiamento de todas a subunidade de uma unidade de um empreendimento, utilizando uma modalidade para simular


Bloco de código
rootModelo Json Solicitação Geração Comissão
titleRESPONSE
collapsetrue
[
    {
        "codcoligada": 20,
        "codpessempr": 28,
        "numunid": "000001",
        "numsubunid": "000101",
        "area": 100.0,
        "precoM2": 2117.35,
        "precosubunid": 211735.27,
        "componentesgeradores": [
            {
                "codgrupo": 1,
                "codcompn": 1,
                "descompn": "8 x Entrada - Teste",
                "valorparcela": 7940.07
            },
            {
                "codgrupo": 1,
                "codcompn": 2,
                "descompn": "160 x Mensal",
                "valorparcela": 1804.64
            }
        ]
    },
    {
        "codcoligada": 20,
        "codpessempr": 28,
        "numunid": "000001",
        "numsubunid": "000102",
        "area": 100.0,
        "precoM2": 2483.88,
        "precosubunid": 248388.22,
        "componentesgeradores": [
            {
                "codgrupo": 1,
                "codcompn": 1,
                "descompn": "8 x Entrada - Teste",
                "valorparcela": 9314.56
            },
            {
                "codgrupo": 1,
                "codcompn": 2,
                "descompn": "160 x Mensal",
                "valorparcela": 2117.04
            }
        ]
    }
]
Expandir
titleParâmetros

Parâmetros:

  • codcoligada: coligada do empreendimento;
  • codpessempr: código do emprrendimento;
  • numunid: código de unidade;
  • numsubunid: código da subunidade;
  • area: área da subunidade;
  • precoM2: preço do m2 da subunidade;
  • precosubunid: preço da subunidade;
  • componentesgeradores: componentes da modalidade;
    • codgrupo: código do grupo que pertence a modalidade;
    • codcompn: código do componente;
    • descompn: descrição do componente;
    • valorparcela: valor do componente;


API: GET: http://localhost:8051/api/imb/v1/Sales/20_1914/rules

API que retorna os principais campos e valores da condição de financiamento, por venda e utilizando uma modalidade para simular e enviar a proposta


API: GET: http://localhost:8051/api/imb/v1/Sales/20_1912/rules/generate/1

API que retorna os principais campos e valores da condição de financiamento, por venda e utilizando uma modalidade para simular e enviar a proposta


API: POST: http://localhost:8051/api/imb/v1/Sales/20_1912/modality_rules

API que gera e retorna o plano de financiamento da proposta de venda a partir de uma modalidade


API: DELETE: http://localhost:8051/api/imb/v1/sales/1_46/rules/1/components/1

 API para deletar apenas os componentes do gerador de parcela (entrada e principal), sendo que ao deletar esses componentes serão deletados os componentes dependentes como juros e cm se forem o caso.


API: GET: http://localhost:8051/api/imb/v1/Sales/1_46/modality_rules

API que retorna os componentes da modalidade que não estejam já inserido na regra da venda.


API: POST: http://localhost:8051/api/imb/v1/sales/1_46/rules

API para inserir um componente da modalidade na regra da venda

Bloco de código
rootModelo Json Solicitação Geração Comissão
titlePOST - Exemplo requisição
collapsetrue
{
	"codgrupo": 2,
	"codcompn": 30,
	"dsccompn": "Anual",
	"qtdparc": 5,
	"valorparcela": 10000,
	"valortotal": 10000,
	"dataprimeirovencimento": "2022-06-20T00:00:00"
}


API: PUT ou PATCH: http://localhost:8051/api/imb/v1/sales/1_46/rules/1/components/1

API para editar componente da regra da venda. somente permite a edição de um campo por vez, exceto a data de vencimento que pode editar com outros campos. Isso, porque um campo interfere em outro cálculo.

Bloco de código
rootModelo Json Solicitação Geração Comissão
titlePOST - Exemplo requisição
collapsetrue
{
	"qtdparc": 10,
	"valorparcela": 6000,
	"valortotal": 0,
	"dataprimeirovencimento": "2019-07-26T00:00:00"
}
Expandir
titleCampos Editáveis
  • 1º Vencimento; permite editar sempre
  • Nro de Parcelas; permite editar sempre
  • Valor Parcela; somente pode editar se não for price, sac e sacre
  • Valor Total. permite editar sempre


API: GET: http://localhost:8051/api/imb/v1/sales/20_1/plans

API que retornar o plano de financiamento com as parcelas geradas a partir das regras cadastradas na proposta

Bloco de código
rootModelo Json Solicitação Geração Comissão
titleRESPONSE
collapsetrue
[
    {
        "codcoligada": 1,
        "numvenda": 4,
        "codgrupo": 1,
        "codtipoparc": 1,
        "dsctipoparc": "Sinal",
        "numparc": 1,
        "codcompn": 1,
        "dsccompn": "Sinal",
        "datavencimento": "2002-01-10T00:00:00",
        "valorparcela": 20000.0,
        "valororiginal": 20000.0,
        "valorjuros": 0.0,
        "valorcm": 0.0,
        "valoroutros": 0.0
    }
]




Bloco de código
rootModelo Json Solicitação Geração Comissão
titleRESPONSE
collapsetrue
[
    {
        "codcoligada": 20,
        "numvenda": 1914,
        "codgrupo": 1,
        "codcompn": 1,
        "dsccompn": "Entrada - Teste",
        "qtdparc": 8,
        "valorparcela": 5580.0,
        "valortotal": 44640.0,
        "dataprimeirovencimento": "2017-07-26T00:00:00",
        "codmodelocalculo": 0,
        "dscmodelocalculo": "Base",
        "percentualcomponente": 30.0,
        "valorcomissaocliente": 0.0
    },
    {
        "codcoligada": 20,
        "numvenda": 1914,
        "codgrupo": 1,
        "codcompn": 2,
        "dsccompn": "Mensal",
        "qtdparc": 160,
        "valorparcela": 1268.24,
        "valortotal": 104160.0,
        "dataprimeirovencimento": "2017-08-26T00:00:00",
        "codmodelocalculo": 2,
        "dscmodelocalculo": "PRICE",
        "percentualcomponente": 70.0,
        "valorcomissaocliente": 0.0
    }
]
Expandir
titleParâmetros

Parâmetros:

  • codcoligada: coligada do empreendimento;
  • numvenda : Número da venda;
  • codgrupo: código do grupo que pertence a modalidade;
  • codcompn: código do componente;
  • dsccompn: descrição do componente;
  • qtdparc: quantidade de parcela do plano
  • valorparcela: valor do componente;
  • valortotal: Valor total do Componente financiado
  • dataprimeirovencimento: data do primeiro vencimento
  • codmodelocalculo: código do modelo de financiamento;
  • dscmodelocalculo: descrição do modelo de financiamento;
  • percentualcomponente: percentual do componente sobre o valor da proposta;
  • valorcomissaocliente: Valor retido na comissão do pagamento pelo cliente;



API: GET: http://localhost:8051/api/imb/v1/Sales/20_1914/VPL

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

Bloco de código
rootModelo Json Solicitação Geração Comissão
titleRESPONSE
collapsetrue
 
Imagem da configuração feita na Modalidade da Venda
{
    "codcoligada": 20,
    "numvenda": 1914,
    "valortabelaprecopadrao": "R$ 148.800,00",
    "valortabelaprecoproposta": "R$ 148.800,00",
    "valorfinanciadoatulizadopadrao": "R$ 287.060,89",
    "valorfinanciadoatulizadoproposta": "R$ 281.766,42",
    "valorpadraovpl": "R$ 195.282,75",
    "valorpropostavpl": "R$ 193.635,05",
    "percentualtma": "0,500000%",
    "mensagem": "Proposta Reprovada",
    "log": "A captação a vista (sinal) da proposta 0,66% é inferior ao mínimo da modalidade 5,00%; 
			O desconto da proposta 1,84% é superior ao máximo da modalidade 1,00%; 	
			A VPL da proposta 0,84% é superior ao máximo da modalidade 0,50%; ",
    "aprovada": false,
    "itensvpl": [
        {
            "nomeparametro": "Prazo de Financiamento",
            "valortabela": "160",
            "valorproposta": "160",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "% Captação a Vista",
            "valortabela": "2,00%",
            "valorproposta": "0,66%",
            "parametrodeaprovacao": "%Mín 5,00% - %Máx 20,00%"
        },
        {
            "nomeparametro": "% Captação até Entrega",
            "valortabela": "0,00%",
            "valorproposta": "0,00%",
            "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$ 195,17",
            "valorproposta": "R$ 191,57",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "Valor m2 VPL",
            "valortabela": "R$ 132,77",
            "valorproposta": "R$ 131,65",
            "parametrodeaprovacao": " - "
        },
        {
            "nomeparametro": "% Arrecadação",
            "valortabela": "92,92%",
            "valorproposta": "89,36%",
            "parametrodeaprovacao": "%Mín 50,00% - %Máx 100,00%"
        },
        {
            "nomeparametro": "% Desconto",
            "valortabela": "0,00%",
            "valorproposta": "1,84%",
            "parametrodeaprovacao": "%Máx 1,00%"
        },
        {
            "nomeparametro": "% Diferenca do VPL",
            "valortabela": "0,00%",
            "valorproposta": "0,84%",
            "parametrodeaprovacao": "%Máx 0,50%"
        }
    ]
}
Expandir
titleParâmetros

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;



API: http://localhost:8051/api/imb/v1/Sales/proposals/1

API para retornar lista de propostas

Bloco de código
rootModelo Json Solicitação Geração Comissão
titleRESPONSE
collapsetrue
[
    {
        "stateentity": 0,
        "codcoligada": 1,
        "numproposta": 89,
        "dataproposta": "2013-11-08T00:00:00",
        "statusvenda": 15,
        "descricaostatus": "Proposta",
        "valorproposta": 100000.0000,
        "valortabelapreco": 0.0,
        "datahoracriacaoproposta": "2013-11-08T00:00:00",
        "diascriacaoproposta": 3169,
        "codigoempreendimento": "100",
        "nomeempreendimento": "Empreendimento",
        "dataentregaempreendimento": "2004-12-31T00:00:00",
        "codigobloco": "01",
        "nomebloco": "Bloco A",
        "codigosubunidade": "000501",
        "nomesubunidade": "Sub Unidade",
        "numerovagassubunidade": 0,
        "areasubunidade": 90.0000,
        "codigocorretor": 0,
        "codigosuperiocorretor": 0
    },
    {
        "stateentity": 0,
        "codcoligada": 1,
        "numproposta": 9893,
        "dataproposta": "2022-03-10T00:00:00",
        "statusvenda": 15,
        "descricaostatus": "Proposta",
        "valorproposta": 200000.0000,
        "valortabelapreco": 0.0,
        "datahoracriacaoproposta": "2022-03-10T00:00:00",
        "diascriacaoproposta": 125,
        "codigocliente": "C01533",
        "nomecliente": "CLIENTE",
        "codigoempreendimento": "2019",
        "nomeempreendimento": "EMPREENDIMENTO MODELOS DE CÁLCULO ",
        "dataentregaempreendimento": "2010-06-01T00:00:00",
        "codigobloco": "03",
        "nomebloco": "BLOCO 03",
        "codigosubunidade": "000027",
        "nomesubunidade": "Apto 000027",
        "numerovagassubunidade": 0,
        "areasubunidade": 360.0000,
        "codigocorretor": 0,
        "codigosuperiocorretor": 0
    },
    {
        "stateentity": 0,
        "codcoligada": 1,
        "numproposta": 10004,
        "dataproposta": "2022-07-13T00:00:00",
        "statusvenda": 15,
        "descricaostatus": "Proposta",
        "valorproposta": 100000.0000,
        "valortabelapreco": 0.0,
        "datahoracriacaoproposta": "2022-07-13T00:00:00",
        "diascriacaoproposta": 0,
        "codigocliente": "C01533",
        "nomecliente": "CLIENTE",
        "codigoempreendimento": "2019",
        "nomeempreendimento": "EMPREENDIMENTO MODELOS DE CÁLCULO ",
        "dataentregaempreendimento": "2010-06-01T00:00:00",
        "codigobloco": "01",
        "nomebloco": "BLOCO 01",
        "codigosubunidade": "1",
        "nomesubunidade": ".",
        "numerovagassubunidade": 0,
        "areasubunidade": 100.0000,
        "codigocorretor": 0,
        "codigosuperiocorretor": 0
    }
]


API: http://localhost:8051/api/imb/v1/sales/proposals/1_10004

API buscar uma proposta especifica.

Bloco de código
rootModelo Json Solicitação Geração Comissão
titleRESPONSE
collapsetrue
[
    {
        "stateentity": 0,
        "codcoligada": 1,
        "numproposta": 10004,
        "dataproposta": "2022-07-13T00:00:00",
        "statusvenda": 15,
        "descricaostatus": "Proposta",
        "valorproposta": 100000.0000,
        "valortabelapreco": 0.0,
        "datahoracriacaoproposta": "2022-07-13T00:00:00",
        "diascriacaoproposta": 0,
        "codigocliente": "C01533",
        "nomecliente": "CLIENTE",
        "codigoempreendimento": "2019",
        "nomeempreendimento": "EMPREENDIMENTO MODELOS DE CÁLCULO ",
        "dataentregaempreendimento": "2010-06-01T00:00:00",
        "codigobloco": "01",
        "nomebloco": "BLOCO 01",
        "codigosubunidade": "1",
        "nomesubunidade": ".",
        "numerovagassubunidade": 0,
        "areasubunidade": 100.0000,
        "codigocorretor": 0,
        "codigosuperiocorretor": 0
    }
]
Card
labelParâmetros

Apis de Parâmetros

API: GET: http://localhost:8051/api/imb/v1/parameters/getParameter?company=0&parameter=UTILIZACOMISSAOVERSAO2

API para verificar se a comissão 2.0 está ativada.

Bloco de código
rootModelo Json Solicitação Geração Comissão
titleRESPONSE
collapsetrue
{
    "company": 0,
    "name": "UTILIZACOMISSAOVERSAO2",
    "value": "1"
}
Expandir
titleParâmetros

Dados recebidos:

  • company: Código da coliga. (0 para coligada global);
  • name: Nome do parâmetro para verificação;
  • value: Pode ser 1 ou 0. Se 1, está ativado e 0 está desativado.
Card
labelSegurança

Apis de Seguranças

API: GET: http://localhost:8051/api/imb/v1/securitys/813000033/companys/20/persons/111.222.333-50

API que retorna as permissões de uma tag de segurança por coligada e por CPF


API: GET:http://localhost:8051/api/imb/v1/securitys/813000033/companys/20/persons/111.222.333-50/tables/xcomissoes

API que retorna as permissões de uma tag de segurança por coligada, CPF e por restrições de campos de uma tabela


API: GET: http://localhost:8051/api/imb/v1/securitys/813000033/tags/0_1_3_2/companys/20/persons/111.222.333-50

API que retorna as permissões de uma tag de segurança e subtags (ExecuteId, InsertId, DeleteId, EditId), por coligada e por CPF


API: GET:http://localhost:8051/api/imb/v1/securitys/813000033/tags/0_1_3_2/companys/20/persons/111.222.333-50/tables/xcomissoes

API que retorna as permissões de uma tag de segurança e subtags (ExecuteId, InsertId, DeleteId, EditId), por coligada, CPF e por restrições de campos de uma tabela


API: GET: http://localhost:8051/api/imb/v1/securitys/813000033/tags/4/companys/20/persons/111.222.333-50

API que retorna as permissões de uma tag de segurança e subtag (TagId), por coligada e por CPF


API: GET:http://localhost:8051/api/imb/v1/securitys/813000033/tags/4/companys/20/persons/111.222.333-50/tables/xcomissoes

API que retorna as permissões de uma tag de segurança e subtags (TagId), por coligada, CPF e por restrições de campos de uma tabela


Bloco de código
rootModelo Json Solicitação Geração Comissão
titleRESPONSE
collapsetrue
{
    "count": 1,
    "hasNext": false,
    "items": [
        {
            "codColigada": 20,
            "codUsuario": "mestre",
            "securityId": 813000346,
            "executeId": 0,
            "insertID": 1,
            "deleteID": 2,
            "editID": 3,
            "tagId": 0,
            "allowEdit": true,
            "allowInsert": true,
            "allowView": true,
            "allowDelete": false,
            "allowTagId": true,
            "imbTableFieldRestrictionsSecurity": [
                {
                    "tableName": "XCOMISSOES",
                    "columnName": "PERCENTUALMAX",
                    "denyEdit": true,
                    "denyView": false,
                    "podeConsultar": "T",
                    "podeAlterar": "F"
                },
                {
                    "tableName": "XCOMISSOES",
                    "columnName": "PERCENTUALMAX",
                    "denyEdit": true,
                    "denyView": false,
                    "podeConsultar": "T",
                    "podeAlterar": "F"
                },
                {
                    "tableName": "XCOMISSOES",
                    "columnName": "PERCENTUALMAX",
                    "denyEdit": true,
                    "denyView": false,
                    "podeConsultar": "T",
                    "podeAlterar": "F"
                }
            ],
            "systemMensage": "Usuário Logado com Sucesso!"
        }
    ]
}
Expandir
titleParâmetros

Dados recebidos:

  • codColigada: Código da coligada do usuário;

  • codUsuario: Código do usuário;

  • securityId:  Tag de segurança;

  • executeId: Tag de visualizar utilizada na verificação;

  • insertID: Tag de inserir utilizada na verificação;
  • deleteID: Tag de deletar utilizada na verificação;
  • editID: Tag de edição utilizada na verificação;
  • tagId: Qualquer tipo de tag que queira verificar;
  • allowEdit: Permite editar;
  • allowInsert: Permite inserir;

  • allowView: Permite visualizar;

  • allowDelete: Permite deletar;

  • allowTagId: Permite executar um tag que foi passada;
  • imbTableFieldRestrictionsSecurity: permissões dos campos da tabela definido no parâmetro


Card
label Relatórios PDC

HTML Include
urlhttps://tdn.totvs.com/plugins/viewsource/viewpagesrc.action?pageId=756475196