1. COMPUTE
Calcula SUM(), COUNT(), MAX(), MIN() da tabela em memória.

1.1. Contexto
Reajuste contratual de venda/aluguel

1.2. Sintaxe
COMPUTE ( TABELA, EXPRESSAO, FILTRO )
A sintaxe da função COMPUTE tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • TABELA – Tabela
  • EXPRESSAO – Expressão para calcular
  • FILTRO – O filtro para limitar as linhas que avaliar na expressão

1.3. Exemplo
Tabela: XVENDA
EXPRESSAO: SUM(NUM_VENDA)
Filtro: DAT_VENDA > 1/1/2010 AND DAT_VENDA < 17/1/2012

2. CONDVENDA
Busca informações da condição da venda

2.1. Contexto
Contrato de venda/aluguel

2.2. Sintaxe
CONDVENDA ( VALOR1, VALOR2, STRING1, STRING2 )
A sintaxe da função CONDVENDA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR1 – Código do grupo
  • VALOR2 – Código do componente
  • STRING1 – Nome do campo da tabela de regra da venda
  • STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

2.3. Exemplo
CODVENDA(1,1,'QTD_PARC','I')

3. CONTEXTO
Tabela de Contexto do Reajuste Mensal

3.1. Contexto
Reajuste contratual de venda/aluguel

3.2. Sintaxe
CONTEXTO ( STRING )
A sintaxe da função CONTEXTO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING – Nome do campo da tabela carregada no contexto

4. CUSTOINCORRIDO
Busca o valor do custo incorrido

4.1. Contexto
Apuração de resultado contábil pelo POC (Resolução 963)

4.2. Sintaxe
CUSTOINCORRIDO ( VALOR1, VALOR2, VALOR3, VALOR4, DATA, STRING ).

A sintaxe da função CUSTOINCORRIDO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR1 – Código da coligada
  • VALOR2 – Código do projeto
  • VALOR3 – Código da obra
  • VALOR4 – Código da etapa
  • DATA – Data da apuração
  • STRING – Código do usuário

5. CUSTOORCADO
Busca o valor do custo orçado

5.1. Contexto
Apuração de resultado contábil pelo POC (Resolução 963)

5.2. Sintaxe
CUSTOORCADO ( VALOR1, VALOR2, VALOR3, VALOR4, DATA, STRING ).
A sintaxe da função CUSTOORCADO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR1 – Código da coligada
  • VALOR2 – Código do projeto
  • VALOR3 – Código da obra
  • VALOR4 – Código da etapa
  • DATA – Data da apuração
  • STRING – Código do usuário

6. CUSTOORCADOREMANESCENTE
Busca o valor do custo orçado remanescente

6.1. Contexto
Apuração de resultado contábil pelo POC (Resolução 963)

6.2. Sintaxe
CUSTOORCADOREMANESCENTE ( VALOR1, VALOR2, VALOR3, VALOR4, DATA, STRING)
A sintaxe da função CUSTOORCADOREMANESCENTE tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR1 – Código da coligada
  • VALOR2 – Código do projeto
  • VALOR3 – Código da obra
  • VALOR4 – Código da etapa
  • DATA – Data da apuração
  • STRING – Código do usuário

7. DATBASE
Retorna a data base do componente

7.1. Contexto
Reajuste contratual de venda/aluguel

7.2. Sintaxe
DATBASE

8. DATREAJUSTE
Retorna a data do Reajuste da Parcela

8.1. Contexto
Reajuste contratual de venda/aluguel

8.2. Sintaxe
DATREAJUSTE

9. EXTENSODATA
Retorna uma data por extenso

9.1. Contexto
Independente do contexto

9.2. Sintaxe
EXTENSODATA ( DATA )
A sintaxe da função EXTENSODATA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • DATA – Data a ser retorna por extenso

9.3. Exemplo
EXTENSODATA('20/03/2010')

10. CALCULAVALORSALDODEVEDOR01
Cálculo do Saldo Devedor Atualizado

10.1. Contexto
Aditivo contratual

10.2. Sintaxe
CALCULAVALORSALDODEVEDOR01 ( COLIGADA, NUMVENDA, VALOR, TAXACORRECAO, CODGRUPO, DATAFINAL)
A sintaxe da função CALCULAVALORSALDODEVEDOR01 tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • COLIGADA – Código da coligada
  • NUMVENDA – Número da venda
  • VALOR – Valor principal
  • TAXACORRECAO – Taxa de correção
  • CODGRUPO – Código do grupo
  • DATAFINAL – Data final para o calculo do refinanciamento

10.3. Exemplo
Calculo o número de meses entre a data da venda e a data informada para o calculo
Período = Data da Venda – Data Informada = 5;
Pego no componente de CM o símbolo da moeda indexada mês a mês no período de cinco meses
Período Data Símbolo
1º 01/01/2009 IGPM
2º 01/02/2009 IGPM
3º 01/03/2009 IGPM
4º 01/04/2009 IGPM
5º 01/05/2009 IGPM

Busco a Cotação de CM para cada período e calculo a variação
Período Data Símbolo
1º 01/01/2009 1,0124
2º 01/02/2009 1,004
3º 01/03/2009 1,0133
4º 01/04/2009 1,0065
5º 01/05/2009 1,0101

Pego a variação acumulada multiplicando mês a mês das variações
Acumulado = (1,0124 x 1,004 x 1,0133 x 1,0065 x 1,0101)/100 = 0,010471

Obs.: Por causa desta parte do calculo que é obrigatório ter no grupo o componente de CM para que seja possível fazer uma renegociação utilizando as formulas de Refinanciamento 01 e 02

