~~ODT~~

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

====== Adicionar Nota Fiscal ======

Para informações mais detalhadas acerca do processo de adição da nota fiscal, verifique a seguinte especificação: [[desenvolvimento:especificacoes:sipac:almoxarifado:casos_de_uso:estoque:estoque:nota_fiscal:cadastrar|Cadastrar Nota Fiscal do Módulo Almoxarifado]].

Esse caso de uso apenas implementa essa funcionalidade de forma diferente, tal qual descrita abaixo.
===== Descrição do Caso de Uso =====

O caso de uso inicia quando o usuário acessa //SIPAC -> Portal Administrativo -> Aba Contratos -> Fiscalização -> Gestão Pagamento -> Adicionar Nota Fiscal//.


O sistema lista os contratos do fiscal exibindo número, ano, tipo, vigência, duração, modalidade da licitação, numero da licitação, unidade gestora, fornecedor do contrato, objeto do contrato e valor atual  ([[#Principais_regras_de_negócio|RN14 e RN22]]) 


O usuário seleciona contrato e o sistema exibe as informações gerais do contrato e solicita dados da nota fiscal:
  * **__Dados do Contrato__**;
  * **__Arquivos de Detalhamento de Contrato__**;
  * **__Unidades Beneficiadas__**; ([[#Principais_regras_de_negócio|RN10, RN11, RN13]])

Abaixo são solicitados os dados da nota fiscal que será associada às unidades beneficiadas do contrato:
  * **Tipo da Nota***: Tipo LÓGICO. Opções: Tradicional ou Eletrônica. ([[#Principais_regras_de_negócio|RN01]])
  * **Medição**: Tipo - TEXTO ([[#Principais_regras_de_negócio|RN15]])
  * **Série***: Tipo - TEXTO. ([[#Principais_regras_de_negócio|RN01]])
  * **Número da Nota***: Tipo NUMÉRICO. ([[#Principais_regras_de_negócio|RN01]])
  * **Valor da Nota (R$)***: Tipo NUMÉRICO 
  * **Data de Emissão***: Tipo - DATA ([[#Principais_regras_de_negócio|RN06]])
  * **Data de Atesto**: Tipo DATA.
  * **Código de Autenticação:** Tipo TEXTO. ([[#Principais_regras_de_negócio|RN02]])
  * **Arquivo:** Tipo TEXTO. 
    * Ícone de visualizar arquivo. ([[#Principais_regras_de_negócio|RN03]])
  * **Está associada com requisição?** Tipo TEXTO, são exibidas as opções: 'SIM' e 'NÃO'. ([[#Principais_regras_de_negócio|RN16]])

Logo após é possível associar requisições de itens contratados à nota fiscal. ([[#Principais_regras_de_negócio|RN16]])

  * **Número:** Tipo NUMÉRICO.
  * **Ano:** Tipo NUMÉRICO. 
    * Ícone para adicionar a requisição. ([[#Principais_regras_de_negócio|RN09 e RN12]])

Abaixo do formulário de associação das requisições são exibidas as requisições já associadas a nota fiscal: ([[#Principais_regras_de_negócio|RN04]])

  * **__Número__**: Tipo - NUMÉRICO.
  * **__Ano__**: Tipo - NUMÉRICO.
    * Ícone para remoção da requisição.

Mais abaixo são solicitados os dados das unidades beneficiadas pela nota fiscal: ([[#Principais_regras_de_negócio|RN07 e RN08]])

  * **Unidade Beneficiada**: Tipo - TEXTO. Formato: UNIDADE (CÓDIGO DA UNIDADE).
  * **Nova Unidade Beneficiada**: Tipo - TEXTO. Formato: UNIDADE (CÓDIGO DA UNIDADE). ([[#Principais_regras_de_negócio|RN05]])
  * **Valor para a Unidade (R$)***: Tipo - MOEDA.

Juntamente com a associação das unidades beneficiadas, é possível associar as referências da nota fiscal:

  * **Mês**: Tipo TEXTO.
  * **Ano**: Tipo NUMÉRICO.
  * **Valor**: Tipo NUMÉRICO.
    * Ícone para adicionar a referência. ([[#Principais_regras_de_negócio|RN17]])

Abaixo do formulário de associação das referências são exibidas as referências já associadas à unidade beneficiada:

  * **__Mês__**: Tipo - NUMÉRICO.
  * **__Ano__**: Tipo - NUMÉRICO.
  * **__Valor__**: Tipo - MOEDA.
    * Ícone para remoção da referência.

Para os contratos que possuam categoria de gastos de despesa, será possível detalhar a destinação do valor da referência da nota fiscal por categoria:

  * **__Total <NOME CATEGORIA>__**: Tipo - NUMÉRICO. ([[#Principais_regras_de_negócio|RN23]])

Após a inserção de todas as unidades beneficiadas com suas respectivas referências e possíveis requisições associadas a nota fiscal, deve-se inserir a nota.

Ao inserir a nota fiscal, será listada logo abaixo todas as notas fiscais trabalhadas na sessão:

  * **__Série__***: Tipo - TEXTO. 
  * **__Número__***: Tipo NUMÉRICO. 
  * **__Valor__***: Tipo MOEDA. 
    * Ícone para alteração.
    * Ícone para remoção.

Após inserir todas as notas fiscais, será habilitado o botão **Continuar >>** ([[#Principais_regras_de_negócio|RN20]]), o qual direcionará o usuário para a página de confirmação dos dados inseridos anteriormente:

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

  * **RN01** - Será consultado no banco a nota fiscal após serem informados os dados da //Série//, //Número da Nota// e //Tipo da Nota//, caso exista uma nota já cadastrada no sistema, os dados serão prepopulados e serão desabilitados para edição. Os dados que serão preenchidos automaticamente são: //Série, Número da Nota, Valor da Nota (R$), Data de Emissão, Data do Atesto//.
  * **RN02** - O campo //Código de Autenticação// deve aparecer apenas para notas fiscais eletrônicas.
  * **RN03** - Caso a nota fiscal informada já exista na base de dados, e possua arquivo associado a ela, será exibido o ícone para visualização do arquivo.
  * **RN04** - Caso a nota fiscal informada já exista na base de dados, e possua requisições associadas a ela, será exibida a listagem das requisições associadas e com possibilidade de exclusão.
  * **RN05** - O campo //Nova Unidade// só será exibido para contratos do tipo Auto-incremento.
  * **RN06** - A data de emissão da nota fiscal deve estar no período de vigência do contrato ou após.
  * **RN07** - A unidade beneficiada só pode ser associada uma vez a nota fiscal.
  * **RN08** - A soma das referências da unidade beneficiada deve ser igual ao valor da unidade.
  * **RN09** - A mesma requisição não pode ser adicionada duas vezes para a mesma nota fiscal.
  * **RN10** - Se o contrato for diferente do tipo auto-incremento o saldo da unidade beneficiada não pode ficar negativo.
  * **RN11** - Se o contrato for do tipo auto-incremento o saldo do contrato não pode ficar negativo.
  * **RN12** - O número e ano da requisição devem corresponder a uma requisição já existente na base de dados.
  * **RN13** - Não é possível cadastrar uma nota fiscal para um contrato sem unidades beneficiadas.
  * **RN14** - São listado apenas os contratos que o usuário logado é fiscal.
  * **RN15** - Campo exibido somente para contratos com o subtipo OBRAS E SERVIÇOS DE ENGENHARIA.
  * **RN16** - Por padrão a opção vem selecionada como //Não//, caso o usuário a defina como //Sim//, será exibidos os campos para associação das requisições.
  * **RN17** - Cada unidade beneficiada deve possuir pelo menos uma referência associada a ela.
  * **RN18** - Somente exibido caso o usuário tenha fornecido a informação da data de atesto da nota fiscal no momento do cadastro.
  * **RN19** - Para cadastrar a nota fiscal relacionada à medição, é necessário que os dados da medição sejam lançados no cronograma físico pela Superintendência de Infraestrutura, regra somente para contratos do tipo OBRAS E SERVIÇOS DE ENGENHARIA.
  * **RN20** - A medição, não poderá ser associada a mais de uma nota fiscal regra somente para contratos do tipo OBRAS E SERVIÇOS DE ENGENHARIA.
  * **RN21** - Deve ser inserida no mínimo uma nota fiscal ao contrato para prosseguir com a operação.
  * **RN22** - Caso só exista um contrato com as indfomrações atribuidas no formulário, o usuário será direcionado para a tela de associação das notas fiscais, pulando a etapa de escohada pelo contrato, quanod há mais de um contrato com as informações passadas.
  * **RN23** - É necessário informar no mínimo um detalhamento do valor da referência em uma das categorias, a soma dos valores devem ser igual ao valor da referência.

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

"Não se Aplica".  

===== Entidades Persistentes Envolvidas =====
^ Classe ^ Tabela |
| br.ufrn.sipac.cadastro.dominio.Unidade                        | administrativo.comum.unidade                       |
| br.ufrn.sipac.contratos.dominio.Contrato                      | administrativo.contratos.contrato                  |
| br.ufrn.sipac.contratos.dominio.NotaUndBeneficiada            | administrativo.contratos.notafiscal_unidade        |
| br.ufrn.sipac.contratos.dominio.NotaUndBeneficiadaReferencia  | administrativo.contratos.nota_und_benef_referencia |
| br.ufrn.sipac.contratos.dominio.OcorrenciaContrato            | administrativo.contratos.ocorrencia_contrato       |
| br.ufrn.sipac.contratos.dominio.ReferenciaNotaFiscal          | administrativo.contratos.referencia_notafiscal     |
| br.ufrn.sipac.contratos.dominio.UnidadeBeneficiada            | administrativo.contratos.unidade_beneficiada       |
====== Plano de Teste ======

Sistema: SIPAC

Módulo: Portal Administrativo

Link(s): Caminho : aba Contratos -> Fiscalização -> gestão Pagamento -> Adicionar Nota Fiscal 

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 =====

  * Verificar se contratos não fiscalizados pelo fiscal estão sendo exibidos.

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

  * Obter um contrato qualquer:
    * 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
  * Deslogar do sistema e logar com o usuário associados como fiscal ao contrato