Ver código fonte para BI 2834 Comprovante Financeiro

[[Area_Business_Intelligence]]

==Origens do Relatório==

Este relatório foi desenvolvido para oferecer uma emissão simplificada e personalizada de comprovantes financeiros, abrangendo tanto pagamentos quanto recebimentos. Oferece flexibilidade na escolha da origem das informações a serem incluídas no comprovante, com três principais opções:

'''Grupo Baixa:''' Agrupa diversas baixas realizadas em um único comprovante, consolidando dados de várias transações.

'''Baixa do Título:''' Refere-se à baixa específica de um título, seja de pagamento ou recebimento, garantindo a rastreabilidade das operações.

'''Título:''' Emissão baseada diretamente no título financeiro, seja ele pago ou recebido, trazendo todas as informações essenciais associadas a ele

== Principais Funcionalidades ==
'''Emissão Personalizada:''' O cliente pode escolher a origem dos dados para compor o comprovante, ajustando conforme a necessidade específica (pagamento ou recebimento).

'''Relatórios Dinâmicos:''' Os dados podem ser organizados e visualizados de diferentes maneiras, permitindo análises mais detalhadas, como acompanhamento de fluxo de caixa, controle de recebíveis e gestão de contas a pagar.

'''Automatização do Processo:''' O processo de emissão de comprovantes é automatizado, reduzindo o esforço manual e minimizando erros. A geração pode ser feita em larga escala, atendendo tanto pequenas demandas quanto operações em massa.

'''Layout Personalizável:''' O cliente pode customizar o layout do relatório conforme suas necessidades, escolhendo quais campos incluir ou excluir e aplicando a formatação desejada para gerar relatórios visualmente compatíveis com o padrão da empresa. A emissão de comprovantes pode ser ajustada conforme a necessidade, fornecendo informações detalhadas de acordo com a fonte selecionada (Grupo Baixa, Baixa do Título, ou Título). Isso garante controle total sobre os dados apresentados, proporcionando maior clareza e transparência. Os comprovantes gerados podem ser exportados em diversos formatos, como PDF ou Excel, facilitando o armazenamento e compartilhamento dos documentos.

'''Observação Dinâmica:''' Um dos grandes diferenciais deste BI é o recurso de **Observação Dinâmica**, que permite ao usuário criar textos personalizados no relatório. Isso facilita a inclusão de informações detalhadas, como nomes, valores, datas e outros dados essenciais para o documento.

'''Modelos Fixos e Customizáveis:''' Além das opções dinâmicas, o sistema oferece modelos fixos com dados pré-definidos. Esses modelos podem ser ajustados conforme as preferências do usuário, permitindo que informações digitadas sobreponham os dados fixos e garantam um relatório final preciso e adaptado.

==Modelos Fixos==
[[Ficheiro:Modelos Fixos.png|miniaturadaimagem|Exemplo de modelo fixo já criado e adicionado as opções para geração do relatório.]]
Os modelos fixos são uma ferramenta importante para garantir a padronização e a consistência dos comprovantes emitidos. Eles simplificam o processo de emissão ao fornecer formatos pré-definidos, reduzindo a necessidade de ajustes frequentes. Cada modelo é projetado para atender a diferentes tipos de transações, oferecendo flexibilidade para personalizar os campos conforme a situação específica. Atualmente, disponibilizamos três modelos fixos para a emissão de comprovantes. Esses modelos podem incluir ou não formatação em HTML, utilizando tags para criar quebras de linha, negrito, itálico, entre outras edições de texto. Os modelos pré-definidos já vêm com tags de formatação para uma visualização mais adequada no relatório.