2º Calculo do Saldo Devedor Atualizado do Refinanciamento 1
Calculo o valor da taxa sobre o valor principal + valor de correção monetária. O valor da taxa é informado pelo usuário no campo Taxa Correção
VR_TAXA = (65.000,00 + 1.066,00) x (1,5 / 100) = 990,99
O novo valor total fica com a soma do valor principal + valor de correção monetária + valor de juros contrato + valor da taxa
VR_TOTAL = 65.000,00 + 1.066,00 + 1,00 + 990,99 = 67057,99
Adiciono ainda a este valor se houver e estiver trabalhando no componente forem valor total + juros de mora e multa este valores no meu exemplo de teste estavam zerados.
VR_TOTAL = 67057,99 + 1,00 +2,00 = 67060,99
Aplico a variação no valor total e retorno
VR_RETORNO = 67060,99 x (0,010471 + 1) = 67.763,19

11. CALCULAVALORSALDODEVEDOR02
Cálculo do Saldo Devedor Atualizado

11.1. Contexto
Aditivo contratual

11.2. Sintaxe
CALCULAVALORSALDODEVEDOR02 (COLIGADA, NUMVENDA, VALOR, TAXACORRECAO, CODGRUPO, DATAFINAL)
A sintaxe da função CALCULAVALORSALDODEVEDOR02 tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • COLIGADA – Código da coligada
  • NUMVENDA – Número da venda
  • VALOR – Valor
  • TAXACORRECAO – Taxa de correção
  • CODGRUPO – Código do grupo
  • DATAFINAL – Data final para o calculo do refinanciamento

11.3. Exemplo
Calculo o número de meses entre a data da venda e a data informada para o calculo
Período = Data da Venda – Data Informada = 5;
Pego no componente de CM o símbolo da moeda indexada mês a mês no período de cinco meses
Período Data Símbolo
1º 01/01/2009 IGPM
2º 01/02/2009 IGPM
3º 01/03/2009 IGPM
4º 01/04/2009 IGPM
5º 01/05/2009 IGPM

Busco a Cotação de CM para cada período e calculo a variação
Período Data Símbolo
1º 01/01/2009 1,0124
2º 01/02/2009 1,004
3º 01/03/2009 1,0133
4º 01/04/2009 1,0065
5º 01/05/2009 1,0101
Pego a variação acumulada multiplicando mês a mês das variações
Acumulado = (1,0124 x 1,004 x 1,0133 x 1,0065 x 1,0101)/100 = 0,010471

Cálculo do Saldo Devedor Atualizado do Refinanciamento 2

O novo valor total fica com a soma do valor principal + valor de correção monetária - valor de baixas de juros contrato
VR_TOTAL = 65.000,00 + 1.066,00 - 1,00 = 66.065,00

Adiciono ainda a este valor se houver e estiver trabalhando no componente forem valor total + juros de mora e multa este valor no meu exemplo de teste estava zerado
VR_TOTAL = 66.065,00 + 1,00 + 2,00 = 66.068,00

Aplico a variação no valor total e guardo
VR_TOTAL = 66.068,00 x (0,010471 + 1) = 66.759,80

Aplico a taxa de correção informada pelo usuário sobre o valor total e retorno
VR_RETORNO = 66.759,80 x ((1,5 / 100) + 1) = 67.761,20

12. EXTENSONUMERO
Retorna um número por extenso

12.1. Contexto
Independente do contexto

12.2. Sintaxe
EXTENSONUMERO ( VALOR )
A sintaxe da função EXTENSONUMERO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR – Número a ser retornado por extenso

12.3. Exemplo
EXTENSONUMERO(1453)

13. EXTENSOVALOR
Retorna um valor por extenso

13.1. Contexto
Independente do contexto

13.2. Sintaxe
EXTENSOVALOR ( VALOR )
A sintaxe da função EXTENSOVALOR tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR – Valor a ser retornado por extenso

13.3. Exemplo
EXTENSOVALOR(156.14)

14. FORMATANUMERO
Retorna um número formatado em inteiro

14.1. Contexto
Independente do contexto

14.2. Sintaxe
FORMATANUMERO ( VALOR )
A sintaxe da função FORMATANUMERO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR – Valor a ser formatado para o padrão inteiro

14.3. Exemplo
FORMATANUMERO(156.14)

15. FORMATAVALOR
Retorna um valor formatado em moeda

15.1. Contexto
Independente do contexto

15.2. Sintaxe
FORMATAVALOR ( VALOR )
A sintaxe da função FORMATAVALOR tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR – Valor a ser formatado para o padrão moeda

15.3. Exemplo
FORMATAVALOR(152.6)

16. GPCODCOMPN
Retorna o código do componente de Juros ou CM

16.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

16.2. Sintaxe
GPCODCOMPN

17. GPCODCOMPNPRINCIPAL
Retorna o código do componente principal

17.1. Contexto
Geração do plano de financiamento

17.2. Sintaxe
GPCODCOMPNPRINCIPAL

18. GPCODGRUPO
Retorna o código do grupo

18.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

18.2. Sintaxe
GPCODGRUPO

19. GPCODTIPOCOMPN
Retorna o código do tipo de Componente dos Juros ou CM

19.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

19.2. Sintaxe
GPCODTIPOCOMPN

20. GPCODTIPOPARC
Retorna o código do tipo da parcela

20.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

20.2. Sintaxe
GPCODTIPOPARC

21. GPCOMPUTE

Calcula SUM(), COUNT(), MAX(), MIN() da tabela em memória.

21.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

21.2. Sintaxe
GPCOMPUTE ( TABELA, EXPRESSAO, FILTRO )
A sintaxe da função GPCOMPUTE tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • TABELA – Tabela
  • EXPRESSAO – Expressão para calcular
  • FILTRO – O filtro para limitar as linhas que avaliar na expressão

21.3. Exemplo
TABELA: XVENDA
EXPRESSAO: SUM (NUM_VENDA)
FILTRO: DAT_VENDA > 1/1/2010 AND DAT_VENDA < 17/1/2012

22. GPGETDATABASE
Retorna a data de referência de reajuste (Data de início do componente)

22.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

