Histórico da Página

EXTENSODATA
Retorna uma data por extenso

...

PARMQRY  
Retorna o conteúdo de um campo.

• Sintaxe
  

...

• PARMQRY(

...

• ' CAMPO ' )
• Exemplo 
  

...

• Exemplo da função PARMQRY  retornando campos dos fatores de CRD:

(PARMQRY('FATOR01').value + 
PARMQRY('FATOR02').value +
PARMQRY('FATOR03').value +
PARMQRY('FATOR04').value +
PARMQRY('FATOR05').value +
PARMQRY('FATOR06').value +
PARMQRY('FATOR07').value +
PARMQRY('FATOR08').value) / 1000

EXTENSODATA
Retorna uma data por

• • DATA – Data a ser retorna por extenso

Exemplo
EXTENSODATA('20/03/2010')

EXTENSONUMERO
Retorna um número por extenso

Contexto
Independente do contextoVALORLIQUIDOPFTIN

Sintaxe
EXTENSONUMERO EXTENSODATA ( VALOR DATA )
A sintaxe da função EXTENSONUMERO 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.):

• • VALOR DATA – Número Data a ser retornado retorna por extenso

Exemplo
EXTENSONUMERO(1453EXTENSODATA('20/03/2010')

EXTENSONUMEROEXTENSOVALOR
Retorna um valor número por extenso

Contexto
Independente do contexto

Sintaxe
EXTENSOVALOR EXTENSONUMERO ( VALOR )
A sintaxe da função EXTENSOVALOR 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 – Valor Número a ser retornado por extenso

Exemplo
EXTENSOVALOREXTENSONUMERO(156.141453)

EXTENSOVALORFORMATANUMERO
Retorna um número formatado em inteirovalor por extenso

Contexto
Independente do contexto

Sintaxe
FORMATANUMERO EXTENSOVALOR ( VALOR )
A sintaxe da função FORMATANUMERO 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 formatado para o padrão inteiroretornado por extenso

Exemplo
FORMATANUMEROEXTENSOVALOR(156.14)

FORMATANUMEROFORMATAVALOR
Retorna um valor número formatado em moedainteiro

Contexto
Independente do contexto

Sintaxe
FORMATAVALOR FORMATANUMERO ( VALOR )
A sintaxe da função FORMATAVALOR 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 moedainteiro

Exemplo
FORMATAVALORFORMATANUMERO(152156.614)

FORMATAVALORDIFERENCADIAS
Retorna a Diferença de dias entre duas datasum valor formatado em moeda

Contexto
Independente do contexto

Sintaxe
DIFERENCADIAS FORMATAVALOR ( DATA1, DATA2 VALOR )
A sintaxe da função DIFERENCADIAS 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.):

• • DATA1 – Primeira Data
  • DATA2 – Segunda DataVALOR – Valor a ser formatado para o padrão moeda

Exemplo
DIFERENCADIAS('10/03/2012','10/02/2012')FORMATAVALOR(152.6)

DIFERENCADIASDIFERENCAMESES
Retorna a Diferença de meses dias entre duas datas

Contexto
Independente do contexto

Sintaxe
DIFERENCAMESES DIFERENCADIAS ( DATA1, DATA2 )
A sintaxe da função DIFERENCAMESES 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

Exemplo
DIFERENCAMESESDIFERENCADIAS('10/03/2012','10/02/2012')

DIFERENCAMESESADICIONADIAS
Adiciona Dias a uma DataRetorna a Diferença de meses entre duas datas

Contexto
Independente do contexto

Sintaxe
ADICIONADIAS DIFERENCAMESES ( STRING, DATA1, DATA2 , DATA3, VALOR1, VALOR2 )
A sintaxe da função ADICIONADIAS 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.):

• • DATA DATA1 – Primeira Data para adicionar dias
  • DIAS – Dias a ser adicionado a uma data
  • DATA2 – Segunda Data

Exemplo
DIFERENCAMESESExemplo
ADICIONADIAS('10/03/2012','10/02/2012')

ADICIONADIASADICIONAMESES
Adiciona Meses Dias a uma Data

Contexto
Independente do contexto

Sintaxe
ADICIONAMESES ( DATA, MESESADICIONADIAS ( STRING, DATA1, DATA2, DATA3, VALOR1, VALOR2 )
A sintaxe da função ADICIONAMESES 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
  • MESES DIAS – Meses Dias a ser adicionado a uma data

Exemplo
ADICIONAMESESADICIONADIAS('10/03/2012',10)

ADICIONAMESESADICIONAANOS
Adiciona Anos Meses a uma Data

Contexto
Independente do contexto

Sintaxe
ADICIONAANOS ADICIONAMESES ( DATA, ANOS MESES)
A sintaxe da função ADICIONAANOS 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

Exemplo
ADICIONAANOSADICIONAMESES('10/03/2012',10)

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

Contexto
Chave da tabela "XALGEVENTOFINANCEIRO"

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).

Exemplo
ALGTABELAEVENTOFINANCEIRO('DATAEVENTFIN','D')