==== Modelo 1: Comprovante de Recebimento ====
Este modelo é utilizado para comprovantes de recebimento, com dados oriundos da "Baixa Título". Você também tem a opção de inserir esses dados manualmente, permitindo personalizar os campos conforme necessário.<syntaxhighlight lang="html">
<br><b> COMPROVANTE DE RECEBIMENTO </b></br> 
<br></br> 
<br> Recebemos da empresa <b> @aux:nomePessoa@ - @aux:nomeFantasiaPessoa@ </b> a quantia de: </br> 
<br></br> 
<br> - <b> R$ @aux:valorTotalOperacao@ (@aux:totalOperacaoExtenso@) </b> </br> 
<br> - Percentual de quitacao: @aux:percentualQuitacao@ </br>
<br> - Pedido de Compra: @aux:numeroPedido@ </br> 
<br> - Data do Recebimento: @aux:dataBaixaTitulo@ (@aux:dataBaixaExtenso@) </br> 
<br> - Descricao do Material: @aux:descricaoMaterial@ </br>
<br></br>
<br></br>
<br></br>
<br>_____________________________________________________</br> 
<br>@aux:cidadeEndEmpresa@, @aux:ufEndEmpresa@. @aux:dataBaixaTitulo@</br>
<br>RUBENS GERALDO DE OLIVEIRA</br>
<br><b> @aux:nomeEmpresa@ - @aux:nomeFantasiaEmpresa@</b></br>
<br> CNPJ: @aux:cpfCnpjEmpresa@ - INSCRICAO ESTADUAL: @aux:inscricaoEstadualEmpresa@ </br>
</syntaxhighlight>
Observações:

* Os campos “Percentual de Quitação”, “Pedido de Compra” e “Descrição do Material” devem ser preenchidos manualmente, pois não são gerados automaticamente pelos dados da "Baixa Título" ou são dados personalizados.

* Se esses campos estiverem em branco, o relatório exibirá o nome das chaves que deveriam ser preenchidas.
* Caso seja necessário adicionar uma linha para assinatura, ela deve ser inserida diretamente no texto conforme o exemplo acima.

==== Modelo 2: Comprovante de Pagamento ====
Este modelo é destinado a comprovantes de pagamento, com dados originados do "Título". É possível também inserir manualmente esses dados, permitindo a personalização dos campos.<syntaxhighlight lang="html" line="1">
<br><b> COMPROVANTE DE PAGAMENTO </b></br>
<br></br>
<br> Comprovante de pagamento efetuado ao seguinte fornecedor <b> @aux:nomePessoa@ </b> a quantia de:</br> 
<br></br> 
<br> - <b> R$ @aux:valorTotalTitulo@ (@aux:totalTituloExtenso@) </b> </br>
<br> - Data do Pagamento: @aux:dataPagamento@ (@aux:dataPagamentoExtenso@) </br> 
<br> - Nr. Documento Fiscal: @aux:numeroNota@ </br> 
<br></br> 
<br></br> 
<br></br> 
<br>_____________________________________________________</br>
<br>@aux:cidadeEndEmpresa@, @aux:ufEndEmpresa@. @aux:dataPagamento@</br>
<br>RUBENS GERALDO DE OLIVEIRA</br>
<br><b> @aux:nomeEmpresa@ - @aux:nomeFantasiaEmpresa@</b></br>
<br> CNPJ: @aux:cpfCnpjEmpresa@ - INSCRICAO ESTADUAL: @aux:inscricaoEstadualEmpresa@ </br>
</syntaxhighlight>
Observações:

* Os campos “Data do Pagamento” e “Número do Documento Fiscal” devem ser preenchidos manualmente, pois não são automaticamente incluídos pelos dados do "Título" ou são personalizados.
* Se esses campos estiverem em branco, o relatório mostrará o nome das chaves que deveriam ser preenchidas.
* Caso seja necessário adicionar uma linha para assinatura, ela deve ser inserida diretamente no texto conforme o exemplo acima.

==== Modelo 3: Comprovante Manual ====
Este modelo é para situações diversas e permite a inserção manual de dados para personalização.<syntaxhighlight lang="html" line="1">
<br><b>@aux:nomeEmpresa@ - @aux:nomeFantasiaEmpresa@</b></br>
<br>CNPJ: @aux:cpfCnpjEmpresa@ </br> 
<br></br> 
<br>Pagamento referente <b>@aux:textoLivre@</b>, realizado para <b>@aux:nomePessoa@</b> na importancia de <b>R$ @aux:valorTotalOperacao@ (@aux:totalOperacaoExtenso@)</b>.</br>
<br></br>
<br></br>
<br></br>
<br></br>
<br></br>
<br></br>
<br></br>
<br></br>
<br></br>
<br>_____________________________________________________</br> 
<br>@aux:dataBaixaTitulo@ (@aux:dataBaixaExtenso@)</br>
</syntaxhighlight>
Observações:

* O campo “Texto Livre” deve ser preenchido manualmente, pois é um dado personalizado.
* Se o campo estiver em branco, o relatório exibirá o nome da chave que deveria ser preenchida.
* Caso seja necessário adicionar uma linha para assinatura, ela deve ser inserida diretamente no texto conforme o exemplo acima.

