~~ODT~~

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

====== Cadastrar Processo de Pagamento ======

Esse caso de uso é utilizado pelos gestores de contrato com a finalidade de cadastrar Processos de Pagamento, ação necessária para que possa ser feita a solicitação de pagamentos relativos a um contrato.

O Cadastro de Processos de Pagamentos de um Contrato gera o processo a ser encaminhado ao Ordenador de Despesa da Unidade a qual o processo foi destinado, para que o pagamento relativo às notas fiscais associadas ao processo possa ser efetuado.

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

Este caso de uso inicia-se quando o Usuário acessa a opção SIPAC → Módulo Contratos → Aba Pagamento → Processos de Pagamento → Cadastrar Processo de Pagamento.


=== Passo 1===

Para cadastrar o processo de pagamento, é necessário primeiro realizar uma busca pelas notas fiscais, através dos parâmetros (podem ser selecionadas uma ou mais opções para busca):

  * **Empenho**: Tipo NUMÉRICO.
  * **Ano**: Tipo NUMÉRICO, formato: AAAA.
  * **Período de Emissão**: Tipo DATA, Formato - MM/AAAA a MM/AAAA
  * **Número**: Tipo NUMÉRICO.
  * **Série**: Tipo: TEXTO.([[desenvolvimento:especificacoes:sipac:contratos:casos_de_uso:pagamento:nota_fiscal:adicionar_nota_fiscal|detalhes para adicionar Nota Fiscal]]).
  * **Contrato**:
    * **Número**: Tipo - NUMÉRICO, Formato - AAAA
    * **Ano**: Tipo - NUMÉRICO,  Formato - AAAA
    * **Tipo**: Tipo - TEXTO.
  * **Contrato**:
    * **Novo Número:** Tipo: NUMÉRICO, Formato - 9999.99.9999.
  * **Fornecedor**: Tipo - AUTOCOMPLETE, formato: DENOMINAÇÃO FORNECEDOR - DOCUMENTO FORNECEDOR, entrada de dados: DENOMINAÇÃO ou DOCUMENTO.
  * **Material**: Tipo - TEXTO.
  * **Grupo de material**: Tipo - TEXTO.
  * **Apenas notas fiscais cadastradas pelo seu setor**: Caso seja assinalada essa opção, apenas as notas fiscais cadastradas pelo setor do Gestor de Contratos serão exibidas. Tipo LÓGICO.
  * **Apenas notas fiscais não pagas**: Caso seja assinalada, serão listadas apenas a notas fiscais que ainda não foram totalmente pagas. Tipo LÓGICO.

Os filtros para esta consulta são selecionados e/ou combinados, conforme desejado pelo usuário.

Realizada a consulta é disponibilizada a //Lista de Notas Fiscais Encontradas// ([[desenvolvimento:especificacoes:sipac:almoxarifado:casos_de_uso:estoque:consultas:consulta_de_notas_fiscais|Consulta de Notas Fiscais]]) que exibe os seguintes dados para cada nota fiscal:

  * **__N°__**: Tipo - NUMÉRICO.
  * **__Série__**: Tipo - TEXTO.
  * **__Fornecedor__**: Tipo - TEXTO.
  * **__Emissão__**: Formato DD/MM/AAAA. Tipo - DATA.
  * **__Valor__**: Tipo - NUMÉRICO.

Cada uma das notas fiscais exibidas nesta lista possui opções para //Visualizar// e //Escolher// ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN01, RN02]]). A primeira permite que seja feita a visualização detalhada da nota fiscal (sendo possível também fazer a impressão da mesma) e o segundo permite que esta nota fiscal seja selecionada para o processo de pagamento. Ao selecionar a opção //Escolher//, a nota fiscal exibida na lista será sinalizada, indicando que está selecionada para o processo de pagamento.

A informação **//Notas Fiscais no Processo de Pagamento//** é exibida e apresenta a quantidade de notas fiscais selecionadas. Também é possível utilizar a opção //Ver Notas Fiscais// para que o sistema exiba uma lista contendo apenas as notas fiscais selecionadas.