22.2. Sintaxe
GPGETDATABASE

23. GPGETDATAENTREGA
Retorna a data de entrega do empreendimento

23.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

23.2. Sintaxe
GPGETDATAENTREGA

24. GPGETPERIODOMESES
Retorna o Período em meses da data base até o vencimento da parcela

24.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

24.2. Sintaxe
GPGETPERIODOMESES

25. GPGETSALDODEVEDORAMORTIZADO
Retorna o saldo devedor amortizado até o vencimento da parcela

25.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

25.2. Sintaxe
GPGETSALDODEVEDORAMORTIZADO

26. GPNUMPARC
Retorna o número da parcela

26.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

26.2. Sintaxe
GPNUMPARC

27. GPNUMVENDA
Retorna o número da venda

27.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

27.2. Sintaxe
GPNUMVENDA

28. GPSETVALORPRINCIPAL
Seta o valor do Componente Principal da Parcela

28.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

28.2. Sintaxe
GPSETVALORPRINCIPAL ( VALOR )

A sintaxe da função GPSETVALORPRINCIPAL tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR – Valor a ser inserido.

29. GPXPARCELAPAGAMENTO
Acessa os campos da parcela

29.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

29.2. Sintaxe
GPXPARCELAPAGAMENTO ( STRING )
A sintaxe da função GPXPARCELAPAGAMENTO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING – Campo que se deseja ter acesso da parcela

30. GPXREGRACOMPONENTEVENDA
Acesso aos campos da Regra no Grupo

30.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

30.2. Sintaxe
GPXREGRACOMPONENTEVENDA ( STRING )
A sintaxe da função GPXREGRACOMPONENTEVENDA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING - Campo que se deseja ter acesso da regra no grupo

31. GPXREGRACOMPONENTEVENDAPRINCIPAL
Acesso aos campos da Regra Principal

31.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

31.2. Sintaxe
GPXREGRACOMPONENTEVENDAPRINCIPAL ( STRING )
A sintaxe da função GPXREGRACOMPONENTEVENDAPRINCIPAL tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING - Campo que se deseja ter acesso da regra principal

32. GPXVENDA
Acesso aos campos da venda

32.1. Contexto
Geração do plano de financiamento em memória (sem acesso a banco de dados)

32.2. Sintaxe
GPXVENDA ( STRING )
A sintaxe da função GPXVENDA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING - Campo que se deseja ter acesso da venda

33. JUROSMORA
Retorna o valor de juros de mora por atraso, de todas as parcelas em aberto ou parcialmente quitadas, vencidas de um contrato.

33.1. Contexto
Contrato de venda/aluguel

33.2. Sintaxe
JUROSMORA ( VALOR1, VALOR2, DATA, STRING )
A sintaxe da função JUROSMORA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR1 – Código da coligada
  • VALOR2 – Número da venda
  • DATA – Data referência
  • STRING – Código do usuário

33.3. Exemplo
JUROSMORA(1,1,'24/06/2001','mestre')

34. MULTA
Retorna o valor de multa por atraso, de todas as parcelas em aberto ou parcialmente quitadas, vencidas de um contrato.

34.1. Contexto
Contrato de venda/aluguel

34.2. Sintaxe
MULTA ( VALOR1, VALOR2, DATA, STRING )
A sintaxe da função MULTA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR1 – Código da coligada
  • VALOR2 – Número da venda
  • DATA – Data referência
  • STRING – Código do usuário

34.3. Exemplo
MULTA(1,3,'24/06/2001','mestre')

35. NUMPARC
Retorna o número de uma parcela.

35.1. Contexto
Reajuste contratual de venda/aluguel.

35.2. Sintaxe
NUMPARC

36. NUMVENDA
Retorna o número de uma venda/aluguel.

36.1. Contexto
Reajuste contratual de venda/aluguel.

36.2. Sintaxe
NUMVENDA

37. CODGRUPO
Retorna o código de um grupo.

37.1. Contexto
Reajuste contratual de venda/aluguel.

37.2. Sintaxe
CODGRUPO

38. CODCOMPN
Retorna o código do componente de reajuste

38.1. Contexto
Reajuste contratual de venda/aluguel

38.2. Sintaxe
CODCOMPN

39. CODTIPOCOMPN
Retorna o código do tipo do componente de reajuste

39.1. Contexto
Reajuste contratual de venda/aluguel

39.2. Sintaxe
CODTIPOCOMPN

40. CODTIPOPARC
Retorna o código do tipo de uma parcela

40.1. Contexto
Reajuste contratual de venda/aluguel

40.2. Sintaxe
CODTIPOPARC

41. PERIODOANUAL
Retorna o período anual entre a data base até o vencimento da parcela retornando a diferença de anos.

41.1. Contexto
Reajuste contratual de venda/aluguel.

41.2. Sintaxe
PERIODOANUAL

42. PERIODOMENSAL
Retorna o período mensal entre a data base até o vencimento da parcela retornando a diferença de meses.

42.1. Contexto
Reajuste contratual de venda/aluguel.

42.2. Sintaxe
PERIODOMENSAL

43. DIFERENCADIAS
Retorna a Diferença de dias entre duas datas

43.1. Contexto
Independente do contexto

43.2. Sintaxe
DIFERENCADIAS ( DATA1, DATA2 )
A sintaxe da função DIFERENCADIAS tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • DATA1 – Primeira Data
  • DATA2 – Segunda Data

43.3. Exemplo
DIFERENCADIAS('10/03/2012','10/02/2012')

44. DIFERENCAMESES
Retorna a Diferença de meses entre duas datas

44.1. Contexto
Independente do contexto

44.2. Sintaxe
DIFERENCAMESES ( DATA1, DATA2 )
A sintaxe da função DIFERENCAMESES tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • DATA1 – Primeira Data
  • DATA2 – Segunda Data

44.3. Exemplo
DIFERENCAMESES('10/03/2012','10/02/2012')