==Observação Dinâmica==
[[Ficheiro:Cadastro.gif|miniaturadaimagem|Exemplo de como o cadastro de uma nova observação dinâmica deve ser feita.]]Com o relatório personalizável "Observação Dinâmica", você terá a vantagem de criar textos completamente personalizados, adaptados às suas necessidades específicas, utilizando informações já cadastradas e salvas no recurso 1571. Essa opção permite que você use como base as informações existentes e vincule campos diretamente a uma origem selecionada, garantindo que o relatório seja gerado com precisão e relevância. Para usar o recurso 1571 - Observação Dinâmica, siga os passos abaixo para um cadastro eficaz:
'''Cadastro da Observação:''' Informe uma descrição para a observação e insira o texto desejado. 

Se necessário, inclua tags em HTML para formatação adicional.

'''Vinculação de Campos:''' Para a busca automática de dados, selecione a origem na aba de campos. 

As opções disponíveis serão exibidas para visualização e seleção. 

Para adicionar um campo, clique com o botão direito e selecione "Adicionar". 
[[Ficheiro:Observação Dinamica.png|miniaturadaimagem|Exemplo de parametrização na hora de gerar o relatório para que ele use corretamente a observação dinâmica selecionada de acordo com o Identificador.]]
A chave será incorporada ao seu texto automaticamente, sem a necessidade de ajustes adicionais.

'''Salvar Registro''': Salve seu cadastro. 

O identificador gerado é um número único e sequencial que será utilizado pelo BI para garantir que as informações sejam recuperadas corretamente.

Ao utilizar esse recurso, você otimiza o processo de emissão de relatórios, assegurando que todos os dados relevantes sejam incluídos e apresentados de forma clara e precisa, conforme suas especificações.

==Parametrizações de Informações Manuais==
Neste relatório, diversas opções de personalização estão disponíveis para ajustar valores e campos. Essas personalizações podem ser feitas manualmente ou para sobrescrever valores provenientes da origem selecionada nos modelos fixos. Nomes e chaves não devem ser alteradas.

==== Campos Manuais ====
Esses campos são adicionais aos modelos fixos já disponibilizados e não têm origem automática, portanto, são obrigatórios para serem informados. Quando novos modelos são criados, esses campos estarão disponíveis e mapeados para uso:

* '''Percentual Quitação'''

 '''Descrição:''' Indica a porcentagem do valor total do título que já foi quitada. É utilizado no modelo de recebimento para mostrar o progresso da quitação de um título específico.
<blockquote>'''Chave:''' ''aux:percentualQuitacao''</blockquote>

* '''Número da Nota'''

  '''Descrição:''' Refere-se ao número da Nota Fiscal vinculada ao título. É utilizado no modelo de pagamento para identificar e associar a Nota Fiscal ao título correspondente.
<blockquote>'''Chave:''' ''aux:numeroNota''</blockquote>

* [[Ficheiro:Exemplo de Campo Manual.png|miniaturadaimagem|Exemplificação de um campo manual que foi criado e NÃO DEVE SER ALTERADO.]]'''Número Pedido'''  

 '''Descrição:''' Representa o número do pedido vinculado ao título. É usado no modelo de recebimento para associar o título a um pedido específico.
<blockquote>'''Chave:''' ''aux:numeroPedido''</blockquote>

* '''Descrição do Material'''

  '''Descrição:''' Fornece uma descrição detalhada do produto ou dos materiais utilizados, utilizado no modelo de recebimento para identificar claramente o material relacionado ao título.
<blockquote>'''Chave:''' ''aux:descricaoMaterial''</blockquote>

* '''Texto Livre'''

  '''Descrição:''' Permite adicionar uma descrição mais detalhada e personalizada do comprovante financeiro, sendo útil para incluir informações adicionais não cobertas pelos outros campos.
<blockquote>'''Chave:''' ''aux:textoLivre''</blockquote>

* '''Data Pagamento'''

  '''Descrição:''' Especifica o dia em que o pagamento foi realizado. Usado no modelo de pagamento para registrar a data efetiva da transação.
<blockquote>'''Chave:''' ''aux:dataPagamento''</blockquote>

