====== Especificação Funcional: Envio de notas fiscais para a SEFAZ ======

===== Resumo =====
O usuário deve ser capaz de enviar as notas cadastradas para a Secretaria da Fazenda através da Internet.

===== Descrição =====
Com o objetivo de auxiliar na apuração do IPM, a SEFAZ-ES disponibilizou um serviço para a transmissão de notas fiscais de produtor pela Internet. O sistema responsável por receber as informações é o SICOP -- [[http://internet.sefaz.es.gov.br/agenciavirtual/area_restrita/sicop/index.php|Sistema de Controle das Operações de Produtor Rural]], no módulo SICOP-Importação, um Web service que tem a finalidade de receber as notas fiscais em lotes. O diagrama abaixo mostra uma visão geral dos sistemas envolvidos na transmissão das notas fiscais de produtor:

{{ :softwares:geagro:requisitos:modulos:outros:diagrama_sicop.png |Sistemas envolvidos na transmissão das notas fiscais de produtor}}

{{:softwares:geagro:requisitos:modulos:outros:ids_necessarios_webservice.pdf|Estes}} são os códigos necessários para o envio das informações.


==== Pré-condições ====

Para que as notas fiscais possam ser enviadas, é necessário que satisfaçam às seguintes condições:
  * Devem estar cadastradas no sistema;
  * Devem ter sido emitidas dentro do período dos anos base disponibilizados pela SEFAZ no momento da transmissão. Um ano base pode ser definitivo ou provisório.
    * Ano base definitivo: são aceitas notas emitidas no ano em questão e nos quatro anos anteriores;
    * Ano base provisório: são aceitas somente notas emitidas no ano em questão;
  * O destinatário deve ter CPF ou CNPJ válido.
Além disto, é necessário que o usuário esteja cadastrado no SICOP e informe seus dados de login (CPF e senha) no cadastro de [[softwares:geagro:requisitos:modulos:outros:usuarios|contas de usuários]].

==== Lotes de Notas Fiscais ====

A transmissão das notas fiscais será feita em lotes. O SICOP recebe os lotes e os processa, retornando a resposta em seguida.
  * Cada lote deve conter no mínimo 1 (uma) e no máximo 1.000 (mil) notas;
  * O usuário deverá ter a opção de gerar novos lotes. Para isto, o sistema buscará as notas ainda não transmitidas com sucesso, dentro do período do ano base selecionado e ordenadas pelo número da inscrição do produtor;
    * Ao gerar novos lotes, as notas já pertencentes a algum lote mas ainda não transmitidas com sucesso também serão alocadas em novos lotes;
  * Um lote pode ser transmitido quantas vezes for necessário até que todas as notas que o compõem tenham sido transmitidas com sucesso.

==== Envio ====

O usuário deve ser capaz de consultar os anos base ativos no momento e selecionar um ano base a partir da lista apresentada.

Ao entrar na tela de transmissão de notas, o sistema deve automaticamente consultar os anos base. 
O usuário poderá atualizar essa lista quando desejar.

Quando um ano base for selecionado, o sistema deve exibir a lista dos lotes gerados para aquele ano, com a opção de gerar novos lotes. A lista de lotes deve ter os seguintes dados:
  * Número do lote;
  * Data do envio;
  * Quantidade total de notas;
  * Quantidade de notas aceitas;
  * Quantidade de nota rejeitadas

Todos os lotes com notas ainda não transmitidas com sucessos devem vir marcados para serem enviados.
O usuário poderá alterar a marcação de cada lote individualmente, marcar todos, demarcar todos ou inverter a marcação dos lotes.

Deve ser exibido ainda o período correspondente ao ano selecionado.

Quando um lote for selecionado, o sistema deve exibir a lista das notas daquele lote, com os seguintes dados:
  * Número da nota fiscal;
  * Data de emissão;
  * Número da inscrição estadual do produtor;
  * Valor da nota fiscal;
  * Status do envio;
  * Mensagem de retorno;
  * Número do protocolo fornecido pela SEFAZ.

As notas devem ser diferenciadas por cores para identificar facilmente as notas rejeitadas/não enviadas.

Quanto à transmissão para a SEFAZ, cada nota poderá ter o status:
  * **Não transmitida**: nota cadastrada no sistema mas ainda não transmitida, mesmo que já tenha sido enviada **sem sucesso**;
  * **Transmitida**: nota transmitida com sucesso. Uma nota transmitida pode não passar pela validação, que é feita posteriormente pela SEFAZ;
  * **Validada**: nota transmitida e aceita pela SEFAZ;
  * **Invalidada**: nota transmitida e rejeitada pela SEFAZ. Neste caso, é preciso fazer a retificação. **As notas invalidadas comporão o recurso.**

Para cada nota, deve ser enviado o código do produto segundo a {{:softwares:geagro:biblioteca:categorias_sefaz_2010.pdf|classificação da SEFAZ}}. Como uma única nota pode ter itens de categorias diferentes, o sistema deve determinar o código a ser enviado pela categoria do item com maior quantidade em cada Nota Fiscal.

O usuário poderá marcar um ou mais lotes para serem transmitidos em sequência. Ao transmitir um lote, o sistema deverá atualizar o status das notas enviadas.

Como não há uma forma automatizada de consultar o status das notas no banco de dados da SEFAZ após a transmissão, o usuário poderá fazer a consulta manualmente através do SICOP-Web e alterar o status das notas transmitidas para //Validada// ou //Invalidada// no sistema.

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

==== Configurações do sistema ====

  * **Usar um servidor proxy para acesso à Internet**: Configura o acesso à Internet: direto ou por meio de proxy;
    * **Endereço do proxy**: Configura o endereço do servidor proxy, se a acesso por proxy estiver ativado;
    * **Porta do proxy**: Configura a porta de acesso ao servidor proxy, se a acesso por proxy estiver ativado;
  * **Quantidade de notas fiscais por lote**: Define a quantidade de notas fiscais a serem enviadas de cada vez. O valor padrão é 200.

==== Outras configurações ====

O endereço do serviço de recepção de notas fiscais deve ser configurável. Porém, esta configuração não estará disponível para o usuário.

URL: http://www.sefaz.es.gov.br/wsSicopImportacao/

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

  * Somente devem ser incluídas nos novos lotes as notas fiscais não transmitidas;
  * O período exibido ao selecionar um ano base deve corresponder ao tipo do ano: definitivo ou provisório. No definitivo são aceitas notas emitidas no ano base e nos quatro anos anteriores; no provisório, somente notas emitidas no ano base;
  * Um lote não pode conter notas fiscais fora do período do ano base para o qual foi gerado;
  * As notas fiscais de um mesmo lote devem estar ordenadas por número da inscrição estadual;
  * Um lote não pode ser gerado com mais notas que o permitido pela configuração **Quantidade de notas fiscais por lote**;
  * Todas as notas transmitidas com sucesso deverão ser automaticamente marcadas como //Validadas//. Independente do resultado da transmissão, o campo "Motivo do retorno" deverá conter a mensagem recebida da SEFAZ após a transmissão.

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


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