Tabela de conteúdos

[UC2235] - Relatório de Guia de Pagamento em Revisão

Este caso de uso gera um relatório das guias de pagamento em revisão


Ator: Usuário da Divisão de Faturamento (complexo (1) ).
Prioridade Essencial.
Pré-condição: Existência de Guia de Pagamento em Revisão.
Pós-condição:Relatório gerado com a relação de guias de pagamento em revisão que atenderam as condições dos filtros informados(formato PDF).
Complexidade: Simples (1) .
Histórico de Alterações:

Data Analista Descrição da Alteração
26/01/2026Claudio LiraRM75920 - Criação do caso de uso

Diagrama do caso de uso

skinparam usecase { BackgroundColor<< Main >> YellowGreen } ([UC2235] - Relatório de Guia de Pagamento em Revisão << Main >> Usuário - ([UC2235] - Relatório de Guia de Pagamento em Revisão)

Fluxo Principal

  1. O sistema exibe tela para receber os filtros de pesquisa das guias de pagamento em revisao:
    1. Imóvel: o usuário informa ou pesquisa a matrícula do imóvel: [FS0001-VALIDAR IMÓVEL];
      1. Caso seja informado/pesquisado o imóvel, desabilitar o filtro de cliente;
    2. Cliente: o usuário informa ou pesquisa o código de cleinte: [FS0002-VALIDAR CLIENTE;
      1. Caso seja informado/pesquisado o código do cliente, desabilitar o filtro de imóvel;
    3. Incluir Guias com Pagamento: ( ) SIM ( ) NÃO (selecionar entre SIM E NAO);
    4. Intervalo de Data de Revisão: dd/mm/aaa a dd/mm/aaaa;
      1. A data correspondente ao intervalo incial deve ser menor/igual ao intervalo final;
      2. A data correspondente ao intervalo final deve ser maior/igual ao intervalo inicial;
      3. A data do intervalo inicial/final não pode ser maior que a data atual;
    5. Intervalo de Data de Emissão: dd/mm/aaa a dd/mm/aaaa;
      1. A data correspondente ao intervalo incial deve ser menor/igual ao intervalo final;
      2. A data correspondente ao intervalo final deve ser maior/igual ao intervalo inicial;
      3. A data do intervalo inicial/final não pode ser maior que a data atual;
    6. Intervalo de Data de Vencimento: dd/mm/aaa a dd/mm/aaaa;
      1. A data correspondente ao intervalo incial deve ser menor/igual ao intervalo final;
      2. A data correspondente ao intervalo final deve ser maior/igual ao intervalo inicial;
    7. Motivo de Revisão: exibir relação com as descrição dos motivos de revisão: o usuário poderá selecionar um ou mais motivos;
      1. Selecionar cmrv_dsmotivorevisaoconta da tabela faturamento.conta_motivo_revisao com cmrv_icuso = 1;
    8. Botões de Açoes:
      1. LIMPAR: Caso selecionado, limpar os filtros informados e retornar para o item 1 do fluxo principal;
      2. CANCELAR: Caso selecionado, retornar para o menu principal do sistema;
      3. GERAR: Caso selecionado, o sistema pesquisa as guias de pagamento em revisão para geração do relatório:
        1. Caso o usuário tenha informado matrícula do imóvel [SB0001 - Pesquisar Guia de Pagamento Imóvel];
        2. Caso o usuário tenha informado código de cliente [SB0002 - Pesquisar Guia de Pagamento Cliente];;
  2. Encerra o caso de uso.

[SB0001] - Pesquisar Guia de Pagamento Imóvel

  1. Selecionar as guias de pagamentos a partir da tabela faturamento.guia_pagamento de acordo com os filtros informados com:
    1. IMOV_ID = matrícula do imóvel informada/pesquisada;
    2. Caso o filtro INCLUIR GUIAS COM PAGAMENTO = NÃO:
      1. Desconsiderar as guias com existência de pagamento na tabela arrecadacao.pagamento com gpag_id = gpag_id da tabela guia_pagamento;.
    3. Intervalo Data de Revisão: selecionar apenas guias de pagamento cuja a data de revisão estaja dentro do intervalo de data de revisão informado;.
      1. gpag_dtrevisao >= data inicial do intervalo e gpag_dtrevisao ⇐ data final do intervalo;
    4. Intervalo Data de Emissão: selecionar apenas guias de pagamento cuja a data de emissão estaja dentro do intervalo de data de emissão informado;.
      1. gpag_dtemissao >= data inicial do intervalo e gpag_dtemissao ⇐ data final do intervalo;
    5. Intervalo Data de Vencimento: selecionar apenas guias de pagamento cuja a data de vencimento estaja dentro do intervalo de data de vecimento informado;.
      1. gpag_dtvencimento >= data inicial do intervalo e gpag_dtvencimento ⇐ data final do intervalo;
    6. Motivo de Revisão: selecionar guias de pagamento com cmrv_id correspondente aos motivos de revisao selecionados;
  2. Caso o filtro de INCLUIR GUIAS COM PAGAMENTO = SIM;
    1. Selecionar as guias da tabela faturamento.guia_pagamento_historico de acordo com os filtros informados com:
      1. IMOV_ID = matrícula do imóvel informada/pesquisada;
      2. Intervalo Data de Revisão: selecionar apenas guias de pagamento cuja a data de revisão estaja dentro do intervalo de data de revisão informado;.
        1. gpag_dtrevisao >= data inicial do intervalo e gpag_dtrevisao ⇐ data final do intervalo;
      3. Intervalo Data de Emissão: selecionar apenas guias de pagamento cuja a data de emissão estaja dentro do intervalo de data de emissão informado;.
        1. gpag_dtemissao >= data inicial do intervalo e gpag_dtemissao ⇐ data final do intervalo;
      4. Intervalo Data de Vencimento: selecionar apenas guias de pagamento cuja a data de vencimento estaja dentro do intervalo de data de vecimento informado;.
        1. gpag_dtvencimento >= data inicial do intervalo e gpag_dtvencimento ⇐ data final do intervalo;
      5. Motivo de Revisão: selecionar guias de pagamento com cmrv_id correspondente aos motivos de revisao selecionados;
  3. Processar as guias de pagamentos retornadas:
    1. Caso tenha retornado guias de pagamentos da tabela guia_pagamento ou guia_pagamento_historico o sistema gera o relatório com as guias de pagamentos de imóvel:
      1. Gerar Relatório Guia Pagamento Imóvel: [SB0003- Gerar Relatório Guia de Imóvel];
    2. Caso Contrário: [FS0003-Dados Não Retornados];

[SB0003] - Gerar relatório Guia de Imóvel

  1. O sistema gera o relatório com as guias de pagamento de imóvel conforme layout abaixo:
    1. Título: Relatório de Guias de Pagamento em Revisão por RGL;
    2. Dados dos filtros informados:
      1. Intervalo da data de revisão;
      2. Intervalo da data de emissão;
      3. Intervalor da data de vencimento;
    3. Identificação do imóvel:
      1. RGL: imov_id da guia de pagameno;
      2. Endereço do imóvel: exbir o endereço do imóvel formatado (logradouro/número/complemento/bairro/cidade/uf);
      3. Cliente Usuário Atual: exbir clie_nmcliente da tabela cadasro.cliente com clie_id = clie_id da tabela cliente_imovel com:
        1. imov_id = imov_id da guia de pagamento;
        2. crtp_id = 2 (relação de usuário);
        3. clim_dtrelacaofim = nulo (usuário atual);
    4. Detalhe por guia de pagamento selecionada:
      1. Para cada guia de pagamento retornada exibir os dados da guia de pagamento em revisão:
        1. Número da Guia: gpag_id
        2. Data Emissão: gpag_dtemissao(dd/mm/aaaa);
        3. Data de Vencimento: gpag_dtvencimento(dd/mm/aaaa);
        4. Valor da Guia: gpag_vldebito;
        5. Data de Revisão: gpag_dtrevisao(dd/mm/aaaa);
        6. Motivo de Revisão: cmrv_dsmotivorevisaoconta;
    5. Total: exibir no final do relatório:
      1. Quantidade de guias em Revisão: exibir a quantidade de guias;
      2. Valor total das guias em revisão: exibir o somatório de gpag_vldebito das guiasr

Fluxos Secundários:

[FS0001] - Validar Imóvel

  1. O sistema pesquisa a matrícula do imóvel informado: selecionar imov_id na tabela cadastro.imovel com imov_id = matrícula informada;
    1. Cáso a pesquisa não retorne o imóvel, exibir mensagem: 'Matrícula do imóvel informada não existe' e retornar para o item 1 do fluxo principal;

[FS0002] - Validar Cliente

  1. O sistema pesquisa o código do cliente informado: selecionar clie_id na tabela cadastro.cliente com clie_id = código do cliente informado;
    1. Cáso a pesquisa não retorne o cliente, exibir mensagem: 'Código do cliente informado não existe' e retornar para o item 1 do fluxo principal;

[FS0003] - Dados Não Retornados

  1. Exibir mensagem: 'Não foram encontrados dados para os filtros informados' e retornar para o item 1 do fluxo principal;