~~ODT~~

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

====== Guia de Recolhimento da União ======

Esse caso de uso é utilizado pelos fiscais de contrato com a finalidade de cadastro da GRU (Guia de Recolhimento da União) para um determinado contrato.

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

O caso de uso é acionado quando o usuário acessa a opção: SIPAC -> Portal Administrativo -> Aba Contratos -> Fiscalização -> Gestão Pagamento -> Guia de Recolhimento da União.

===Passo 1===
O caso de uso inicia-se com a exibição  dos contratos (caso exista  mais de um contrato, se não o sistema irá redirecionar para o passo 2) encontrados para que seja possível escolher o contrato desejado. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN04]])

Os contratos exibem as seguintes informações:

  * **__Número__**: Tipo NUMÉRICO, formato: 9.../AAAA.
  * **__Empresa__**: Tipo TEXTO.
  * **__Tipo__**: ipo TEXTO, este pode ser //Acadêmico//, //Despesa/Global//, //Despesa/Ordinário// ou //Receita//. Para ver os detalhes sobre estes tipos de contrato ver, [[desenvolvimento:especificacoes:sipac:contratos:negocio|documento de negócio de contratos]].
  * **__Cadastro__**: Tipo DATA, formato DD/MM/AAAA.
  * **__Login Cadastro__**: Tipo TEXTO.

Pode-se então selecionar o contrato desejado.

=== Passo 2===

Ao selecionar o contrato desejado, o sistema exibe os dados do contrato, para mais detalhes visualize a especificação: [[desenvolvimento:especificacoes:sipac:contratos:casos_de_uso:consultas_relatorios:gerais:listar_contratos|Visualizar Detalhes do Contrato]].

Pode-se então inserir uma guia de recolhimento da união([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN02 e RN03]]). São solicitados:
  * **Competência(mês/ano)***: Tipo TEXTO, formato: NOME MÊS/AAAA
  * **Data de Vencimento**: Tipo DATA, formato: DD/MM/AAAA.
  * **Data de Pagamento***: Tipo DATA, formato: DD/MM/AAAA.
  * **Valor do Principal(R$)**: Tipo NUMÉRICO.
  * **Mora/Multa(R$)**: Tipo NUMÉRICO.
  * **Desconto/Abatimento(R$)**: Tipo NUMÉRICO.
  * **Juros/Encargos(R$)**: Tipo NUMÉRICO.
  * **Outras Deduções(R$)**: Tipo NUMÉRICO.
  * **Outros Acréscimos(R$)**: Tipo NUMÉRICO.

Para cada guia de recolhimento pode-se adicionar unidades beneficiadas. Para cada uma dessas unidades são solicitadas as seguintes informações:

  * **Tipo***: Tipo TEXTO, são apresentadas opções tais quais: 'ALUGUEL', 'ENERGIA', 'JUROS' etc.
  * **Unidade***: Tipo TEXTO, formato: NOME UNIDADE (CÓDIGO UNIDADE).
  * **Valor(R$)***: Tipo NUMÉRICO.
  * **Observação**: Tipo TEXTO.

Após a inserção, é exibida uma listagem contendo todas as unidades já inseridas, com os mesmos campos exibidos acima. O sistema exibe ainda as opções de //Alterar// e //Remover// para as unidades beneficiadas bem como o total de valores das unidades beneficiadas. No caso da opção de alterar, todas as informações podem ser alteradas, com exceção da unidade.

Após inserir as unidades, pode-se inserir a guia de recolhimento da união. Ao fazer isso, o sistema exibe uma listagem com os seguintes dados:
  * **__Competência__**: Tipo TEXTO, formato: MÊS/ANO.
  * **__Valor__**: Tipo NUMÉRICO.

Pode-se então //Alterar//, //Remover// ou //Visualizar// os dados da guia de recolhimento. O sistema também permite que seja inserida uma Nova Guia de Recolhimento da União para o mesmo contrato.

Então o caso de uso é finalizado.   

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

  ***RN01** - A operação só é disponível para contratos do tipo //Receita//, //Limpeza// ou //Locação de mão de obra//.
  ***RN02** - Para inserir uma Guia de Recolhimento da União é necessário que pelo menos uma unidade beneficiada seja associada.
  ***RN03** - O valor total da GRU tem que ser igual ao somatório dos valores inseridos nas unidades.
  ***RN04** - São exibidos somente os contratos fiscalizados pelo usuário logado.
==== Resoluções/Legislações Associadas ====

"Não se Aplica".  

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

^ Classe ^ Tabela |
|br.ufrn.sipac.contratos.dominio.GuiaRecolhimentoUniao|contratos.guia_recolhimento_uniao|


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

Sistema: SIPAC

Módulo: Portal Administrativo

Link(s): Caminho : aba Contratos -> Fiscalização -> Gestão Pagamento -> Guia de Recolhimento da União

Usuário: (A atribuição do papel ao usuário é feita pela associação do usuário ao contrato como fiscal, o papel é temporário até o fim de sua vigência.)

Papel que usuário deve ter: SipacPapeis.FISCAL_CONTRATO
===== Cenários de Teste =====

  * Confrontar as regras de negócio descritas acima,

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

  * Obter um contrato tipo receita:
    * Módulo de Contratos -> Consultas/Relatórios -> Listar Contratos
  * Associar o usuário como fiscal ao contrato escolhido para o testes:
    * Módulo de Contratos -> Geral -> Contrato -> Associações -> Associar Fiscais ao Contrato
  * Por fim, estornar a nota:
    * Portal Administrativo -> Aba Contratos -> Fiscalização -> Gestão Pagamento -> Guia de Recolhimento da União.