ADICIONAANOS
Adiciona Anos a uma Data

Contexto
Independente do contexto

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

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

ALGTABELAEVENTOFINANCEIROALGTABELAEVENTOFINANCEIRODISTRIBUICAO
Retorna informações sobre o registro da tabela XALGEVENTOFINANCEIRODISTRIBUIC XALGEVENTOFINANCEIRO carregada no contexto

Contexto
Chave da tabela "XALGEVENTOFINANCEIRODISTRIBUICXALGEVENTOFINANCEIRO"

Sintaxe
ALGTABELAEVENTOFINANCEIRODISTRIBUICAO 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).

Exemplo
ALGTABELAEVENTOFINANCEIRODISTRIBUICAOALGTABELAEVENTOFINANCEIRO('CODEVENTFINDATAEVENTFIN','ID')

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

Contexto
Usa como contexto a chave 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)

Sintaxe
ALGVALORESLANCAMENTOFINANCEIRO(DataReference, ValorRetorno)

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).

Exemplo
ALGTABELAEVENTOFINANCEIRODISTRIBUICAO('CODEVENTFIN','I')

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

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)

Sintaxe
ALGVALORESLANCAMENTOFINANCEIRO(DataReference, ValorRetorno)

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

...

ALGSOMATORIODESCONTOSCONTRATO

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

...

• • 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.

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.

...

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.

Contexto

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

Sintaxe
ALGSOMATORIODESCONTOSCONTRATO

ALGTABELACONTRATOLOCACAO

Retorna o valor de qualquer campo da tabela de contrato de locação, como por exemplo:

• Data de prorrogação de vigência;
• Início de vigência.

Sintaxe:

ALGTABELACONTRATOLOCACAO(Campo, Tipo Valor)

Parâmetros da função:

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

Exemplos:

ALGTABELACONTRATOLOCACAO('DTVIGENCIAPRORROGCONTLOC', 'D')
ALGTABELACONTRATOLOCACAO('DTVIGENCIAINICONTLOC', 'D');

ALGTABELAADITIVOCONTRATOLOCACAO

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

Sintaxe:

ALGTABELAADITIVOCONTRATOLOCACAO(Campo, Tipo Valor)

Parâmetros da função:

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

Exemplos:

ALGTABELAADITIVOCONTRATOLOCACAO('DATAADITIVOCONTLOC', 'D'));

VALORDISTRATOADITIVOEXCLUSAOIMOVEL

Retorna o valor do distrato no aditivo de exclusão de imóveis.

Contexto
Calculo de multa no aditivo de exclusão de imóvel.

Sintaxe

VALORDISTRATOADITIVOEXCLUSAOIMOVEL

Abaixo um modelo de fórmula utilizando as funções VALORDISTRATOADITIVOEXCLUSAOIMOVEL, ALGTABELAADITIVOCONTRATOLOCACAO e ALGTABELACONTRATOLOCACAO:

DECL valorDistrato;
 DECL valorDistratoPorDia;
 DECL totalDiasContrato;
 DECL diasRestantesImovelExcluido;
SETVAR (totalDiasContrato, ALGTABELACONTRATOLOCACAO('DTVIGENCIAPRORROGCONTLOC', 'D') - ALGTABELACONTRATOLOCACAO('DTVIGENCIAINICONTLOC', 'D'));
 SETVAR (diasRestantesImovelExcluido, ALGTABELACONTRATOLOCACAO('DTVIGENCIAPRORROGCONTLOC', 'D') - ALGTABELAADITIVOCONTRATOLOCACAO('DATAADITIVOCONTLOC', 'D'));
 SETVAR (valorDistrato, VALORDISTRATOADITIVOEXCLUSAOIMOVEL * 3);
 SETVAR (valorDistratoPorDia, valorDistrato / totalDiasContrato);
 valorDistratoPorDia * diasRestantesImovelExcluido;

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.

Contexto

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

Sintaxe
ALGSOMATORIODESCONTOSCONTRATO

ALGTABELACONTRATOLOCACAO

Retorna o valor de qualquer campo da tabela de contrato de locação, como por exemplo:

• Data de prorrogação de vigência;
• Início de vigência.

Sintaxe:

ALGTABELACONTRATOLOCACAO(Campo, Tipo Valor)

Parâmetros da função:

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

Exemplos:

ALGTABELACONTRATOLOCACAO('DTVIGENCIAPRORROGCONTLOC', 'D')
ALGTABELACONTRATOLOCACAO('DTVIGENCIAINICONTLOC', 'D');

ALGTABELAADITIVOCONTRATOLOCACAO

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

Sintaxe:

ALGTABELAADITIVOCONTRATOLOCACAO(Campo, Tipo Valor)

Parâmetros da função:

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

Exemplos:

ALGTABELAADITIVOCONTRATOLOCACAO('DATAADITIVOCONTLOC', 'D'));

VALORDISTRATOADITIVOEXCLUSAOIMOVEL

Retorna o valor do distrato no aditivo de exclusão de imóveis.

Contexto
Calculo de multa no aditivo de exclusão de imóvel.

Sintaxe

...