45. ADICIONADIAS
Adiciona Dias a uma Data

45.1. Contexto
Independente do contexto

45.2. Sintaxe
ADICIONADIAS ( STRING, DATA1, DATA2, DATA3, VALOR1, VALOR2 )
A sintaxe da função ADICIONADIAS tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • DATA – Data para adicionar dias
  • DIAS – Dias a ser adicionado a uma data

45.3. Exemplo
ADICIONADIAS('10/03/2012',10)

46. ADICIONAMESES
Adiciona Meses a uma Data

46.1. Contexto
Independente do contexto

46.2. Sintaxe
ADICIONAMESES ( DATA, MESES)
A sintaxe da função ADICIONAMESES tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • DATA – Data para adicionar dias
  • MESES – Meses a ser adicionado a uma data

46.3. Exemplo
ADICIONAMESES('10/03/2012',10)

47. ADICIONAANOS
Adiciona Anos a uma Data

47.1. Contexto
Independente do contexto

47.2. Sintaxe
ADICIONAANOS ( DATA, ANOS )
A sintaxe da função ADICIONAANOS tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• DATA – Data para adicionar anos
• ANOS – Anos a ser adicionado a uma data

47.3. Exemplo
ADICIONAANOS('10/03/2012',10)

48. RECALCULACORRECAOMONETARIA
Calcula a Variação da Correção Monetária em memória (sem acesso ao banco de dados)

48.1. Contexto
Reajuste contratual de venda/aluguel

48.2. Sintaxe
RECALCULACORRECAOMONETARIA ( STRING, DATA1, DATA2, DATA3, VALOR1, VALOR2 )
A sintaxe da função RECALCULACORRECAOMONETARIA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING – Moeda
  • DATA1 – Data Inicial
  • DATA2 – Data Final
  • DATA3 – Data de vencimento da parcela
  • VALOR1 – Periodicidade
  • VALOR2 – Meses de defasagem

49. REXPARCELACOMPONENTE
Retorna o valor de um campo de uma parcela do componente em memória (sem acesso ao banco de dados)

49.1. Contexto
Reajuste contratual de venda/aluguel

49.2. Sintaxe
REXPARCELACOMPONENTE ( VALOR, STRING )
A sintaxe da função REXPARCELACOMPONENTE tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• VALOR – Código do componente
• STRING - Campo que se deseja ter acesso da parcela

50. REXPARCELAPAGAMENTO
Retorna o valor de um campo de uma parcela de pagamento em memória (sem acesso ao banco de dados)

50.1. Contexto
Reajuste contratual de venda/aluguel

50.2. Sintaxe
REXPARCELAPAGAMENTO ( STRING )
A sintaxe da função REXPARCELAPAGAMENTO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• STRING - Campo que se deseja ter acesso da parcela

51. REXREGRACOMPONENTEVENDA
Acesso aos campos da Regra no Grupo em memória (sem acesso ao banco de dados)

51.1. Contexto
Reajuste contratual de venda/aluguel

51.2. Sintaxe
REXREGRACOMPONENTEVENDA ( VALOR, STRING )
A sintaxe da função REXREGRACOMPONENTEVENDA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• VALOR – Código do componente
• STRING – Campo que se deseja ter acesso da regra no grupo

52. REXVENDA
Acesso aos campos da venda em memória (sem acesso ao banco de dados)

52.1. Contexto
Reajuste contratual de venda/aluguel

52.2. Sintaxe
REXVENDA ( STRING )
A sintaxe da função REXVENDA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING – Campo que se deseja ter acesso da venda

53. SALDONEGATIVOVENDA
Retorna o saldo negativo de uma venda.

53.1. Contexto
Contrato de Venda/Aluguel

53.2. Sintaxe
SALDONEGATIVOVENDA ( VALOR )
A sintaxe da função SALDONEGATIVOVENDA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• VALOR – Número da venda

53.3. Exemplo
SALDONEGATIVOVENDA(1)

54. SOMATIPOCOMPN
Soma o valor de um tipo de componente

54.1. Contexto
Contrato de Venda/Aluguel

54.2. Sintaxe
SOMATIPOCOMPN ( STRING1, STRING2 )
A sintaxe da função SOMATIPOCOMPN tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• STRING1 – Tipo do componente
• STRING2 – Situação da parcela

54.3. Exemplo
SOMATIPOCOMPN('1','2')

55. SOMATIPOPARCELA
Soma o valor de um tipo de parcela

55.1. Contexto
Contrato de Venda/Aluguel

55.2. Sintaxe
SOMATIPOPARCELA ( STRING1, STRING2 )
A sintaxe da função SOMATIPOPARCELA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• STRING1 – Tipo de parcela
• STRING2 – Situação da parcela

55.3. Exemplo
SOMATIPOPARCELA('2','2')

56. TABAPURACAO963
Retorna o valor de um campo qualquer da tabela de apuração 963 (XAPURACAO963)

56.1. Contexto
Apuração de resultado contábil pelo POC (Resolução 963)

56.2. Sintaxe
TABAPURACAO963 ( STRING1, STRING2 )
A sintaxe da função TABAPURACAO963 tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• STRING1 – Nome do campo da tabela de apuração 963
• STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

57. TABCOMISSAO
Retorna o valor de um campo qualquer da tabela de comissão (XCOMISSAO)

57.1. Contexto
Contrato de venda/aluguel

57.2. Sintaxe
TABCOMISSAO ( STRING1, STRING2 )
A sintaxe da função TABCOMISSAO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING1 – Nome do campo da tabela comissão
  • STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

57.3. Exemplo
TABCOMISSAO('NUMVENDA','V')

58. TABCOMISSAOCOMPL
Retorna o valor de um campo qualquer da tabela de campo complementar de comissão (XCOMISSAOCOMPL)

58.1. Contexto
Contrato de venda/aluguel