Escolhendo opção de visualizar a Nota Fiscal, são exibidos os Dados da Nota, os empenhos (se existir) e os itens da Nota (se existir):
  * **__Nota Fiscal:__** Tipo - NUMÉRICO.
  * **__Série:__** Tipo - TEXTO .
  * **__Data de Emissão:__** Formato - DD/MM/AAAA, Tipo - DATA.
  * **__Data de Atesto:__** Formato - DD/MM/AAAA, Tipo - DATA.
  * **__Licitação:__** Formato - XX (SIGLA DA MODALIDADE) - 99/AAAA (Processo: 99999/AAAA), Tipo - TEXTO, NUMÉRICO.
  * **__Fornecedor:__** Tipo - TEXTO.
  * **__CPF/CNPJ:__** Formato - 999.999.999/99 (CPF), 99.999.999/9999-99 (CNPJ), Tipo - TEXTO.
  * **__Endereço:__** Tipo - TEXTO.
  * **__Data de cadastro:__**  Formato - DD/MM/AAAA HH:MM:SS, Tipo - DATA. 
  * **__Usuário de cadastro:__** Tipo - TEXTO.

  *Empenhos da Nota:
    * **Número/Ano**: Formato - 999999/AAAA, Tipo - NUMÉRICO.
    * **Observações**: Tipo - TEXTO.
    * **Valor**: Tipo - NUMÉRICO.
    * **Saldo**: Tipo - NUMÉRICO.

  *Lista com Itens da Nota Fiscal:
    * **Código**: Formato - 999999999999, Tipo - NUMÉRICO.
    * **Denominação**: Tipo - TEXTO.
    * **Medida**: Tipo - TEXTO.
    * **Qtde.**: Tipo - NUMÉRICO.
    * **Valor**: Tipo - NUMÉRICO.
    * **Total**: Tipo - NUMÉRICO. Corresponde a Quantidade (Qtde) * Valor.
    * **Valor Total da Nota**: Tipo - NUMÉRICO. Corresponde a soma do valores de cada item da Nota.

  * Sistema apresenta opção para [[#modelo_de_impressão_de_nota_fiscal|imprimir Nota Fiscal]], conforme especificado neste documento .

=== Passo 2===

Selecionando as notas fiscais para o processo de pagamento, o sistema solicita os seguintes dados a serem informados:([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN09]])

  * **__Tipo de processo__**: Tipo - TEXTO. Exemplo do tipo de processo: ''PAGAMENTO''. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN07]])
  * **__Data de origem__**: Formato - DD/MM/AAAA, Tipo - DATA. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN07]])
  * **__Unidade de Origem__**: Tipo - TEXTO. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN07]]) 
  * **__Interessado__**: Tipo TEXTO. 
  * **Unidade de Destino***: Formato: CÓDIGO DA UNIDADE | NOME DA UNIDADE | ÁRVORE DE UNIDADES, Tipo - NUMÉRICO, AUTOCOMPLETE e TEXTO. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN07]])
  * **Ordenador de Despesa***: TEXTO. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN12]]) 
  * **Assunto***: Formato, //"Solicitação de Pagamento - Valor: 9,99"//, porém este pode ser editado. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN07]])
  * **__Data de Cadastro__**: Data da realização do cadastro do processo de pagamento, ou seja, data atual. Formato - DD/MM/AAAA. Tipo - DATA. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN08]])
  * **Processo (Número/Ano)**: Formato RADICAL - NÚMERO DO PROCESSO /AAAA - DIGÍTO VERIFICADOR. Tipo - NUMÉRICO. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN04, RN03, RN08]]). O número do radical do processo só será editável se o parâmetro INFORMA_RADICAL_PROTOCOLO estiver configurado como TRUE.
  * **__CPF/CNPJ__**: Formato - 99.999.999/9999-99 para CNPJ, 999.999.999-99 para CPF. Tipo - TEXTO. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN08]])
  * **Observações**: Tipo TEXTO. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN03, RN07]])
  * **Observações para Despacho para Pagamento**: Tipo TEXTO. ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN11]])

===Passo 3===

Para ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN03]]) = TRUE:

O sistema confirma o cadastro e exibe os dados do processo de protocolo e dados complementares:

Dados do processo de protocolo:
    ***__Número do processo__**: Formato - 99999.999999/AAAA-99, Tipo - NUMÉRICO.
    ***__Tipo de processo__**: Tipo - TEXTO.
    ***__Data de origem__**: Formato DD/MM/AAAA. Tipo DATA.
    ***__Unidade de Origem__**: Tipo - TEXTO.
    ***__Unidade de Destino__**: Tipo - TEXTO.
    ***__Interessado(s)__**: Formato - NOME (99.999.999/9999-99)
    ***__Assunto__**: Tipo - TEXTO. Neste campo é exibido o valor da solicitação do pagamento.
    ***__Observação__**: Tipo - TEXTO.
Dados complementares 
    ***__Fornecedor__**: Formato - NOME (99.999.999/9999-99)
    ***__Valor R$__**: Tipo - NUMÉRICO.