* '''Data Pagamento Extenso'''

  '''Descrição:''' Indica o dia do pagamento de forma extensa (por extenso), proporcionando uma leitura mais detalhada da data. 
<blockquote>'''Chave:''' ''aux:dataPagamentoExtenso''</blockquote>
==== Campos de Título ====
Esses campos podem ser usados para sobrescrever informações advindas do título ou, em caso de criação de novos modelos fixos, esses campos estarão disponíveis e mapeados para uso:

* '''Data Emissão do Título'''

  '''Descrição:''' Refere-se à data em que o título foi emitido. Utilizado para fornecer a data de emissão oficial do título. 
<blockquote>'''Chave:''' ''aux:dataEmissaoTitulo''</blockquote>

* '''Data Vencimento do Título''' 

  '''Descrição:''' Indica a data de vencimento do título. É a data limite para o pagamento do título.
<blockquote>'''Chave:''' ''aux:dataVencimentoTitulo''</blockquote>-

* '''Identificador do Título'''

  '''Descrição:''' Representa o código único ou identificador do título, usado para referência e rastreamento específico.  
  <blockquote>'''Chave:''' ''aux:identificadorTitulo''</blockquote>

* '''Valor Total do Título'''

  '''Descrição:''' Mostra o valor total do título, incluindo todos os encargos e taxas aplicáveis.  
  <blockquote>'''Chave:''' ''aux:valorTotalTitulo''</blockquote>

* '''Total Título Extenso'''

  '''Descrição:''' Exibe o valor total do título escrito por extenso, facilitando a leitura e compreensão do valor.  
  <blockquote>'''Chave:''' ''aux:totalTituloExtenso''</blockquote>

* '''Obs. Título'''

  '''Descrição:''' Campo destinado a observações adicionais sobre o título, permitindo incluir informações extras que não são cobertas pelos outros campos.  
  <blockquote>'''Chave:''' ''aux:observacaoTitulo''</blockquote>

==== Campos de Pessoa ====
Esses campos podem ser usados para sobrescrever informações advindas da pessoa informada ou, em caso de criação de novos modelos fixos, estarão disponíveis e mapeados para uso:

* '''Nome'''

  '''Descrição:''' Nome completo da pessoa. Utilizado para identificar a pessoa de maneira formal e completa.  
  <blockquote>'''Chave:''' ''aux:nomePessoa''</blockquote>

* [[Ficheiro:Emissao Sem Valor.png|miniaturadaimagem|Exemplo de Emissão de um recibo onde campos manuais não foram informados.]]'''Nome Fantasia'''

  '''Descrição:''' Nome de fantasia ou nome comercial da pessoa ou empresa. Usado em contextos onde o nome formal não é adequado.  
  <blockquote>'''Chave:''' ''aux:nomeFantasiaPessoa''</blockquote>

* '''CPF / CNPJ'''

  '''Descrição:''' Número de CPF ou CNPJ da pessoa ou empresa, usado para identificação fiscal.  
  <blockquote>'''Chave:''' ''aux:cpfCnpjPessoa''</blockquote>

* '''Inscrição Estadual'''

  '''Descrição:''' Número de inscrição estadual da empresa, necessário para operações estaduais e tributação.  
  <blockquote>'''Chave:''' ''aux:inscricaoEstadualPessoa''</blockquote>

* '''Site'''

  '''Descrição:''' Endereço do site da pessoa ou empresa, fornecendo uma referência para obter mais informações online.  
  <blockquote>'''Chave:''' ''aux:sitePessoa''</blockquote>

* '''Email'''

  '''Descrição:''' Endereço de e-mail da pessoa ou empresa, utilizado para comunicação eletrônica.  
  <blockquote>'''Chave:''' ''aux:emailPessoa''</blockquote>

* '''Endereço - Logradouro'''

  '''Descrição:''' Endereço completo, incluindo o logradouro (rua, avenida, etc.), utilizado para especificar a localização física.  
  <blockquote>'''Chave:''' ''aux:logradoutroEndPessoa''</blockquote>

* '''Endereço - Bairro'''

  '''Descrição:''' Nome do bairro onde a pessoa ou empresa está localizada.  
  <blockquote>'''Chave:''' ''aux:bairroEndPessoa''</blockquote>

* '''Endereço - Cidade'''

  '''Descrição:''' Nome da cidade onde a pessoa ou empresa está localizada.  
  <blockquote>'''Chave:''' ''aux:cidadeEndPessoa''</blockquote>