58.2. Sintaxe
TABCOMISSAOCOMPL ( STRING1, STRING2 )
A sintaxe da função TABCOMISSAOCOMPL tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• STRING1 – Nome do campo da tabela de campo complementar de comissão
• STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

58.3. Exemplo
TABCOMISSAOCOMPL('CODCOMISSAO','V')

59. TABDISTRATO
Retorna o valor de um campo qualquer da tabela de distrato (XDISTRATO).

59.1. Contexto
Contrato de venda/aluguel

59.2. Sintaxe
TABDISTRATO ( STRING1, STRING2 )
A sintaxe da função TABDISTRATO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• STRING1 – Nome do campo da tabela de distrato
• STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

59.3. Exemplo
TABDISTRATO('NUMVENDA','I')

60. TABDISTRATOCOMPL
Retorna o valor de um campo qualquer da tabela de campo complementar de distrato (XDISTRATOCOMPL).

60.1. Contexto
Contrato de venda/aluguel

60.2. Sintaxe
TABDISTRATOCOMPL ( STRING1, STRING2 )
A sintaxe da função TABDISTRATOCOMPL tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• STRING1 – Nome do campo da tabela de campo complementar de distrato
• STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

60.3. Exemplo
TABDISTRATOCOMPL('NUMVENDA','I')

61. TABITEMVENDA
Retorna o valor de um campo qualquer da tabela de item da venda (XITEMVENDA).

61.1. Contexto
Contrato de venda/aluguel

61.2. Sintaxe
TABITEMVENDA ( STRING1, STRING2 )
A sintaxe da função TABITEMVENDA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING1 – Nome do campo da tabela de item de venda
  • STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

61.3. Exemplo
TABITEMVENDA('VR_ITEM','V')

62. TABREGRA
Retorna o valor de um campo qualquer da tabela de regras da venda/aluguel (XREGRACOMPONENTEVENDA).

62.1. Contexto
Regra da Venda/Aluguel.

62.2. Sintaxe
TABREGRA ( STRING1, STRING2 )
A sintaxe da função TABREGRA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING1 – Nome do campo da tabela de regra da venda
  • STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

62.3. Exemplo
TABREGRA('COD_TIPO_PER','S')

63. TABREGRA963
Retorna o valor de um campo qualquer da tabela de regra 963 (XREGRA963).

63.1. Contexto
Apuração de resultado contábil pelo POC (Resolução 963)

63.2. Sintaxe
TABREGRA963 ( STRING1, STRING2 )
A sintaxe da função TABREGRA963 tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING1 – Nome do campo da tabela de regra 963
  • STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

64. TABVENDA
Retorna o valor de um campo qualquer da tabela de venda (XVENDA).

64.1. Contexto
Contrato de venda/aluguel

64.2. Sintaxe
TABVENDA ( STRING1, STRING2 )
A sintaxe da função TABVENDA tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • STRING1 – Nome do campo da tabela de venda
  • STRING2 – Tipo do campo. Legenda: (V = Valor; I = Inteiro; S = Conjunto de Caracteres; D = Data e Hora)

64.3. Exemplo
TABVENDA('DAT_VENDA','D')

65. TOTALDIASANO
Retorna o total de dias de um determinado ano.

65.1. Contexto
Independente do contexto

65.2. Sintaxe
TOTALDIASANO ( VALOR )
A sintaxe da função TOTALDIASANO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR – Ano que deseja calcular os dias

65.3. Exemplo
TOTALDIASANO('2012')

66. TOTALDIASMES
Retorna o total de dias de um determinado mês de um ano.

66.1. Contexto
Independente do contexto

66.2. Sintaxe
TOTALDIASMES ( VALOR1, VALOR2 )
A sintaxe da função TOTALDIASMES tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR1 – Mês que deseja calcular os dias
  • VALOR2 – Ano

66.3. Exemplo
TOTALDIASMES('12','2012')

67. TOTALPAGO
Retorna o valor total pago de um contrato.

67.1. Contexto
Contrato de venda/aluguel

67.2. Sintaxe
TOTALPAGO ( VALOR1, VALOR2 )
A sintaxe da função TOTALPAGO tem os seguintes argumentos (argumento: um valor que fornece informações a uma ação, um evento, um método, uma função ou um procedimento.):

• • VALOR1 – Código da coligada
  • VALOR2 – Número da venda

68. DATVCTO
Retorna a data de vencimento de uma parcela.

68.1. Contexto
Reajuste contratual de venda/aluguel.

68.2. Sintaxe
DATVCTO

69. ALGTABELAEVENTOFINANCEIRO
Retorna informações sobre o registro da tabela XALGEVENTOFINANCEIRO carregada no contexto

69.1. Contexto
Chave da tabela "XALGEVENTOFINANCEIRO"

69.2. Sintaxe
ALGTABELAEVENTOFINANCEIRO
A função de formula espera como parâmetro o nome da coluna e o tipo do dado que será retornado. (Tipo de dados: D => Data | I => inteiro | S => string | V => valor).

69.3. Exemplo
ALGTABELAEVENTOFINANCEIRO('DATAEVENTFIN','D')

70. ALGTABELAEVENTOFINANCEIRODISTRIBUICAO
Retorna informações sobre o registro da tabela XALGEVENTOFINANCEIRODISTRIBUIC carregada no contexto

70.1. Contexto
Chave da tabela "XALGEVENTOFINANCEIRODISTRIBUIC"

70.2. Sintaxe
ALGTABELAEVENTOFINANCEIRODISTRIBUICAO
A função de formula espera como parâmetro o nome da coluna e o tipo do dado que será retornado. (Tipo de dados: D => Data | I => inteiro | S => string | V => valor).

70.3. Exemplo
ALGTABELAEVENTOFINANCEIRODISTRIBUICAO('CODEVENTFIN','I')

