Versões comparadas

Chave

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

A As funções de fórmula tem por objetivo permitir aos cliente clientes customizar o cálculo dos valores a serem gerados nos lançamentolançamentos/partidas e seus respectivos rateios para efeitos de contabilização das operações patrimoniais (aquisição, depreciação, baixa, correção monetária, transferência, entre outras).


Aviso

Em geral, o contexto de execução das fórmulas será o patrimônio processado durante a contabilização, mas outros contextos podem ser utilizados para a execução da fórmula conforme o tipo de operação que está sendo contabiulizadocontabilizado. Nestes caso casos a documentação da contabilização da operação mencionará suas particularidades (Contabilização - Gestão Patrimonial).

01.  Funções de Fórmula

...

Column
Expandir
titleACRESCIMO
  • Descrição:
    • A função retorna o valor que representa o tipo de ocorrência de Acréscimo no patrimônio (70).
  • Parâmetros:

    • Não possui.

  • Exemplo: 
    • ACRESCIMO() - O resultado será 70
Expandir
titleBAIXAPARCIAL
  • Descrição:
    • A função retorna o valor que representa o tipo de ocorrência de Baixa Parcial no patrimônio (90).
  • Parâmetros:

    • Não possui.

  • Exemplo: 
    • BAIXAPARCIAL() - O resultado será 90
Expandir
titleBAIXAPERIODOANTERIOR
  • Descrição:
    • A função retorna o valor que representa o tipo de ocorrência para Baixa de Período Anterior no patrimônio (100).
  • Parâmetros:
    • Não possui.
  • Exemplo: 
    • BAIXAPERIODOANTERIOR() - O resultado será 100
Expandir
titleBAIXATOTAL
  • Descrição:
    • A função retorna o valor que representa o tipo de ocorrência de Baixa Total no patrimônio (99).
  • Parâmetros:
    • Não possui.
  • Exemplo:
    • BAIXATOTAL() - O resultado será 99
Expandir
titleCAMPOBEM
  • Descrição:
    • A função recebe um campo como parâmetro e retorna o valor correspondente da tabela IBEM. Caso não haja dados da IBEM, busca-se dados compatíveis na tabela IPATRIMONIO. Se o campo não existir nas tabelas, uma exceção será lançada.
  • Parâmetros:
    • Campo (string): O nome do campo desejado. Possíveis valores: Todos os campos da tabela IBEM ou IPATRIMONIO
  • Exemplo:
    • CAMPOBEM("DESCRICAO") - O resultado será o valor do campo "Descrição".
Expandir
titleCAMPOBEMCOMPL
  • Descrição:
    • A função recebe um campo como parâmetro e retorna o valor correspondente da tabela IPATRIMONIOCOMPL. Se o campo não existir na tabela, uma exceção será lançada.
  • Parâmetros:
    • Campo (string): O nome do campo desejado. Possíveis valores: Todos os campos da tabela IPATRIMONIOCOMPL
  • Exemplo:
    • CAMPOBEMCOMPL("PLACA") - O resultado será o valor do campo "Placa".
Expandir
titleCAMPOBEMTRANSFERENCIA
  • Descrição:
    • A função recebe um campo como parâmetro e retorna o valor correspondente da tabela IPATRIMONIOTRANSFERENCIA. Se o campo não existir na tabela, uma exceção será lançada.
  • Parâmetros:
    • Campo (string): O nome do campo desejado. Possíveis valores: Todos os campos da tabela IPATRIMONIOTRANSFERENCIA.
  • Exemplo:
    • CAMPOBEMTRANSFERENCIA("CODFILIALORIGEM") - O resultado será o valor do campo "CodFilialOrigem".
Expandir
titleCAMPOCALCULORAZAO
  • Descrição:
    • A função recebe um campo como parâmetro e retorna o valor correspondente da tabela ICALCULORAZAO, convertido para o tipo indicado. Se o campo não existir na tabela ou o tipo indicado for incorreto, uma exceção será lançada.
  • Parâmetros:
    • Campo (string): O nome do campo desejado. Possíveis valores: Todos os campos da tabela ICALCULORAZAO.
    • Tipo (string): Indica o tipo de dado esperado para o retorno. Os possíveis valores são:
      1. "V": Para valores numéricos de ponto flutuante.
      2. "I": Para valores inteiros.
      3. "D": Para datas.
      4. "S": Para strings.
  • Exemplo:
    • CAMPOCALCULORAZAO("TAXADEPRECIACAOPERIODO", "V") - O resultado será o valor do campo "TaxaDepreciacaoPeriodo" convertido para um valor numérico.
Expandir
titleCAMPOOCORRENCIA
  • Descrição:
    • A função recebe um campo como parâmetro e retorna o valor correspondente da tabela IOCORRENCIA. Se o campo não existir na tabela, uma exceção será lançada.
  • Parâmetros:
    • Campo (string): O nome do campo desejado. Possíveis valores: Todos os campos da tabela IOCORRENCIA.
  • Exemplo:
    • CAMPOOCORRENCIA("VALORVENDA") - O resultado será o valor do campo "ValorVenda".
Expandir
titleCAMPOPATRIMONIO
  • Descrição: A função recebe um campo como parâmetro e retorna o valor correspondente da tabela IPATRIMONIO, convertido para o tipo indicado. Se o campo não existir na tabela ou o tipo indicado for incorreto, uma exceção será lançada.
  • Parâmetros:
    • Campo (string): O nome do campo desejado. Possíveis valores: Todos os campos da tabela IPATRIMONIO.
    • Tipo (string): Indica o tipo de dado esperado para o retorno. Os possíveis valores são:
      1. "V": Para valores numéricos de ponto flutuante.
      2. "I": Para valores inteiros.
      3. "D": Para datas.
      4. "S": Para strings.
  • Exemplo:
    • CAMPOPATRIMONIO("DESCRICAO", "S") - O resultado será o valor do campo "Descrição" convertido para um texto.
Nota
titleOBSERVAÇÃO

As funções listadas que trazem dados de tabelas devem ser utilizadas preferencialmente por fórmulas que trabalhem com determinados contextos para o correto funcionamento das mesmas.