~~ODT~~
<PHP>
echo "<div style='display:block;float:right;'>"; 
echo "Última atualização: ";
ver('', false);
echo "</div>";
</PHP>

====== Relatório de Total Gasto por Período======


Este caso de uso tem como finalidade exibir o valor gasto com faturas no decorrer de um ano. É utilizado por usuários que tem acesso a relatórios gerenciais e tem permissão para fazer registro de notas fiscais, emissão de processo de pagamento e lançamento de ordem bancária.

Pré-condições: Deve-se ter faturas cadastradas previamente.

===== Descrição do Caso de Uso =====

Este caso de uso inicia quando o usuário acessa a opção: SIPAC -> Faturas -> Consultas/Relatórios -> Fatura de Energia Elétrica -> Relatório de Total Gasto por Período.

O sistema solicita:

  * **Período***: Tipo - TEXTO, Formato: De MÊS/ANO a MÊS/ANO.
  * **Unidade**: Formato - NOME DA UNIDADE (CÓDIGO). Entrada de dados: Nome ou Código. ([[#principais_regras_de_negócio|RN01]])
  * **Localidade**: Entrada de dados: Nome da Localidade.
  * **Ordenar por**: Tipo - TEXTO. Pode-se ordenar por localidade ou valor.
  * **Exibir percentual:** Tipo - TEXTO. Opções: Sim, Não. O sistema exibe os percentuais para cada valor se o usuário selecionar a opção sim.

O sistema exibe o relatório ([[#Principais Regras de Negócio|RN02]]):

**__Relatório do Total Faturado por Período__**

**__Período__**.

É exibido um gráfico expressando o //Total Faturado// pela quantidade de //Meses// definidos na busca.

^Unidade ^ Mês/Ano ^ Mês/Ano ^Mês/Ano ^Mês/Ano ^Mês/Ano ^ Mês/Ano ^ Mês/Ano ^ Mês/Ano ^ Mês/Ano ^ Mês/Ano ^ Mês/Ano ^ Mês/Ano ^Total do Ano^
| LOCALIDADE | 9,99| 9,99 | 9,99 | 9,99 | 9,99 | 9,99| 9,99| 9,99| 9,99| 9,99| 9,99| 9,99| 9,99|
| LOCALIDADE | 9,99| 9,99 | 9,99 | 9,99 | 9,99 | 9,99| 9,99| 9,99| 9,99| 9,99| 9,99| 9,99| 9,99|
| LOCALIDADE | 9,99| 9,99 | 9,99 | 9,99 | 9,99 | 9,99| 9,99| 9,99| 9,99| 9,99| 9,99| 9,99| 9,99|
| **Total Geral** | **9,99**| **9,99** | **9,99** | **9,99** | **9,99** | **9,99**| **9,99**| **9,99**| **9,99**| **9,99**| **9,99**| **9,99**| **9,99**|

Opção de exportar o relatório para excel.


O caso de uso é finalizado.


===== Principais Regras de Negócio =====

  * **RN01** - Somente unidades com faturas de energia cadastrada no sistema serão exibidas no ato da busca.
  * **RN02** - O sistema apresenta valores brutos para cada mês.

==== Resoluções/Legislações Associadas ====

Não se Aplica.  

===== Classes Persistentes e Tabelas Envolvidas =====


^ Classe ^ Tabela |
| br.ufrn.sipac.faturas.dominio.FaturaEnergia | administrativo.contratos.fatura_energia |
| br.ufrn.sipac.faturas.dominio.LocalidadeUnidade | administrativo.contratos.localidade_unidade |
| br.ufrn.sipac.faturas.dominio.FaturaProcessada | administrativo.contratos.fatura_processada |


===== Plano de Teste =====

Sistema: SIPAC

Módulo: Faturas

Link(s): Faturas -> Consultas/Relatórios -> Faturas de Energia Elétrica -> Total Gasto por Período

Usuários: lof (GESTOR_FATURAS).

Papel que usuário deve ter: SipacPapeis.GESTOR_FATURAS ou SipacPapeis.GESTOR_INSTITUICAO e SipacPapeis.GESTOR_TELEFONES.

===== Cenários de Teste =====


Para acrescentar faturas siga o fluxo:
  * Sipac -> Faturas -> Operações -> Faturas de Contratação de Energia Elétrica -> Carregar Arquivo de Faturas de Contratação de Energia Elétrica.

Envie o arquivo:
{{:desenvolvimento:especificacoes:sipac:faturas:casos_de_uso:consultas_relatorios:faturas_de_energia_eletrica:arquivo_contas_-_cosern.zip|}}


Caso não haja unidade localidade vinculada a nenhuma unidade, faça o seguinte procedimento para obter um relacionamento unidade/localidade:
  - Sipac -> Faturas -> Operações -> Cadastros -> Localidades -> Cadastrar.
  - Preencha os dados e confirme.

As unidades que você relacionar a localidades nesta opção, serão sugeridas na busca do relatório caso possuam faturas de energia cadastradas.



===== Dados para o Teste =====

Unidades sugeridas no autocomplete
<code sql>
SELECT distinct u.* FROM contratos.fatura_energia f
	JOIN contratos.localidade_unidade lu on lu.id_localidade = f.id_localidade
	JOIN comum.unidade u on u.id_unidade = lu.id_unidade
</code>

Resultado da busca por faturas:
<code sql>
SELECT lu.id_localidade, f.id_fatura_energia, f.numero_fatura, lu.nome, f.valor, fp.mes, 
fp.ano 

FROM contratos.fatura_energia f 
INNER JOIN contratos.localidade_unidade lu on f.id_localidade=lu.id_localidade 
INNER JOIN contratos.fatura_processada fp on f.id_fatura_processada=fp.id_fatura_processada 

WHERE fp.ano=2010 -- Coloca o ano desejado aqui
-- Caso pretenda pesquisar por unidade, retire o comentário abaixo e informe o id da unidade desejada
-- and lu.id_unidade = 2
ORDER BY lu.nome, lu.id_localidade, fp.mes asc
</code>