71. ALGVALORESLANCAMENTOFINANCEIRO
Retorna informações sobre o lançamento em uma dada data e com referência nos dados da tabela XALGEVENTOFINANCEIRODISTRIBUIC carregada no contexto

71.1. Contexto
Usa como contexto a chave da tabela "XALGEVENTOFINANCEIRODISTRIBUIC" e permite ao usuário consultar possíveis valores do lançamento financeiro respectivo à distribuição. Esta informação é obtida chamando o serviço disponível do modulo financeiro (IFinLanMod.ValorLiquido)

71.2. Sintaxe
ALGVALORESLANCAMENTOFINANCEIRO(DataReference, ValorRetorno)

• • DataReference: Data de Referência para cálculo dos valores do lançamento
  • ValorRetorno: Pode ser um dos valores abaixo:

DESCONTO
DESCONTOBX
INSS
INSSBX
IRRF
IRRFBX
MULTAATRASO
MULTAATRASOBX
JUROSMORA
JUROSMORABX
LIQUIDO
LIQUIDOPARCIAL
ORIGINAL
ORIGINALBX
RETENCOES
RETENCOESBX

71.3. Exemplo
ALGVALORESLANCAMENTOFINANCEIRO('20/12/2018','MULTAATRASO')

72. ALGVALORESINTEGRACAONAOPARTICIPAODIMOBLANCAMENTOFINANCEIRO
A função se baseia no retorno de um serviço do modulo de gestão financeira para retornar os valores desejados

72.1. Contexto
Usa como contexto a chave da tabela "XALGEVENTOFINANCEIRODISTRIBUIC" e permite ao usuário consultar possível saldo de valores de integração do lançamento financeiro que não participam do DIMOB. Para encontrar este saldo devemos verificar se o valor de integração está configurado como "Acrescenta" ou "Desconta" para conseguirmos calcular o saldo.

72.2. Sintaxe
ALGVALORESINTEGRACAONAOPARTICIPAODIMOBLANCAMENTOFINANCEIRO
Esta informação é obtida chamando o serviço disponível do modulo financeiro (IFinLanMod.ValorLiquido) e caso tenha algum valor de integração fazendo o rastro no TIN se o evento agregado que o originou esta configurado para participar do DIMOB. A função de formula espera como parâmetro uma data de referencia que será utilizada para calcular valores variáveis em função da data. (DataReference: DateTime)

73. ALGITEMBAIXALANCAMENTOFINANCEIRO

73.1. Contexto
Retorna dados do item de baixa do lançamento financeiro.
Obs.: Apenas é passível de execução no processamento do DIMOB de locação onde o item de baixa é passado por parâmetros da função.

73.2. Sintaxe
ALGITEMBAIXALANCAMENTOFINANCEIRO(Valor desejado, Tipo do valor)

• • Valor desejado que aceita os seguintes valores:
    IDBAIXA
    STATUSBAIXA
    DATABAIXA
    VALORBAIXA
    VALORORIGINALBAIXA
    VALORDESCONTOBAIXA
    VALORMULTAATRASOBAIXA
    VALORJUROSMORABAIXA
    VALORIRRFBAIXA
    
    
  • Tipo do valor

