Para a A parametrização da Lei de Responsabilidade Fiscal - LRF , se utiliza de comandos programáveis, que são interpretados pelas linhas do relatório , retornando um valor específico de acordo e retornam valores específicos conforme os comandos solicitadosdefinidos.
A parametrização personalizada é acessível a todos usuários que necessitam alterar o valor de uma linha específica do relatório.
Expressões
A configuração da parametrização é feita por meio de expressões. Tais expressões vão selecionar os registros que serão considerados ao visualizar ou exportar o relatório. A parametrização sempre inicia-se com a palavra return, conforme exemplo.
| Tip |
|---|
Exemplo Expressão 01 |
{panel:title=Exemplo Expressão 01}
return ...
{panel}
Em seguida, começa-se a fazer seleção dos registros que serão considerados. Para isso, faz-se uso das funções, como por exemplo, isReceitaFUNDEB() que ao criar o relatório considerará somente as receitas redutoras do FUNDEB. Para utilizar as funções, basta escrever registro.nomeDaFunção. Conforme exemplo.{panel:title=
| Tip |
|---|
Exemplo Expressão 02 |
...
|
{panel}
Quando se faz necessário especificar ainda mais os registros a considerar, deve-se usar um dos *operadores básicos* + outra função. Supondo que desejamos considerar os valores das receitas redutoras do FUNDEB e que sua natureza seja 17220101 ou 17220102. Segue exemplo.{panel:title=
| Tip |
|---|
Exemplo Expressão 03 |
...
|
...
| Note |
|---|
...
O ponto e vírgula ";" delimita o fim da expressão, logo deve estar sempre presente no fim da expressão. |
{note}A expressão não tem um número limite de restrições, ou seja, é possível fazer as restrições dos registros confirme sua necessidade. Sempre adicionando um operador lógico entre cada função. *Em seguida será apresentado mais sobre os operadores, parâmetros, tipos de dados e uma lista completa com todas as funções disponíveis e suas utilidades.*h5.
Operadores Básicos
...
| Operador | Objetivo | Exemplo |
|---|---|---|
&& |
...
| É o operador entre duas expressões que retorna verdadeiro quando ambas expressões forem verdadeiras. |
{panel:title=Exemplo Operador E (and) &&}
...
Com essa parametrização, será considerado os valores das receitas da natureza “ 17220101” ou “ 17220102” que sejam redutoras da FUNDEB. |
{panel}
h6. _||_ - Operador OU (or)
return registro.isReceitaFUNDEB() && registro.isNaturezaReceita("17220101","17220102"); | |
| || | É o operador entre duas expressões que retorna verdadeiro quando uma das expressões forem verdadeiras. |
...
| Com essa parametrização, será considerado todos os valores |
...
| das receitas redutoras da FUNDEB |
...
| , exceto os valores |
...
| das receitas que possuem |
...
{panel}
h6. ! - Negação (not)
Tem por objetico inverter o resultado da expressão.
{panel:title=Exemplo Operador De Negação (not) !}
...
| "17220101" ou "17220102" como natureza. return registro.isReceitaFUNDEB() |
...
| || registro.isNaturezaReceita("17220101","17220102"); |
...
| ! | Tem por objetivo inverter o resultado da expressão. | Com essa parametrização, será considerado todos os valores das receitas redutoras da FUNDEB, exceto os valores das receitas que possuem "17220101" ou "17220102" como natureza. |
{panel}
...
| return registro.isReceitaFUNDEB() && !registro.isNaturezaReceita("17220101","17220102"); |
Exemplo de Lógica Geral
...
{color:blue}Automovel_1 é do tipo sedan de cor vermelho
Automovel_2 é do tipo sedan de cor verde e é flex
Automovel_3 é do tipo conversível de cor verde{color}*Expressão:*
| Expressão | Objetivo | Resultado |
|---|---|---|
| (getCor() == verde) |
...
| Considera os carros verdes |
...
...
| Automovel_2, Automovel_3 |
...
| (getCor() == vermelho) && (getTipo() == sedan) |
...
| Considera os carros vermelhos e |
...
| sedan |
...
...
| Automovel_1 |
...
| (getCor() == verde) && (getTipo() == sedan) |
...
| Considera os carros verdes e sedan | Automovel_2 |
...
| (getCor() == vermelho) |
...
| || |
...
| (getTipo() == conversivel) |
...
| Considera os carros vermelhos ou conversíveis |
...
...
| Automovel_1, Automovel_3 |
...
| !(getCor() == vermelho) |
...
| Considera os carros que não são vermelhos | Automovel_2, Automovel_3 |
...
| (!isFlex()) |
...
| Considera os carros que não(!) são flex |
...
...
| Automovel_1, Automovel_3 |
{panel}
...
Parâmetros e tipos de dados.
Parâmetros são as informações necessárias para funcionamento das funções, temos como tipo de parâmetros:
* *Integer e int:* Para Integer e int deve-se usar apenas números.
* *String:* Para String pode-se usar qualquer tipo de caractere, desde que estejam circundados por “”(aspas), “1234567890” e “abc123” são exemplos de String.
Quando a função apresenta … (reticências) após o tipo do parâmetro, representa que pode-se informar um número indeterminado de parâmetro separando-os por vírgula. Por outro lado, quando a função não tem parâmetros não se deve informar nada.
*Exemplos de parâmetros:*
| Função | Exemplo |
|---|---|
| isNaturezaReceita(Stringtexto...) | IsNaturezaReceita(“11111”,”12315”,”1a2b3s”) |
| isNivel(Stringtexto) | isNivel(“1”) |
| isReceita(intnúmero) | isReceita(5) |
| isDespesa(int…número...) | isDespesa(1,3,6,5,8) |
| isDespesaGrupo(Integertexto) | IsDespesaGrupo(3) |
| isReceitaRealizada() | isReceitaRealizada() |
Funções disponíveis
As funções abaixo podem retornar valores para serem comparados dentro da expressão, ou também retornar Verdadeiro ou Falso para determinada situação.
h6.
Classificação da Despesa Orçamentária
...
| Função |
|---|
...
| Descrição |
|---|
...
...
| getDespesaCategoriaEconomica() |
...
| Retorna o código da categoria econômica |
...
...
| getDespesaDetalhamento() |
...
| Retorna o código do detalhamento da despesa |
...
...
| getDespesaElemento() |
...
| Retorna o código do elemento da despesa |
...
...
| getDespesaGrupo() |
...
| Retorna o código do grupo da despesa |
...
...
| getDespesaModalidadeAplicacao() |
...
| Retorna o código da modalidade de aplicação da despesa |
...
...
| getFuncao() |
...
| Retorna o código da função da despesa |
...
...
| getIdDespesa() |
...
| Retorna o código da despesa |
...
...
| getIdEmpenho() |
...
| Retorna o código do empenho |
...
...
| getSubfuncao() |
...
| Retorna a subfunção |
...
...
| isDespesa( |
...
| número...) |
...
| Considera os valores das despesas informadas |
...
...
| isDespesaAcao( |
...
| número...) |
...
| Considera os valores das despesas pertencentes a ação informada |
...
...
| isDespesaCategoriaEconomica( |
...
| número...) |
...
| Considera os valores das despesas pertencentes a categoria econômica informada |
...
...
| isDespesaCategoriaEconomica( |
...
| número) |
...
| Considera os valores das despesas pertencentes a categoria econômica informada |
...
...
| isDespesaDetalhamento( |
...
| número) |
...
| Considera os valores das despesas pertencentes ao detalhamento informado |
...
...
| isDespesaElemento( |
...
| número...) |
...
| Considera os valores das despesas pertencentes ao elemento informado |
...
...
| isDespesaElemento( |
...
| número) |
...
| Considera os valores das despesas pertencentes ao elemento informado |
...
...
| isDespesaGrupo( |
...
| número...) |
...
| Considera os valores das despesas pertencentes ao grupo informado |
...
...
| isDespesaGrupo( |
...
| número) |
...
| Considera os valores das despesas pertencentes ao grupo informado |
...
...
| isDespesaModalidadeAplicacao( |
...
| número...) |
...
| Considera os valores das despesas pertencentes a modalidade informada |
...
...
| isDespesaModalidadeAplicacao( |
...
| número) |
...
| Considera os valores da despesa pertencentes a modalidade informada |
...
...
| isDespesaPrograma( |
...
| número...) |
...
| Considera os valores das despesas pertencentes ao programa informado |
...
...
| isDespesaTipoAcao( |
...
| número...) |
...
| Considera os valores das despesas pertencentes ao tipo da ação informada |
...
...
| isEmpenhoControle( |
...
| número) |
...
| Considera os valores dos empenhos do controle informado |
...
...
| isFuncao( |
...
| número...) |
...
| Considera os valores das despesas da função informada |
...
...
| isItemDespesa() |
...
| Considera os valores dos movimentos de empenho enquadrados no item despesa informado |
...
...
| isModalidaIntraOrcamentaria() |
...
| Considera os valores dos movimentos de despesas intra-orçamentárias |
...
...
| isNaturezaDespesa() |
...
| Considera os valores das despesas pertencentes a natureza informada |
...
...
| isSubFuncao( |
...
| número...) |
...
| Considera os valores dos movimentos das despesas cuja subfunção seja igual a subfunção informada |
...
...
Previsão e Execução da Despesa Orçamentária (Valores)
...
| Função |
|---|
...
| Descrição |
|---|
...
...
| isALiquidar() |
...
| Considera os valores do saldo a liquidar |
...
...
| isAnulado() |
...
| Considera os valores dos movimentos de anulação do empenho |
...
...
| isCreditosEspeciais() |
...
| Considera os valores dos movimentos de créditos especiais |
...
...
| isCreditosExtraordinarios() |
...
| Considera os valores dos movimentos de créditos extraordinários |
...
...
| isDotacaoAtualizada() |
...
| Considera os valores dos movimentos de atualização da despesa |
...
...
| isEmLiquidacao() |
...
| Considera os valores dos movimentos de em liquidação |
...
...
| isEmpenhado() |
...
| Considera os valores empenhados |
...
...
| isFixado() |
...
| Considera os valores dos movimentos de fixação da despesa |
...
...
| isLiquidado() |
...
| Considera os valores dos movimentos de liquidação |
...
...
| isPagamento() |
...
| Considera os valores dos movimentos de pagamento de empenho |
...
...
| isPagamentoRetencaoEmpenhoOrcamentario() |
...
| Considera os valores dos movimentos de pagamento de retenção de empenhos orçamentários |
...
...
| isRetidoConsignado() |
...
| Considera os valores das retenções de empenho |
...
...
| isSuplementado() |
...
| Considera os valores dos movimentos de suplementação orçamentárias |
...
...
Restos a Pagar
...
| Função |
|---|
...
| Descrição |
|---|
...
...
| isCancelado() |
...
| Considera os valores dos movimentos de cancelamento de restos a pagar |
...
...
| isCancelamentoRestosPagarNaoProcessados() |
...
| Considera os valores dos movimentos de cancelamento de restos a pagar não processados |
...
...
| isCancelamentoRestosPagarProcNaoProcLiquidado() |
...
| Considera os valores dos movimentos de cancelamento de restos a pagar |
...
...
| isInscricaoRestosPagarNaoProcessados() |
...
| Considera os valores inscritos em restos a pagar não processados |
...
...
| isInscricaoRestosPagarNaoProcessadosNoExercicio() |
...
| Considera os valores inscritos em restos a pagar não processados no exercício atual |
...
...
| isInscricaoRestosPagarProcNaoProcLiquidado() |
...
| Considera os valores dos movimentos de liquidação de restos a pagar |
...
...
| isLiquidacaoRestosPagarNaoProcessados() |
...
| Considera os valores dos movimentos de liquidação de restos a pagar não processados |
...
...
| isPagamentoProcNaoProcLiquidado() |
...
| Considera os valores dos movimentos de restos a pagar |
...
...
| isPagamentoRestosPagarNaoProcessados() |
...
| Considera os valores dos movimentos de pagamento de restos a pagar não processados |
...
...
| isPagamentoRetencaoRestosAPagar() |
...
| Considera os valores dos movimentos de pagamento de retenção de empenhos de restos a pagar |
...
...
Classificação da Receita Orçamentária
...
| Função |
|---|
...
| Descrição |
|---|
...
...
| getIdReceita() |
...
| Retorna o código da receita |
...
...
| getNaturezaReceita() |
...
| Retorna o código da natureza da receita sem formatação |
...
...
| getTipoReceita() |
...
| Retorna o tipo da receita |
...
...
| isNaturezaReceita(String...) |
...
| Considera os valores das receitas pertencentes a natureza informada |
...
...
| isNaturezaReceitaDiferente(String...) |
...
| Considera os valores das receitas com a natureza diferente da informada |
...
...
| isReceita(int...) |
...
| Considera os valores dos movimentos das receitas informadas |
...
...
| isReceitaDividaAtiva() |
...
| Considera todas as receitas com o sétimo nível da natureza = 3. |
...
...
| isReceitaMultasJuros() |
...
| Considera todas as receitas com o sétimo nível da natureza = 2. |
...
...
| isReceitaMultasJurosDividaAtiva() |
...
| Considera todas as receitas com o sétimo nível da natureza = 4. |
...
...
| isReceitaPrincipal() |
...
| Considera todas as receitas com o sétimo nível da natureza = 1. |
...
...
Previsão e Execução da Receita
...
| Função |
|---|
...
| Descrição |
|---|
...
...
| isDeducaoReceita() |
...
| Considera os valores dos movimentos de dedução da receita |
...
...
| isPrevisaoAtualizada() |
...
| Considera os valores dos movimentos de atualização da previsão da receita |
...
...
| isPrevisaoReceita() |
...
| Considera os valores dos movimentos de previsão da receita |
...
...
| isReceitaBruta() |
...
| Considera os valores das receitas brutas |
...
...
| isReceitaFpm() |
...
| Considera os valores dos movimentos das receitas de FPM. |
...
...
| isReceitaFpmComplementacao() |
...
| Considera os valores das complementações do FPM. |
...
...
| isReceitaFUNDEB() |
...
| Considera os valores das receitas redutoras do FUNDEB. |
...
...
| isReceitaRealizada() |
...
| Considera as receitas realizadas |
...
...
| isReduzido() |
...
| Considera os valores dos movimentos de redução da receita |
...
...
| isReconhecimentoReceita() |
...
| Considera os valores dos movimentos de reconhecimento da receita |
...
...
Fonte de Recursos
...
| Função |
|---|
...
| Descrição |
|---|
...
...
| getCodigoFonteRecurso() |
...
| Retorna o código reduzido da fonte de recursos |
...
...
| getDetalhamentoDestinacaoRecurso() |
...
| Retorna o código do detalhamento da destinação de recurso |
...
...
| getEspecificacaoDestinacaoRecurso() |
...
| Retorna o código da especificação da destinação de recurso |
...
...
| getGrupoDestinacaoRecurso() |
...
| Retorna o código do grupo de destinação de recurso |
...
...
| getIdentificacaoUso() |
...
| Retorna o código da identificação de uso |
...
...
| isEspecificacaoDestinacaoRecurso(int...) |
...
| Considera os valores das despesas cuja especificação da destinação de recurso é igual a especificação informada |
...
...
| isFonteRecursoProprio() |
...
| Considera os valores das despesas cuja fonte de recurso é do tipo próprio |
...
...
| isFonteRecursoVinculado() |
...
| Considera os valores das despesas cuja fonte de recurso é do tipo vinculado |
...
...
| isTipoSTN() |
...
| Considera os valores das despesas pertencentes ao Tipo STN informado no parâmetro |
...
...
| isDestinacaoSTN() |
...
| Considera os valores das despesas pertencentes à Destinação STN informada no parâmetro |
...
...
| isDetalhamentoSTN() |
...
| Considera os valores das despesas pertencentes ao Detalhamento STN informado no parâmetro |
...
...
| isComplementoSTN() |
...
| Considera os valores das despesas pertencentes ao Complemento STN informado no parâmetro |
...
...
| isMarcadorSTN() |
...
| Considera os valores das despesas pertencentes ao Marcador STN informado no parâmetro |
...
...
Contábil
...
| Função |
|---|
...
| Descrição |
|---|
...
...
| getCodigoEvento() |
...
| Retorna o código do evento utilizado no movimento |
...
...
| getContaPlano() |
...
| Retorna o código do plano de contas |
...
...
| getContaPlanoIndicador() |
...
| Retorna o tipo do indicador do plano de contas |
...
...
| getDataMovimento() |
...
| Retorna a data de movimento |
...
...
| getId() |
...
| Retorna o código do movimento de contabilização |
...
...
| getIdContaContabil() |
...
| Retorna o código da conta contábil |
...
...
| getTipoLancamento() |
...
| Retorna o tipo do lançamento contábil |
...
...
| getTipoMovimento() |
...
| Retorna o tipo do movimento |
...
...
| getTipoMovimentoContabil() |
...
| Retorna o tipo do movimento contábil |
...
...
| getValor() |
...
| Retorna o valor do lançamento contábil |
...
...
| isAbertura() |
...
| Considera os valores dos movimentos do tipo implantação de saldo |
...
...
| isContabil() |
...
| Considera os valores dos movimentos do grupo contábil |
...
...
| isCredito() |
...
| Considera os valores dos movimentos a crédito |
...
...
| isCreditoLiquido() |
...
| Considera os valores dos movimentos de crédito e estorno de crédito |
...
...
| isDebito() |
...
| Considera os valores dos movimentos a débito |
...
...
| isDebitoLiquido() |
...
| Considera os valores dos movimentos de débito e estornos de débito |
...
...
| isEvento(int...) |
...
| Considera os valores dos movimentos realizados com o evento informado |
...
...
| isFechamento() |
...
| Considera os valores dos movimentos de fechamento de balanço |
...
...
| isFinanceiro() |
...
| Considera os valores cujo tipo do indicador do plano de conta é financeiro |
...
...
| isInscricaoSaldo() |
...
| Considera os valores dos movimentos de inscrição de saldo |
...
...
| isMista() |
...
| Considera os valores cujo tipo do indicador do plano de conta é misto |
...
...
| isMovimentoMensal() |
...
| Considera os valores dos movimentos mensais (não considera lançamentos de implantação de saldos e fechamento de balanço). |
...
...
| isNivel(String) |
...
| Considera os valores dos movimentos do nível PCASP informado |
...
...
| isPermanente() |
...
| Considera os valores cujo tipo do indicador do plano de conta é permanente |
...
...
Genéricos
...
| Função |
|---|
...
| Descrição |
|---|
...
...
| getIdUnidadeGestora() |
...
| Retorna o código da unidade gestora |
...
...
| getNomeConsorcio() |
...
| Retorna o nome do consórcio |
...