* '''Endereço - UF'''

  '''Descrição:''' Unidade Federativa (estado) onde a pessoa ou empresa está localizada.  
  <blockquote>'''Chave:''' ''aux:ufEndPessoa''</blockquote>

* '''Endereço - Número'''

  '''Descrição:''' Número do endereço (prédio, casa, etc.), usado para identificar a localização específica.  
  <blockquote>'''Chave:''' ''aux:numeroEndPessoa''</blockquote>

* '''Endereço - Complemento'''

  '''Descrição:''' Informações adicionais sobre o endereço, como apartamento, bloco, etc.  
  <blockquote>'''Chave:''' ''aux:complementoEndPessoa''</blockquote>

==== Campos de Baixa Título ====
Esses campos podem ser usados para sobrescrever informações advindas da baixa do título informada ou, em caso de criação de novos modelos fixos, estarão disponíveis e mapeados para uso:

* '''Total Baixa'''

  '''Descrição:''' Valor total da baixa do título, representando o montante que foi baixado ou liquidado.  
  <blockquote>'''Chave:''' ''aux:valorTotalBaixa''</blockquote>

* [[Ficheiro:Geracao Sobrepondo Valores.png|miniaturadaimagem|Exemplo da parametrização feita para geração de relatórios sobrepondo os valores destacados.]]'''Total Baixa Extenso'''

  '''Descrição:''' Valor total da baixa do título escrito por extenso, para facilitar a leitura e entendimento do montante.  
  <blockquote>'''Chave:''' ''aux:totalBaixaExtenso''</blockquote>

* '''Total Juros'''

  '''Descrição:''' Total de juros aplicados ao título, utilizado para detalhar os encargos financeiros adicionais.  
  <blockquote>'''Chave:''' ''aux:valorTotalJuros''</blockquote>

* '''Total Multa'''

  '''Descrição:''' Total de multas aplicadas ao título, detalhando os encargos por atraso ou outros motivos.  
  <blockquote>'''Chave:''' ''aux:valorTotalMulta''</blockquote>

* '''Total Desconto'''

  '''Descrição:''' Total de descontos aplicados ao título, mostrando as reduções concedidas.  
  <blockquote>'''Chave:''' ''aux:valorTotalDesconto''</blockquote>

* '''Total Saldo Aberto'''

  '''Descrição:''' Valor do saldo ainda em aberto após a baixa, indicando o montante que ainda pode ser devido.  
  <blockquote>'''Chave:''' ''aux:valorTotalAberto''</blockquote>

* '''Total Operação'''

  '''Descrição:''' Valor total da operação de baixa, incluindo todos os encargos, descontos e pagamentos.  
  <blockquote>'''Chave:''' ''aux:valorTotalOperacao''</blockquote>

* '''Total Operação Extenso'''

  '''Descrição:''' Valor total da operação de baixa escrito por extenso, facilitando a leitura do montante total.  
  <blockquote>'''Chave:''' ''aux:totalOperacaoExtenso''</blockquote>

* '''Data Baixa'''

  '''Descrição:''' Data em que a baixa do título foi efetivada, usado para registrar quando o título foi oficialmente baixado.  
  <blockquote>'''Chave:''' ''aux:dataBaixaTitulo''</blockquote>[[Ficheiro:Emissao Sobrepondo Valores.png|miniaturadaimagem|Exemplo de Emissão de um recibo onde campos manuais foram informados corretamente e sobreposição de valores advindos da origem. ]]
* '''Data Baixa Extenso'''

  '''Descrição:''' Data da baixa do título escrita por extenso, proporcionando uma descrição detalhada da data.  
  <blockquote>'''Chave:''' ''aux:dataBaixaExtenso''</blockquote>

* '''Observação Baixa'''

  '''Descrição:''' Campo para adicionar observações específicas sobre a baixa do título, permitindo incluir detalhes adicionais.  
  <blockquote>'''Chave:''' ''aux:observacaoBaixaTitulo''</blockquote>

* '''Observação Grupo Baixa'''

  '''Descrição:''' Campo para observações sobre o grupo de baixa, permitindo incluir informações adicionais relevantes para o grupo de títulos baixados.  
  <blockquote>'''Chave:''' ''aux:observacaoGrupoBaixaTitulo''</blockquote>