Tipo de Valor ('D' => Date; 'I' => Inteiro; 'S' => String; 'V' => Valor

74. ALGDATACONTABIL

Retorna a data informada no processo de contabilização de Aluguel

74.1. Contexto
Contexto de contabilização de Aluguel

74.2. Sintaxe
ALGDATACONTABIL

75. ALGSALDOCREDOREVENTOFINLOCATARIO

75.1. Contexto
Retorna saldo credor dos eventos financeiros para o locatário no contrato de locação

75.2. Sintaxe

ALGSALDOCREDOREVENTOFINLOCATARIO

76. ALGSALDODEVEDOREVENTOFINLOCADOR

76.1. Contexto
Retorna saldo devedor dos eventos financeiros para o locador no contrato de locação.

76.2. Sintaxe

ALGSALDODEVEDOREVENTOFINLOCADOR

77. ALGSALDODEVEDOREVENTOFINLOCATARIO

77.1. Contexto
Retorna saldo devedor dos eventos financeiros para o locatário no contrato de locação.

77.2. Sintaxe

ALGSALDODEVEDOREVENTOFINLOCATARIO

78. ALGTABALUGUELCONTRATOLOCACAOCOMISSAO

Retorna o valor de qualquer campo da tabela de comissão do contrato de locação

78.1. Contexto

Comissão de contrato de locação

78.2. Sintaxe

ALGTABALUGUELCONTRATOLOCACAOCOMISSAO(Campo, Tipo Valor)
Parametros da função:

• • Campo (Nome da coluna desta tabela)
  • TipoValor ('D' => Date; 'I' => Inteiro; 'S' => String; 'V' => Valor)

79. ALGTABALUGUELCONTRATOLOCACAOENCERRAMENTO

Retorna o valor de qualquer campo da tabela de encerramento do contrato de locação

79.1. Contexto

Encerramento / Rescisão do contrato de locação

79.2. Sintaxe

ALGTABALUGUELCONTRATOLOCACAOCOMISSAO(Campo, Tipo Valor)

Parâmetros da função:

• • Campo (Nome da coluna desta tabela)
  • TipoValor ('D' => Date; 'I' => Inteiro; 'S' => String; 'V' => Valor)

80. ALGCAMPOCOMPLCONTRATOLOC

Retorna os valores dos campos complementares do contrato de locação

80.1. Contexto

Contrato de Locação

80.2. Sintaxe ALGCAMPOCOMPLCONTRATOLOC(Campo, Tipo Valor)
Parâmetros da função:

• • Campo (Nome da coluna desta tabela)
  • TipoValor ('D' => Date; 'I' => Inteiro; 'S' => String; 'V' => Valor)

81. COMPETENCIAALGCOMPLEMENTAR

Retorna a competência que está sendo processada na geração de aluguel complementar. Se for processado fora do contexto, irá retornar a data atual

81.1. Contexto

Contrato de Locação

81.2. Sintaxe

COMPETENCIAALGCOMPLEMENTAR

82. VALORBASEALUGUEL

Retorna o valor base do aluguel para uma determinada Competência. O valor base considera os valores de Escalonamento ou Aluguel em Dobro, caso os mesmos estejam aplicados na competência informada

82.1. Contexto

Contrato de Locação

82.2. Sintaxe

VALORBASEALUGUEL(VALOR)
Parâmetros da função:

• • VALOR - Data da competência

83. FATURAMENTOALGCOMPLEMENTARVALOR

Retorna o valor do faturamento da competência

83.1. Contexto

Contrato de Locação

83.2. Sintaxe

FATURAMENTOALGCOMPLEMENTARVALOR(VALOR)
Parâmetros da função:

• • VALOR - Data da competência

84. PERCENTUALFATURAMENTOALGCOMPLEMENTAR

Retorna o percentual (Conforme faturamento) da Competência

84.1. Contexto

Contrato de Locação

84.2. Sintaxe

PERCENTUALFATURAMENTOALGCOMPLEMENTAR(VALOR)
Parâmetros da função:

• • VALOR - Data da competência

Além das fórmulas criadas (81, 82, 83 e 84) foram incluídas algumas informações no contexto do processo, que podem ser usadas para cálculo: DATACOMPETENCIA VALORBASEALUGUEL PERCENTUALALUGUELDOBRO VALORALUGUELCOMPLEMENTAR VALORFATURAMENTO PERCENTUALFATURAMENTO

85. ALGCONTEXTO

Retorna o dados de acordo com os contextos do processo no qual a fórmula está sendo executada

85.1. Contexto
No caso de Reajuste do Aluguel, pode ser usada nas seguintes situações:

• • Reajuste do Imóvel Contrato de Locação
  • Reajuste do Desconto do Contrato de Locação
  • Reajuste do Escalonamento

85.2. Sintaxe
ALGCONTEXTO('PARAMETRO')
Possui os seguintes parâmetros para essa função de fórmula:

VALORORIGINAL: Ao inserir esse parâmetro, a função de fórmula retorna o primeiro valor do contexto no qual está sendo executado. Segue alguns exemplos conforme o contexto:

• • Reajuste do Imóvel do Contrato de Locação: retornar o valor de locação do momento da Efetivação do Contrato de Locação. Mesmo que o contrato possua Aditivos onde é alterado o seu valor de Locação, ainda sim será retornado o Valor de Efetivação do Contrato de Locação;
  • Reajuste do Desconto do Contrato de Locação: retorna o valor de desconto do Contrato de Locação no momento da Efetivação do Contrato. Mesmo que o contrato possua Aditivos onde é alterado o desconto, ainda sim será retornado o valor do desconto no momento da Efetivação do Contrato
  • Reajuste do Escalonamento: retorna o valor do Escalonamento no momento da sua Efetivação. Como o valor do Escalonamento não pode ser alterado por Aditivos, essa parâmetro sempre retorna o valor original do Escalonamento

VALORPRINCIPAL: Ao inserir esse parâmetro, a função de fórmula retorna o valor principal atual sem o reajuste do contexto no qual está sendo executado. Segue alguns exemplos conforme o contexto:

• • Reajuste do Imóvel do Contrato de Locação: retornar o valor de locação sem reajuste do Contrato de Locação. Caso o contrato possua Aditivos onde é alterado o seu valor de Locação, será retornado o valor de locação do aditivo mais atual
  • Reajuste do Desconto do Contrato de Locação: retorna o valor de desconto sem reajuste do Contrato de Locação no atual do Contrato de Locação. Caso o contrato possua Aditivos onde é alterado o desconto, será retornado o valor de desconto do aditivo mais atual
  • Reajuste do Escalonamento: retorna o valor do Escalonamento no momento da sua Efetivação. Como o valor do Escalonamento não pode ser alterado por Aditivos, essa parâmetro sempre retorna o valor original do Escalonamento

DTCONTRATOLOC: retorna a Data do Contrato de Locação do contexto
DTVENCCONTLOC: retorna a Data de 1° vencimento do Contrato de Locação do contexto
TAXAADMCONTLOC: retorna o percentual da Taxa de administração do Contrato de Locação do contexto
TAXAINTERMEDCONTLOC: retorna o percentual da Taxa de Intermediação do Contrato de Locação do contexto
DEFASAGEMCOTACAOLOC: retorna o valor da Defasagem da Cotação que será utilizada no reajuste do contexto
COTACAOACUMULADA: retorna se é verdadeiro ou falso o parâmetro "Capitalizado (Correção sobre Correção)" do Contrato de Locação do contexto
DTVIGENCIAINICONTLOC: retorna a Data do Início de vigência do Contrato de Locação do contexto
DTVIGENCIAFINCONTLOC: retorna a Data do Final de Vigência do Contrato de Locação do contexto
DTVIGENCIAPRORROGCONTLOC: retorna a Data da Prorrogação de Vigência do Contrato de Locação do contexto
DTPROXIMOREAJUSTELOC: retorna a Data do Próximo Reajuste do Contrato de Locação do contexto
DTLOCACAOINICONTLOC: retorna a Data do Início de locação (período) do Contrato de Locação do contexto
DATABASECONTLOC: retorna a Data base do Contrato de Locação do contexto
TXREPASSEJUROS: retorna o percentual de Taxa de Repasse dos Juros do Contrato de Locação do contexto
TXREPASSEMULTA: retorna o percentual de Taxa de Repasse de Multa do Contrato de Locação do contexto
TXREPASSEDESCONTO: retorna o percentual de Taxa de Repasse do Desconto do Contrato de Locação do contexto
PERCDESCONTOCONTLOC: retorna o percentual de Desconto do Contrato de Locação do contexto
TIPODESCONTO: retorna o valor do Tipo de Desconto do Contrato de Locação do contexto
REAJUSTADESCONTO: retorna verdadeiro ou falso de acordo com o parâmetro "Aplica reajuste no desconto" do Contrato de Locação do contexto
DATAPRIMEIROPERIODO: retorna a Data do Fim do primeiro período do Contrato de Locação do contexto
CARENCIAALUGUEL: retorna o número de dias da carência do Contrato de Locação do contexto;
AREALOCADA: retorna o valor da Área Locada do Contrato de Locação do contexto, caso o mesmo possua imóveis do tipo "Áreas Fracionadas" ou "Áreas Unificadas";
CODCOLIGADACONTRATOLOCACAO: retorna o número da Coligada do Contrato de Locação do contexto;
CODCONTRATOLOCACAO: retorna o número do Código do Contrato de Locação do contexto;
VALORBASE: retorna o valor atual a ser reajustado do Contrato de Locação do contexto;
DATREAJUSTE: retorna a data do Reajuste do Contrato de Locação do contexto;
PERIODICIDACONTLOC: retorna o número da Periodicidade do Reajuste do Contrato de Locação;
SIMBOLOCONTLOC: retorna a moeda do índice do Reajuste do contexto;
VARIACAOPERIODO: retorna a variação do período de um reajuste do Contrato de Locação do contexto;

86. VALORLIQUIDOPFTIN
Retorna o valor líquido do lançamento com origem no TOTVS Incorporação, calculado sob a mesma regra da Ficha Financeira do TOTVS Incorporação

86.1 - Contexto

A fórmula não depende de um contexto específico pois recebe todas as informações necessárias para o cálculo nos parâmetros

86.2 - Sintaxe
VALORLIQUIDOPFTIN(COLIGADA, IDLAN, DATABASE)

• • COLIGADA e IDLAN indicam qual lançamento deve ter o valor líquido calculado
  • DATABASE - indica qual a data de referência para cálculo dos valores financeiros, como multa e juros

87. ALGSOMATORIODESCONTOSCONTRATO
Retorna o somatório dos valores de descontos aplicados aos laçamentos baixados do contrato de locação.

Para lançamentos totalmente ou parcialmente baixados, são considerados descontos os escalonamentos que diminuem o valor do aluguel, seja pelo valor direto do escalonamento ou por desconto no próprio escalonamento, eventos financeiros a pagar ao locatário que gerem valores no lançamento que diminuam o valor do aluguel e ,por fim, apenas para lançamentos totalmente baixados, são considerados também os descontos financeiros dados no momento da baixa.

86.1 - Contexto

A fórmula não depende de um contexto específico pois recebe todas as informações necessárias para o cálculo nos parâmetros

86.2 - Sintaxe
ALGSOMATORIODESCONTOSCONTRATO(CODCOLIGADA, CODCONTRATOLOCACAO, CONSIDERAVLRINTEGRACAO)

• • CODCOLIGADA  - Coligada do contrato de locação do qual se deseja o somatório
  • CODCONTRATOLOCACAO - Código do contrato de locação do qual se deseja o somatório
  • CONSIDERAVLRINTEGRACAO - Caso o valor passado seja true os valores de integração com ação desconta no lançamento serão considerados, caso o valor seja false, estes serão ignorados. Por exemplo, valores provenientes de Eventos Financeiros agregados com ação a pagar ao locatário são representados por valores de integração com ação desconta.

88. ALGSOMATORIODESCONTOSESCALONAMENTOCONTRATO

Retorna o somatório dos descontos provenientes de escalonamentos no contrato de locação. A função tomará como base para o cálculo a data do distrato do contrato de locação, ou seja, na data de distrato, se houver algum escalonamento que já foi iniciado e ainda não foi concluído, os descontos concedidos nos mesmos serão somados e o valor será retornado na função. Por "escalonamento não concluído", entende-se todos aqueles escalonamentos que possuírem, antes do fim de seu período, pelo menos um lançamento com status diferente de baixado.  Serão considerados distratos as rescisões e/ou aditivos de exclusão de imóvel do contrato.

No cálculo do somatório, para cada escalonamento não concluído, serão verificados quais dos lançamentos foram baixados e os respectivos valores de desconto concedidos via escalonamento serão somados. Exemplo:

Escalonamento 1 | 01/01/2020 - 31/05/2020

Data do Distrato: 20/05/2020

Valor de desconto: R$ 100,00

Lançamento 1 - Baixado

Lançamento 2 - Baixado

Lançamento 3 - Baixado

Lançamento 4 - Em aberto

Lançamento 5 - Em aberto

Neste caso, o valor retornado na função seria R$ 300,00 referente a R$100,00 de desconto concedido em cada um dos três primeiros lançamentos.

Obs.:

• Somente serão considerados como descontos, aqueles escalonamentos que possuírem o campo "Valor" ou "Percentual" preenchido e não forem do tipo acréscimo. Caso contrário a função considerará que não houve desconto.
• Caso o escalonamento tenha sido reajustado, o valor de desconto considerado será o do último reajuste antes da data de rescisão.
• Caso o escalonamento seja por metro quadrado, o valor de desconto considerado será o produto do valor de desconto pela área total do contrato no período do lançamento em questão.
• Caso exista mais de um escalonamento no mesmo período de um lançamento, será considerado o escalonamento de maior prioridade.
• No contexto do Aditivo de Exclusão de imóvel, a função de fórmula precisa estar incluída na fórmula da multa do aditivo, contudo não é possível executar a função a partir do cadastro da multa, somente do cadastro de aditivo. Isto acontece pois uma multa pode estar associada a mais de um aditivo, o que torna inviável saber qual aditivo deve ser considerado no momento do cálculo.

86.1 - Contexto

Rescisão do Contrato de Locação, Aditivo de Exclusão de Imóvel

86.2 - Sintaxe
ALGSOMATORIODESCONTOSCONTRATO