====== Especificação Funcional: Emissão de Cupons ======

===== Resumo =====

Emissão de cupons promocionais a serem distribuídos para os produtores rurais que emitirem notas fiscais.

===== Descrição =====

A emissão de cupons serve para que a Prefeitura possa distribuir cupons numerados aos produtores. Estes cupons podem ser utilizados para sorteios, como forma de incentivar a emissão de notas fiscais.

==== Seleção de produtores ====

=== Por quê ===
Selecionar os produtores para os quais se deseja gerar cupons.

=== Como ===
  * Selecionar o período (ano) referente à data de emissão das notas fiscais;
  * Selecionar as naturezas de operação das notas fiscais que vão gerar cupons;
  * Selecionar o modo de impressão (nova impressão ou reimpressão de cupons).

=== Resultado ===

No modo de nova impressão, devem ser listados todos os produtores que tenham notas fiscais cadastradas que ainda não tenham gerado cupons naquele ano, com as naturezas de operação selecionadas e com data de emissão no ano selecionado;

No modo de reimpressão, devem ser listados todos os produtores que tenham notas fiscais que já geraram cupons para o ano selecionado.

Todos os produtores listados devem estar marcados por padrão o usuário deve poder desmarcar aqueles para os quais não deseja gerar cupons.

==== Seleção das notas fiscais ====

=== Por quê ===
Selecionar as notas fiscais cadastradas para as quais se deseja gerar cupons (somente para impressão de novos cupons).

=== Como ===
  * Selecionar um produtor da lista de produtores;

=== Resultado ===
O sistema deve listar as notas emitidas pelo produtor selecionado, exceto aquelas para as quais já foram gerados cupons, por ordem de número da nota. Também devem ser exibidos a data de emissão e o valor de cada nota. no modo de nova impressão, todas as notas listadas devem estar marcadas por padrão e o usuário deve poder desmarcar aquelas para as quais não deseja gerar cupons. No modo de reimpressão, não deve ser possível marcar ou desmarcar as notas, pois a lista exibe as notas que foram selecionadas no momento da geração de novos cupons.

Ao listar as notas e ao marcar/desmarcar uma nota, o sistema deve exibir um resumo com:

  * O valor total das notas marcadas;
  * O valor do saldo calculado anteriormente em função do valor das notas e do valor por cupom;
  * O valor do saldo que poderá ser utilizado para os próximos cupons;
  * A quantidade de cupons a serem impressos: depende da configuração "valor para cálculo dos cupons". A quantidade de cupons deve ser calculada dividindo a soma do valor das notas marcadas com o saldo anterior pelo valor por cupom, sempre arredondando o resultado para baixo;
  * Os números do primeiro e do último cupons a serem impressos, quando aplicável.

Os passos acima podem ser repetidos para todos os produtores para os quais se quer conferir ou marcar/desmarcar as notas.


==== Gerar cupons ====

=== Por quê ===
Imprimir os cupons referentes às notas fiscais marcadas para distribuir aos produtores.

=== Como ===
Acionar a opção de gerar cupons.

=== Resultado ===
Para novos cupons, o sistema deve:

  * Exibir um resumo de tudo que será impresso para que o usuário confirme: quantidade de produtores selecionados, valor total das notas fiscais, quantidade de cupons e o número do primeiro e último cupons. A quantidade de cupons calculada deve respeitar o limite configurado no sistema, quando aplicável. Caso o usuário confirme a impressão, segue para o próximo passo;
  * Caso não haja nenhum produtor selecionado, exibir um alerta e não permitir a impressão;
  * Caso as notas selecionadas não gerem nenhum cupom, exibir um alerta e não permitir a impressão;
  * Caso a quantidade de cupons a ser impressa exceda o limite máximo de cupons por impressão (não configurável), exibir um alerta e não permitir a impressão;
  * Exibir a visualização da impressão dos cupons para que o usuário possa fazer a impressão e confirmar se os cupons foram impressos com sucesso. Em caso afirmativo, o número do último cupom deve ser registrado para a próxima impressão e o sistema deve permitir a impressão do comprovante de emissão de cupons, contendo:
    * Título com o texto da campanha;
    * Resumo total: valor total das notas fiscais, quantidade de notas fiscais, quantidade de cupons, números do primeiro e último cupons impressos
    * Para cada produtor:
      * Dados do Produtor: Nome, inscrição estadual, localidade, distrito e data da impressão;
      * Resumo dos cupons: valor total das notas fiscais, quantidade de notas fiscais, quantidade de cupons, números do primeiro e último cupons impressos e os números das notas fiscais que deram origem aos cupons;
    * Espaço para assinatura/carimbo do funcionário do NAC.