Para ([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN03]]) = FALSE:

O sistema exibe os dados para confirmação:

  * **Data de Cadastro**: Formato DD/MM/AAAA. Tipo - DATA.
  *Dados das Notas Fiscais:
    ***__Número__**: Tipo - NUMÉRICO.
    ***__Série__**: Tipo - TEXTO.
    ***__Fornecedor__**: Tipo - TEXTO.
    ***__Emissão__**: Formato - DD/MM/AAAA, Tipo - DATA.
    ***__Valor__**: Tipo - NUMÉRICO.
    ***__Empenho__**: Formato - NUMÉRICO/AAAA, Tipo - NUMÉRICO.

O sistema solicita que o Gestor confirme o cadastro do processo, após confirmar exibe os dados:

    ***Fornecedor**: Formato -  NOME (999.999.999-99), Tipo - TEXTO.
    ***Processo**: Formato -  99999.999999/AAAA-99, Tipo - NUMÉRICO.
    ***Valor**: Tipo - NUMÉRICO.
    *O sistema também exibe as opções:
       *Imprimir [[desenvolvimento:especificacoes:sipac:contratos:casos_de_uso:pagamento:processos_de_pagamento:cadastrar_processo_de_pagamento#modelo_de_impressão_de_nota_fiscal|Capa do Processo]].([[#PRINCIPAIS REGRAS DE NEGÓCIO|RN03]])
           *A capa do processo possui a opção de //Código de barras// para permitir o recebimento do processo com leitura de código de barras.
       *//Imprimir Despacho para Pagamento//, que permite que seja impresso o documento de encaminhamento do processo de pagamento para ser entregue ao Ordenador de Despesa. A mesma está especificada no caso de uso ([[desenvolvimento:especificacoes:sipac:contratos:casos_de_uso:consultas_relatorios:pagamento:despacho_para_pagamento|Consultar Despacho para Pagamento]])
       *//Cadastrar Outro Processo de Pagamento//, para facilitar o acesso ao cadastro de um novo processo.

==== Modelo de Capa do Processo ====

**Processo nº 99999.999999/AAAA-99**

Cadastro em DD/MM/AAAA.

**Nome(s) do interessado(s):** Tipo TEXTO.

**Identificador:** Formato 99.999.999/9999-99. Tipo TEXTO.

**Tipo do Processo:** Tipo TEXTO. Exempo: PAGAMENTO.

**Unidade de Origem:** Tipo TEXTO.

**Criado por:** Tipo TEXTO.

**Observação:** Tipo TEXTO.


**Movimentações Associadas**
^Data ^ Destino ^ Data ^ Destino ^
|DD/MM/AAAA| DCF - SECRETARIA ADMINISTRATIVA (11.02.02.07)|-------|-------|
|-------| -------|-------|-------|
|-------| -------|-------|-------|


==== Modelo de impressão de Nota Fiscal ====

**Nota Fiscal**

**Dados da Nota Fiscal**

**Nota Fiscal:** Tipo NUMÉRICO. **Série:** Tipo TEXTO. **Data de Emissão:** Formato DD/MM/AAAA. Tipo DATA.

**Fornecedor:** Tipo TEXTO.

**Endereço:** Tipo TEXTO.  **CPF/CNPJ:** Tipo TEXTO.

**Empenhos**

^ Número/Ano ^ Observações ^  Valor^ Saldo ^
|999999/AAAA |Aquisição de Material Farmacológico |  R$ 9,99|  R$ 9,99|
| ------- | ------ | ------ | ------ |
| ------- | ------ | ------ | ------ |

**Itens da Nota Fiscal**
^ Código ^ Denominação ^  Medida ^ Quantidade ^ Valor ^ Total ^
|999999 | NIFEDIPINA | CAP |  150 |  R$ 9,99|  R$ 9,99|
| ------- | ------ | ------ | ------ | ------ | ------ |
| ------- | ------ | ------ | ------ | ------ | ------ |

**Valor Total da Nota Fiscal:** Corresponde ao soma do total de todos os itens da Nota Fiscal.


O caso de uso é finalizado.


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

  ***RN01** -  Não é possível selecionar uma nota fiscal que esteja associada a algum processo de pagamento cadastrado.
  ***RN02** -  Ao selecionar mais de uma nota fiscal para o processo de pagamento, o fornecedor cadastrado na nota deve ser o mesmo do das demais notas inseridas.
  ***RN03** -  Se o parâmetro CRIA_PROTOCOLO_PROCESSO_PAGAMENTO_CONTRATOS e UTILIZA_PROTOCOLO_SIPAC for FALSE, não cria processo no protocolo e vai gravar o númeor do processo em formato string na coluna num_protocolo em liquidacao.processo_pagamento. Se for TRUE mantém o estado do caso de uso, criando um processo no protocolo ao fim do cadastro do processo de pagamento. 
  ***RN04** -  Não é permitido alterar a **Unidade Destino** do processo existente. (//Regra para o processo//: [[desenvolvimento:especificacoes:sipac:contratos:casos_de_uso:pagamento:processos_de_pagamento:criar_usando_processo_existente|criar usando processo existente]])
  ***RN05** -  Deve ser possível efetuar pagamento em processo já existente, por exemplo: no mês de janeiro já foi atuado um processo para pagamento de energia elétrica, no mês de fevereiro o pagamento pode ser efetuado no mesmo processo. (//Regra para o processo//: [[desenvolvimento:especificacoes:sipac:contratos:casos_de_uso:pagamento:processos_de_pagamento:criar_usando_processo_existente|criar usando processo existente]])
  ***RN07** -  Se o parâmetro CRIA_PROTOCOLO_PROCESSO_PAGAMENTO_CONTRATOS e UTILIZA_PROTOCOLO_SIPAC forem TRUE o campo é exibido.
  ***RN08** -  Se o parâmetro CRIA_PROTOCOLO_PROCESSO_PAGAMENTO_CONTRATOS e UTILIZA_PROTOCOLO_SIPAC forem FALSE o campo é exibido.
  ***RN09** -  Se houver um contrato associado a nota fiscal, este deve ser também associado a um empenho.
  ***RN10** -  O sistema só deve permitir que o usuário selecione a nota fiscal se a mesma já estiver associada ao contrato.
  ***RN11** -  O campo é visível se processo de pagamento ocorrer pelo módulo de CONTRATOS
  ***RN12** -  O campo é visível se as notas forem cadastradas pelo portal do fornecedor.
 

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

"Não se Aplica".  

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

^ Classe ^ Tabela |
| br.ufrn.sipac.contratos.dominio.Contrato               | administrativo.contratos.contrato         |
| br.ufrn.sipac.contratos.dominio.EmpenhoContrato        | administrativo.contratos.empenho_contrato |
| br.ufrn.sipac.almoxarifado.entradas.dominio.NotaFiscal | administrativo.liquidacao.nota_fiscal     |

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

Sistema: SIPAC

Módulo: Contratos

Link(s): Pagamento -> Processos de Pagamento -> Cadastrar Processo de Pagamento

Usuário: rcsl (GESTOR_CONTRATO)

Papel que usuário deve ter: GESTOR_CONTRATO (manipular contratos) 

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

  * Realizar os testes setando diferentes valores do parâmetro CRIA_PROTOCOLO_PROCESSO_PAGAMENTO_CONTRATOS eUTILIZA_PROTOCOLO_SIPAC. Se for false, não será criado processo no protocolo ao cadastrar um processo de pagamento, ser for true o caso de uso se comportará normalmente.
  * Para verificar se o cadastro foi efetuado com sucesso, na ultima etapa do cadastro é exibido o número e ano do processo criado. Obter essas informações e utilizar no caso de uso Alterar Processo de Pagamento por exemplo. Segue o caminho: //**SIPAC -> Módulo Contratos -> Aba Pagamento -> Processos de Pagamento -> Alterar Processo de Pagamento**//
  * Verificar se foi criado um histórico referente à mudança de status da nota fiscal com status de ''EM PAGAMENTO'' no caso de uso de [[desenvolvimento:especificacoes:sipac:almoxarifado:casos_de_uso:estoque:estoque:nota_fiscal:listar_alterar|Listar/Alterar Nota Fiscal]].

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

  * Primeiro o testador deve cadastrar uma nota fiscal para poder associar um processo de pagamento, essa operação pode ser realida no caso de uso: //**SIPAC -> Módulo Contratos -> Aba Pagamento -> Nota Fiscal -> Adicionar Nota Fiscal**//
  * Após nota fiscal adicionada, o testador poderá filtrar seu número no momento da associação da nota fiscal ao processo de pagamento.
  * Para encontrar números de processo que não batam com processos já existentes, utilizar o SQL abaixo:
    * <code> Select processo.radical, processo.num_protocolo, processo.ano,processo.dv  FROM liquidacao.processo_pagamento pp join protocolo.processo processo ON (pp.id_processo=processo.id_processo) order by processo.ano DESC </code>