Para reimpressão de cupons, o sistema somente deve exibir a visualização da impressão dos cupons já gerados para que o usuário possa fazer a impressão e a visualização do comprovante de emissão de cupons.

O sistema deve gerar os documentos em HTML e abri-los no navegador padrão do usuário para que ele possa fazer a impressão.

=== Configurações de impressão ===

Todos os modelos de cupons devem ser impressos em papel tamanho A4 e na orientação retrato (folha em pé).

Os cupons gerados já definem as margens de impressão padrão. Caso o navegador do usuário não respeite estas configurações, ele poderá alterar as margens para que a impressão seja feita corretamente.

As margens padrão são de 10mm em todos os lados, exceto nos cupons em tamanho maior, que tem margem zero.

===== Configurações e preferências do usuário =====

  * **Texto da campanha**: texto a ser exibido nos cupons e no comprovante de emissão de cupons;
  * **Valor para cálculo dos cupons**: valor das notas fiscais correspondente a 1 cupom. Padrão: 50,00;
  * **Número do último cupom**: número do último cupom cuja impressão foi confirmada pelo usuário. Padrão: 0;
  * **Tamanho dos cupons**: Normal (27 por página), Reduzido (65 por página) ou Maior (10 por página). Padrão: Normal;
  * **Limite de cupons por produtor**: quantidade máxima de cupons que cada produtor pode gerar por ano. Padrão: 1.000. 0 (zero) significa sem limite.
  * **Somente notas fiscais validadas**: utilizar apenas as notas validadas para gerar cupons. Padrão: desativado.

Todas as configurações devem ser compartilhadas.

===== Pontos de verificação =====

==== Na seleção de notas fiscais ====

  * O sistema deve apresentar apenas os anos que tiverem notas cadastradas;
  * O sistema deve apresentar apenas os produtores que tiverem emitido notas fiscais de acordo com o critérios selecionados na tela de emissão de cupons e nas configurações de emissão de cupons (nova impressão) ou que já tiverem gerado cupons para o ano selecionado (reimpressão);
  * A quantidade de cupons gerada deve ser compatível com o valor total das notas marcadas, com o saldo anterior de cada produtor, com o valor para cálculo dos cupons e com o limite de cupons por produtor;
  * Para novos cupons, o número do primeiro cupom a ser impresso deve ser o número do último cupom mais um;
  * O número do último cupom deve ser igual ao número do primeiro cupom somado com a quantidade de cupons.

==== Na geração de cupons ====

  * Uma vez gerados os cupons para uma nota fiscal, a mesma não deve mais ser exibida para impressão de novos cupons e deve ser exibida na reimpressão dos mesmos;
  * Só devem ser gerados cupons se houver um valor total suficiente para gerar ao menos um cupom;
  * A quantidade máxima de cupons que pode ser impressa de uma só vez é de 10.000.

==== Nas configurações ====

  * O texto da campanha não deve ultrapassar 50 caracteres;
  * O valor para cálculo dos cupons deve maior que zero;
  * O número do último cupom deve maior ou igual a zero;
  * O limite de cupons por produtor deve ser maior ou igual a zero.

===== Observações =====


~~DISCUSSION|Sugira mudanças, aponte falhas ou contribua de alguma forma aqui:~~