Wiki Java - Interno - Contribuições do usuário [pt-br]

Painel de versões do Resulth WEB

2015-06-01T13:10:24Z

Daniel: /* Administração */

= Cadastro =
O acesso ao painel é restrito a usuários cadastrados com permissões específicas para cada um. Para cadastrar-se solicite autorização ao responsável pelo setor de desenvolvimento.

= Administração =
== Grupos ==
Rotina onde podem ser criados grupos com perfis de acesso específicos no painel, que futuramente serão utilizados no cadastro de usuários.

== Usuários ==
Rotina onde são cadastrados os usuários autorizados a acessar o painel com suas devidas permissões de acesso.

== Repositório de versões ==
Rotina onde são cadastrados os repositórios de versão do painel. É destes repositórios que serão buscadas as versões tanto para atualização quanto para criação.

== Servidores ==

== Servidores de banco de dados ==

== Sistemas ==

= Servidores =

= Agendamento =
Nesta rotina é possível agendar tarefas para serem executadas em um determinado dia e horário no servidor através das seguintes funcionalidades:

#'''Botão [Agendar tarefa]:''' Quando acionado direciona o usuário para tela de agendamento de tarefas que é composta por:
#*'''Tarefa:''' ''Combobox'' que exibe as tarefas podem ser executadas através do agendamento pelo painel. Atualmente as opções são as seguintes:
#*#'''Atualizar versão:'''
#*#'''Criar link:'''
#*#'''Limpar índices do lucene:'''
#*#'''Parar tomcat:'''
#*#'''Reiniciar tomcat:'''
#*#'''Iniciar tomcat:'''
#*'''Data agendada:''' Campo onde deverão ser selecionados data e hora em que a tarefa selecionada será executada. Atualmente os horários autorizados para o agendamento de tarefas são de '''23:01 as 05:00'''.


'''É expressamente proibido''' o agendamento de qualquer tarefa entre os horários de '''05:01 as 23:00 de segunda a domingo'''.
Qualquer agendamento fora do período autorizado só pode ser feito diante autorização de um superior.

= Logs de usuários =

Painel de versões do Resulth WEB

2015-06-01T12:54:51Z

Daniel: /* Agendamento */

= Cadastro =
O acesso ao painel é restrito a usuários cadastrados com permissões específicas para cada um. Para cadastrar-se solicite autorização ao responsável pelo setor de desenvolvimento.

= Administração =

= Servidores =

= Agendamento =
Nesta rotina é possível agendar tarefas para serem executadas em um determinado dia e horário no servidor através das seguintes funcionalidades:

#'''Botão [Agendar tarefa]:''' Quando acionado direciona o usuário para tela de agendamento de tarefas que é composta por:
#*'''Tarefa:''' ''Combobox'' que exibe as tarefas podem ser executadas através do agendamento pelo painel. Atualmente as opções são as seguintes:
#*#'''Atualizar versão:'''
#*#'''Criar link:'''
#*#'''Limpar índices do lucene:'''
#*#'''Parar tomcat:'''
#*#'''Reiniciar tomcat:'''
#*#'''Iniciar tomcat:'''
#*'''Data agendada:''' Campo onde deverão ser selecionados data e hora em que a tarefa selecionada será executada. Atualmente os horários autorizados para o agendamento de tarefas são de '''23:01 as 05:00'''.


'''É expressamente proibido''' o agendamento de qualquer tarefa entre os horários de '''05:01 as 23:00 de segunda a domingo'''.
Qualquer agendamento fora do período autorizado só pode ser feito diante autorização de um superior.

= Logs de usuários =

Painel de versões do Resulth WEB

2015-06-01T12:47:15Z

Daniel: /* Agendamento */

= Cadastro =
O acesso ao painel é restrito a usuários cadastrados com permissões específicas para cada um. Para cadastrar-se solicite autorização ao responsável pelo setor de desenvolvimento.

= Administração =

= Servidores =

= Agendamento =
Nesta rotina é possível agendar tarefas para serem executadas em um determinado dia e horário no servidor através das seguintes funcionalidades:

#'''Botão [Agendar tarefa]:''' Quando acionado direciona o usuário para tela de agendamento de tarefas que é composta por:
#*'''Tarefa:''' ''Combobox'' que exibe as tarefas podem ser executadas através do agendamento pelo painel. Atualmente as opções são as seguintes:
#*#'''Atualizar versão:'''
#*#'''Criar link:'''
#*#'''Limpar índices do lucene:'''
#*#'''Parar tomcat:'''
#*#'''Reiniciar tomcat:'''
#*#'''Iniciar tomcat:'''
#*'''Data agendada:''' Campo onde deverão ser selecionados data e hora em que a tarefa selecionada será executada.

= Logs de usuários =

2015-05-08T17:03:33Z

Daniel: /* Gráfico de compras */

= Objetivo =
*Manter cadastro de clientes.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]].
*No projeto da rotina, em confsrc > META-INF > messages > view.properties definir o nome como '''Cadastro de cliente'''. Este nome será utilizado para criar a página no Wiki.
*Gerar log/auditoria para as alterações realizadas na rotina.

= Resultado esperado =
*Cadastrar clientes no sistema.

= Diagrama de classes =
[[File:Pessoa.png|1100px]]

= Layouts sugeridos =
<gallery>
File:CadastroClienteDadosGerais.png | Aba '''Dados gerais'''
</gallery>

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:'''

== Fluxos alternativos ==
=== Histórico ===
'''Fluxo 1:''' Usuário acessa o cadastro de um determinado cliente já existente em modo de consulta ou em modo de alteração.
*Sistema exibe, em ambos os casos, a aba '''Histórico''' conforme regra de negócio [[#RN07 - Histórico | RN07]].
*Tanto para o modo de consulta quanto para o modo de alteração, '''todas''' as sub-abas do histórico serão '''somente leitura'''.

'''Fluxo 2:''' Usuário realiza para um determinado cliente vendas com operações de saída diversificadas tendo o parâmetro '''Considerar em vendas''' marcado em algumas e desmarcado em outras.
*Serão consideradas na seção ''Dados de venda'' da sub-aba ''Dados estatísticos'' do histórico '''somente''' movimentações cuja operação possui '''marcado''' em seu cadastro o parâmetro '''Considerar em vendas'''.

'''Fluxo 3:''' Para uma ou mais categorias da seção ''Dados de venda'' na sub-aba ''Dados estatísticos'' do histórico, um determinado cliente possui duas ou mais vendas de mesmo valor.
*Será considerada a venda que mais se enquadre na respectiva categoria, conforme segue abaixo:
*#'''Primeira compra:''' Se no dia em que o cliente fez a primeira compra houver mais de um pedido, será considerado aquele de maior valor. Se houverem dois ou mais pedidos de mesmo valor, será considerado aquele com maior código.
*#'''Última compra:''' Se no dia em que o cliente fez a última compra houver mais de um pedido, será considerado aquele de maior valor. Se houverem dois ou mais pedidos de mesmo valor, será considerado aquele com maior código.
*#'''Maior compra:''' Se houver dois ou mais pedidos cujo valor total é superior aos demais pedidos do cliente, será considerado aquele de maior data e posteriormente o de maior código.
*#'''Menor compra:''' Se houver dois ou mais pedidos cujo valor total é inferior aos demais pedidos do cliente, será considerado aquele de maior data e posteriormente o de maior código.

== Fluxos de exceção ==
'''Fluxo 1:'''

= Regras de negócio =
== RN01 - Dados gerais ==
=== Dados do cliente ===
#'''Código:''' Exibe o código do cliente após o mesmo ser cadastrado.
#'''Pessoa:''' Permite ao usuário determinar o tipo de pessoa do cliente com as seguintes opções:
#*'''Física:''' Determina que o cliente é uma pessoa física e renderiza na tela a seção '''''Pessoa física'''''.
#*'''Jurídica:''' Determina que o cliente é uma pessoa jurídica e renderiza na tela a seção '''''Pessoa jurídica'''''. Além disso o sistema exibirá na tela, já marcado por padrão, o parâmetro '''Contribuinte ICMS'''.
#'''Ativo:''' Marcado por padrão sempre que exibido, este parâmetro determina se o cadastro do cliente está ativo ou não. Clientes cadastrados cujo parâmetro em questão está desmarcado '''não poderão ser utilizados''' em rotinas de movimentação do sistema, somente relatórios e consultas. Um cliente inativo se assemelha a um cliente não cadastrado, porém seu cadastro é mantido (inativo) para que as movimentações já realizadas pelo mesmo possam ser visualizadas.
#'''Bloqueado:''' Desmarcado por padrão, este parâmetro determina se um cliente está bloqueado para uso ou não. Clientes bloqueados podem ser visualizados em telas de movimentação, mas não poderão ser utilizados. Caso um cliente bloqueado seja selecionado em uma tela de movimentação do sistema uma mensagem será exibida ao usuário alertando-o que o mesmo está bloqueado e portanto não poderá ser utilizado.
#'''Não protestar:''' Desmarcado por padrão, este parâmetro determina se um cliente poderá ou não ser protestado na rotina '''''Protesto'''''.
#'''Contribuinte ICMS:''' Visível somente quando o tipo de pessoa do cliente for '''Jurídica''' e marcado por padrão, este parâmetro determina que o cliente é um contribuinte do ICMS, ou seja, vendas para o mesmo não se encaixam nas regras de venda para consumidores finais.
#'''Nome:''' Campo onde o usuário deverá, obrigatoriamente, informar o nome do cliente.
#'''Segmento:''' Campo onde serão listados todos os segmentos cadastrados no sistema para que o usuário possa, opcionalmente, selecionar um segmento para o cliente em questão.
#'''Renovar cadastro em:''' Campo onde o usuário poderá estabelecer uma data de renovação do cadastro do cliente. Se este dado não for informado o sistema entenderá que o cadastro não tem uma data de validade/renovação. Se uma data de renovação for informada, o cliente em questão '''não''' poderá ser utilizado em rotinas de movimentação caso a data de renovação esteja expirada.
#'''Protestar em:''' Campo onde o usuário poderá, opcionalmente, definir um prazo em dias para protestar o cliente. Esta informação será utilizada nas bolitas emitidas para o cliente e também na rotina de '''''Protesto'''''.
#'''Limite de atraso:''' Campo onde o usuário poderá, opcionalmente, definir um limite de dias de atraso para o cliente. Esta informação poderá ser utilizada por rotinas que verificam se o cliente está em atraso, cálculo de juros/multa e etc.
#'''Limite de crédito:''' Campo onde o usuário poderá estabelecer um limite de crédito para compras a prazo de um determinado cliente. Este limite será confrontado com valor dos vencimentos em aberto/atraso e com o valor do novo vencimento sempre que uma venda a prazo for feita.
#'''Cliente residente no exterior:''' No XML da Nota Fiscal 2.0 se o UF do cliente for EX não pode validar CNPJ, CPF e/ou Insc. Estadual
Caso o UF do cliente seja EX o município também deverá obrigatóriamente ser EX.

=== Pessoa física ===
#'''CPF:''' Campo onde o usuário poderá informar o CPF do cliente. A informação deste dado poderá ser obrigatória ou não de acordo com o estado do parâmetro '''Obrigar informação do CPF/CNPJ em cadastros?''' nos [[UC00006 - Parâmetros globais]] do sistema.
#'''Data de nascimento:''' Campo onde o usuário poderá informar a data de nascimento do cliente.
#'''Identidade:''' Campo onde o usuário poderá informar o RG do cliente.
#'''Emissor:''' Caso seja informado o RG, poderá ser informado neste campo o órgão emissor do mesmo.

As informações acima são renderizadas somente quando o tipo de pessoa selecionada para o cliente for '''Física'''.

=== Pessoa jurídica ===
#'''Nome fantasia:''' Campo onde o usuário poderá informar o nome fantasia do cliente que for pessoa jurídica.
#'''CNPJ:''' Campo onde o usuário poderá informar o CNPJ do cliente. A informação deste dado poderá ser obrigatória ou não de acordo com o estado do parâmetro '''Obrigar informação do CPF/CNPJ em cadastros?''' nos [[UC00006 - Parâmetros globais]] do sistema.
#'''Inscrição estadual:''' Campo onde o usuário poderá informar uma inscrição estadual para o cliente.
#'''Inscrição municipal:''' Campo onde o usuário poderá informar uma inscrição municipal para o cliente.
#'''Home page:''' Campo onde o usuário poderá informar o endereço da ''home page'' do cliente (caso exista).

As informações acima são renderizadas somente quando o tipo de pessoa selecionada para o cliente for '''Jurídica'''.

=== Endereço ===
#'''CEP:''' Campo onde o usuário poderá informar o CEP do cliente. Caso um CEP seja informado o sistema preencherá automaticamente os campos '''País''', '''UF''', '''Endereço''', '''Bairro''' e '''Cidade'''.
#'''País:''' Campo que exibirá todos os países cadastrados e ativos no sistema. Somente será permitido selecionar um país.
#'''UF:''' Campo que exibirá todas as unidades federativas cadastradas e ativas no sistema. Somente será permitido selecionar uma unidade federativa por vez.
#'''Endereço:''' Campos onde o cliente poderá informar o logradouro e seu respectivo tipo. Os tipos comportados atualmente são:
#*RUA
#*ACESSO
#*AEROPORTO
#*ALAMEDA
#*APARTAMENTO
#*AREA
#*AVENIDA
#*BECO
#*BELVEDERE
#*BLOCO
#*CAMINHO
#*CAMPO
#*CANTO
#*CHACARA
#*COLONIA
#*CONDOMINIO
#*CORREDOR
#*CONJUNTO
#*DISTRITO
#*ESCADA
#*ESPLANADA
#*ESTACAO
#*ESTRADA
#*FAVELA
#*FAZENDA
#*FEIRA
#*FERROVIA
#*FORTALEZA
#*GALERIA
#*JARDIM
#*LADEIRA
#*LAGO
#*LAGOA
#*LARGO
#*LOTEAMENTO
#*MORRO
#*NUCLEO
#*PARQUE
#*PASSARELA
#*PATIO
#*PONTE
#*PRACA
#*PRAIA
#*QUADRA
#*QUILOMETRO
#*QUINTA
#*RECANTO
#*RESIDENCIAL
#*RODOVIA
#*SETOR
#*SITIO
#*SUBIDA
#*SUPERQUADRA
#*TRAVESSA
#*TRECHO
#*TREVO
#*VALE
#*VEREDA
#*VIA
#*VIADUTO
#*VIELA
#*VILA
#'''Nº'''
#'''Complemento'''
#'''Bairro'''
#'''Cidade:''' Campo onde o usuário poderá informar/pesquisar, dentre as cadastradas, uma cidade para o cliente.
#'''Observação:''' Campo livre para informações sobre o endereço.

== RN02 - Informações adicionais ==
=== Informações adicionais do cliente ===
#'''Classificação:''' Campo onde serão listadas todas as classificações de cliente cadastradas no sistema para que o usuário selecione uma a ser utilizada no cliente.
#'''Tabela de preços:''' Campo onde serão listadas '''todas''' as tabelas de preço cadastradas no sistema para que o usuário selecione uma a ser utilizada no cliente. Uma vez que o cadastro de clientes é global, o usuário poderá selecionar qualquer tabela de preço dentre as cadastradas, mesmo se não estiverem amarradas à filial logada.
#'''Rota:''' Campo onde serão listadas todas as rotas cadastradas para que o usuário selecione uma a ser utilizada no cliente.
#'''Vendedor:''' Campo onde serão listados todos os vendedores cadastrados para que o usuário selecione um a ser utilizado no cliente.
#'''Trasportadora:''' Campo onde serão listados todos os vendedores cadastrados para que o usuário selecione um a ser utilizado no cliente.
#'''Retém ISS:''' Parâmetro que determina se o cliente retem ISS quando uma nota de serviços (NFS-e) for emitida para o mesmo.
#'''Retém PIS/COFINS/CSLL:''' Parâmetro que determina se o cliente retem PIS/COFINS/CSLL quando uma nota de serviços (NFS-e) for emitida para o mesmo.

=== Endereço de cobrança ===
Com os mesmos campos utilizados no endereço principal, o usuário poderá cadastrar um endereço de cobrança para o cliente.


Caso um endereço de cobrança não seja informado, ele será automaticamente preenchido com as informações do endereço principal.

=== Endereço de entrega ===
Com os mesmos campos utilizados no endereço principal, o usuário poderá cadastrar um endereço de entrega para o cliente.


Caso um endereço de entrega não seja informado, ele será automaticamente preenchido com as informações do endereço principal.

== RN03 - Campos livres ==

== RN04 - Ficha cadastral ==
Na aba de ficha cadastral poderão ser informados, opcionalmente, dados adicionais de um determinado cliente. Estes dados adicionais são voltados para análise de crédito ou qualquer outro tipo de análise necessária para cadastrar novos clientes ou vender para clientes já cadastrados, variando de acordo com cada segmento de mercado onde o Resulth WEB é utilizado.

Será possível ter dois tipos de ficha, uma para pessoa física e outra para pessoa jurídica conforme segue abaixo.

=== Pessoa física ===
==== Informações pessoais ====
#'''Data da última alteração:''' Campo somente leitura que exibe a data em que foi salva a última alteração realizada na ficha cadastral.
#'''Usuário da última alteração:''' Usuário do sistema que realizou a última alteração na ficha cadastral.
#'''Informações do avalista:''' Este ''field-set'' irá agrupar dados do avalista do cliente nos seguintes campos:
#*'''Avalista:''' Campo onde poderá ser informada uma pessoa que será avalista do cliente em questão. O avalista pode ser outro cliente já cadastrado, um fornecedor, um vendedor ou uma transportadora.
#*'''Identidade do avalista:''' Campo somente leitura que listará a identidade informada no cadastro da pessoa que é avalista.
#'''Filiação:''' Este ''field set'' irá agrupar informações sobre a filiação do cliente nos seguintes campos:
#*'''Nome do cônjuge:''' Campo onde poderá ser informado o nome do cônjuge do cliente (se houver).
#*'''Nome do pai:''' Campo onde poderá ser informado o nome do pai do cliente.
#*'''Nome da mãe:''' Campo onde poderá ser informado o nome da mãe do cliente.
#'''Estado civil:''' Campo onde poderá ser selecionado o estado civil do cliente com as seguintes opções:
#*Casado(a)
#*Solteiro(a)
#*União estável
#*Viúvo(a)
#'''Informação profissional:''' Este ''field set'' irá agrupar as informações profissionais do cliente nos seguintes campos:
#*'''Empresa:''' Campo onde poderá ser informado o nome da empresa onde o cliente trabalha atualmente.
#*'''Contato na empresa:''' Campo onde poderá ser informado um contato na empresa onde o cliente trabalha atualmente.
#*'''Cargo:''' Campo onde poderá ser informado o cargo ocupado pelo cliente em seu emprego atual.
#*'''Salário:''' Campo onde poderá ser informado o salário atual do cliente na empresa onde ele trabalha.
#'''Renda total:''' Campo onde poderá ser informada a renda total do cliente, contabilizando o seu salário e outros eventuais rendimentos que ele possa ter.
#'''Observação:''' Campo livre onde poderão ser informadas observações sobre a ficha cadastral.
#'''Avaliação:''' Campo livre onde poderão ser inseridas informações pertinentes à avaliação da ficha cadastral.

==== Bancos onde opera ====
Aba onde o usuário poderá adicionar um ou mais bancos onde o cliente da ficha opera através dos seguintes campos e funcionalidades:
#'''Descrição:''' Descrição ou nome do banco.
#'''Banco:''' Código Febraban do banco.
#'''Agência:''' Número da agência (com ou sem dígito).
#'''Conta:''' Número da conta (corrente ou poupança, com dígito).
#'''Telefone:''' Telefone do banco.
#'''Cliente desde:''' Data de abertura da conta.
#'''Botão [Adicionar]:''' Quando acionado, verifica se os campos obrigatórios foram informados e adiciona o registro no grid.
#'''Grid:''' Lista os bancos já adicionados nas seguintes colunas:
#*DESCRIÇÃO
#*BANCO
#*AGÊNCIA
#*CONTA
#*TELEFONE
#*CLIENTE DESDE

==== Referências ====
Aba onde o usuário poderá inserir uma ou mais referências do cliente através dos seguintes campos e funcionalidades:
#'''Tipo de referência:''' Campo onde deverá ser selecionado o tipo de referência com as seguintes opções:
#*Pessoal
#*Comercial
#'''Nome:''' Campo onde poderá ser informado o nome da empresa ou pessoa que será a referência.
#'''Telefone:''' Campo onde poderá ser informado o telefone da referência.
#'''Última compra:''' Visível '''somente''' quando o tipo de referência for '''Comercial''', neste campo poderão ser informados a data e valor total da última compra realizada.
#'''Observação:''' Campo onde poderá ser informada uma observação para a referência.
#'''Botão [Adicionar]:''' Botão que quando acionado insere a referência no grid.
#'''Grid:''' Lista todas as referências já adicionadas nas seguintes colunas:
#*TIPO
#*NOME
#*TELEFONE
#*DATA DA ÚLTIMA COMPRA
#*VALOR DA ÚLTIMA COMPRA

==== Situação no SPC ====
Esta aba ficará em branco até que seja desenvolvido o mecanismo de consulta ao SPC (requisito 2 do chamado 25697).

=== Pessoa jurídica ===
==== Informações ====
#'''Data da última alteração:''' Campo somente leitura que exibe a data em que foi salva a última alteração realizada na ficha cadastral.
#'''Usuário da última alteração:''' Usuário do sistema que realizou a última alteração na ficha cadastral.
#'''Avalista:'''Campo onde poderá ser informada uma pessoa que será avalista do cliente em questão. O avalista pode ser outro cliente já cadastrado, um fornecedor, um vendedor ou uma transportadora.
#'''Registro junta comercial:''' Número de registro de junta comercial, caso exista.
#'''Data da fundação:''' Data de abertura da empresa/CNPJ.
#'''Avaliação:''' Campo livre onde poderão ser inseridas informações pertinentes à avaliação da ficha cadastral.
#'''Limite de crédito:''' Campo que exibirá a mesma informação do campo ''Limite de crédito'' da aba ''Dados gerais'' do cadastro do cliente em questão. Caso o limite de crédito seja alterado na ficha cadastral, esta alteração será aplicada também no respectivo campo da aba ''Dados gerais''.
#'''Saldo utilizado:''' Campo somente leitura que exibe o saldo utilizado atualmente. O saldo utilizado é obtido através da soma dos documentos a receber que se encontram em aberto ou em atraso para o cliente em questão.
#'''Saldo disponível:''' Obtido na subtração do valor do limite pelo saldo utilizado.
#'''Observação:''' Campo livre onde poderão ser informadas observações sobre a ficha cadastral.

==== Bancos onde opera ====
Aba onde o usuário poderá adicionar um ou mais bancos onde o cliente da ficha opera através dos seguintes campos e funcionalidades:
#'''Descrição:''' Descrição ou nome do banco.
#'''Banco:''' Código Febraban do banco.
#'''Agência:''' Número da agência (com ou sem dígito).
#'''Conta:''' Número da conta (corrente ou poupança, com dígito).
#'''Telefone:''' Telefone do banco.
#'''Cliente desde:''' Data de abertura da conta.
#'''Botão [Adicionar]:''' Quando acionado, verifica se os campos obrigatórios foram informados e adiciona o registro no grid.
#'''Grid:''' Lista os bancos já adicionados nas seguintes colunas:
#*DESCRIÇÃO
#*BANCO
#*AGÊNCIA
#*CONTA
#*TELEFONE
#*CLIENTE DESDE

==== Referências comerciais ====
Aba onde o usuário poderá inserir uma ou mais referências comerciais do cliente através dos seguintes campos e funcionalidades:
#'''Tipo de referência:''' Campo onde deverá ser selecionado o tipo de referência com as seguintes opções:
#*Pessoal
#*Comercial
#'''Nome:''' Campo onde poderá ser informado o nome da empresa ou pessoa que será a referência.
#'''Telefone:''' Campo onde poderá ser informado o telefone da referência.
#'''Última compra:''' Visível '''somente''' quando o tipo de referência for '''Comercial''', neste campo poderão ser informados a data e valor total da última compra realizada.
#'''Observação:''' Campo onde poderá ser informada uma observação para a referência.
#'''Botão [Adicionar]:''' Botão que quando acionado insere a referência no grid.
#'''Grid:''' Lista todas as referências já adicionadas nas seguintes colunas:
#*TIPO
#*NOME
#*TELEFONE
#*DATA DA ÚLTIMA COMPRA
#*VALOR DA ÚLTIMA COMPRA

==== Sócios ====
Nesta aba poderão ser incluídos os sócios do cliente é que pessoa jurídica através dos seguintes campos e funcionalidades.
#'''Nome:''' Campo onde deverá ser informado o nome do sócio.
#'''Capital:''' Campo onde poderá ser informado o valor do capital do sócio.
#'''CPF:''' Campo onde poderá ser informado o CPF do sócio.
#'''Identidade:''' Campo onde poderá ser informado o número de identidade do sócio.
#'''Botão [Adicionar]:''' Botão que quando acionado insere o registro no grid.

== RN05 - Contato ==

== RN06 - Dependentes ==

== RN07 - Histórico ==
Esta aba tem como objetivo listar todo o histórico de um determinado cliente no sistema com diversas informações geradas ao longo do tempo separadas e categorizadas conforme as sub-abas abaixo.

=== Aba: ''Dados estatísticos de venda'' ===
Nesta sub-aba serão listadas informações pertinentes as compras realizadas por um determinado cliente conforme segue abaixo.

==== Categorização das compras ====
*'''Primeira compra:''' Primeira venda realizada para o cliente.
*'''Última compra:''' Última venda realizada para o cliente.
*'''Maior compra:''' Dentre todos as vendas feitas para o cliente, lista aquela cujo total é maior que os demais.
*'''Menor compra:''' Dentre todos as vendas feitas para o cliente, lista aquela cujo total é menor que os demais.

Para cada categoria acima estarão disponíveis os seguintes dados:
#'''Nº Pedido:''' Exibe o número da venda, seja ela um pedido, uma nota, um cupom, uma NFC-e ou uma OS.
#'''Tipo pedido:''' Exibe o tipo do pedido cujo número é listado no campo anterior e também um ícone que quando acionado exibe uma pré-visualização do mesmo. Os tipos de pedido existentes são:
#*'''51 - NF de saída'''
#*'''55 - PDV'''
#*'''56 - CUPOM/NFC-e:''' Se for cupom exibe o preview do mesmo, se for NFC-e abre a DANFE da mesma em uma nova aba.
#*'''65 - Ordem de serviço'''
#'''Data:''' Data em que o pedido foi faturado.
#'''Valor:''' Valor total do pedido.

==== Totalização das compras ====
Totalizador chamado '''Totais de compras''' com as seguintes informações:
#'''Quantidade de pedidos:''' Exibe a quantidade total de vendas realizadas para o cliente no sistema.
#'''Total de compras:''' Exibe a soma dos totais de todos os pedidos realizados para o cliente (subtraindo devoluções se existirem).
#'''Total de devoluções:''' Exibe o total de itens ou pedidos comprados e devolvidos pelo cliente.
#'''Valor médio de compra:''' Considerando todas as vendas realizadas para o cliente, exibe o valor médio de compra do mesmo.
#'''Valor médio de compra por mês:''' Considerando todas as vendas realizadas para o cliente, exibe o valor médio de compra do mesmo por mês.

==== Gráfico de compras ====
Exibirá um gráfico de linha com as compras realizadas pelo cliente ao longo do ano conforme modelo abaixo:
<gallery>
File:ModeloGraficoCompras.png | Modelo de gráfico
</gallery>

=== Aba: ''Documentos em aberto'' ===
DADOS DO CONTAS A RECEBER EM ABERTO

* Títulos vencidos e não protestados: quantidade e valor total destes títulos (títulos abertos, com data de vencimento até 'ontem' e que não foram protestados)
* Títulos vencidos e protestados: vencidos, da mesma forma acima, mas, que foram protestados
* Vencendo hoje: quantidade e valor total destes títulos (títulos abertos, com data de vencimento 'hoje')
* A vencer: quantidade e valor total destes títulos (títulos abertos, com data de vencimento 'amanhã' ou posterior)

Totalizar quantidade e valor, de todos os títulos acima. Não se preocupar com juros e multa nesta seção.

DOCUMENTOS PAGOS

* TOTAL GERAL: Quantidade e Total de documentos pagos (quantidade de movimentos de pagamentos e o valor deles)
* ANTECIPADOS: Quantidade e Total de documentos pagos, cuja da do movimento de pagamento seja menor que a data de vencimeto do título
* ATRASADOS, SEM PROTESTO: Quantidade e Total de documentos pagos, cuja da do movimento de pagamento seja maior que a data de vencimento, mas, não estejam atrasados.

* PAGOS APOS PROTESTO: Quantidade e Total de documentos pagos, cuja da do movimento de pagamento seja maior que a data de vencimento, e que estejam protestados.

=== Documentos em aberto ===

=== Documentos recebidos ===

=== Documentos a Receber ===

Criar uma sub-aba, dentro de histórico, que vai trazer as seguintes informações, em ordem crescente de data de vencimento

Os dados são os mesmos da consulta de vencimentos a receber.

* código reduzido da filial
* data da emissão
* data do vencimento
* código do tipo de documento (AV, NF, DP por exemplo)
* código do documento
* valor do documento (seria valor orginal - descontos + acréscimos do documento)
* valor pago (não se preocupar com valor devolvido)
* valor aberto
* juros
* multa
* valor final
* dias de atraso
* situação do documento (aberto, parcialmente pago, protestado)
* banco
* carteira

Exibir o total do valor final.

=== Documentos Recebidos ===

Criar uma sub-aba, dentro de histórico, que vai trazer as seguintes informações, em ordem crescente de data de pagamento:

Os dados são os mesmos da consulta de contas recebidas

* código reduzido da filial
* data da emissão
* data do vencimento
* data da liquidação
* código do tipo de documento (AV, NF, DP por exemplo)
* código do documento
* valor do documento (seria valor orginal - descontos + acréscimos do documento)
* valor pago
* desconto (que foi dado ao liquidar)
* juros (que foi dado ao liquidar)
* multa (que foi dado ao liquidar)

Exibir, ao final, o total do valor pago.

== RN08 - Retenção de imposto na NFS-e ==
Quando o cliente for o '''tomador''' de serviços em uma nota fiscal de serviço é possível que ele retenha alguns impostos. Para isto, serão exibidos na aba '''Dados gerais''' os seguintes parâmetros:
#'''Retem ISS:''' Este parâmetro determina se o cliente em questão retem ISS em notas fiscais de serviço.
#'''Retém PIS/COFINS/CSLL:''' Este parâmetro determina se o cliente em questão retem PIS, COFINS e CSLL em notas fiscais de serviço.


Caso nos parâmetros da filial logada o parâmetro '''Utiliza NFS-e''' esteja marcado como '''Não''', os parâmetros citados acima serão visíveis, mas desmarcados e desabilitados na tela.


O cliente somente irá reter impostos federais caso os valores do mesmo seja maior que o mínimo configurado nos parâmetros de NFS-e da filial.

== Quadro de dados ==
=== Informações adicionais ===
==== Informações adicionais do cliente ====
{|class="wikitable"
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| Classificação || Não || Combobox || Classificações cadastradas no sistema || || Vazio ||
|-
| Tabela de preços || Não || Combobox || Tabelas de preço cadastradas no sistema || || Vazio || Todas as tabelas cadastradas, '''independente da filial'''.
|-style="background-color:#DCDCDC"
| Rota || Não || Combobox || Rotas cadastradas no sistema || || Vazio ||
|-
| Retem ISS || Não || Checkbox || Marcado/Desmarcado || || Desmarcado ||
|-style="background-color:#DCDCDC"
| Retem PIS/COFINS/CSLL || Não || Checkbox || Marcado/Desmarcado || || Desmarcado ||
|-
| Sempre reter IRRF || Não || Checkbox || Marcado/Desmarcado || || Desmarcado ||
|-style="background-color:#DCDCDC"
| Vendedor || Não || Input + Combobox || Vendedores cadastrados || || Vazio ||
|-
| Transportadora || Não || Input + Combobox || Transportadoras cadastradas || || Vazio ||
|-style="background-color:#DCDCDC"
| Conta contábil || Não || Input || Contas contábeis cadastradas || || Vazio || Visível somente para clientes cujo CNPJ possui acesso ao módulo contábil.
|}

==== Endereço de cobrança/entrega ====
{|class="wikitable"
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| CEP || Não || Input || Inteiros || || Vazio ||
|-
| País || Não || Combobox || Países cadastrados || || Brasil ||
|-style="background-color:#DCDCDC"
| UF || Não || Combobox || UF´s cadastradas || 2 || UF da filial logada ||
|-
| Endereço || Não || Combobox + Input || Ver [[#RN02 - Dados gerais | RN02]] || || Rua ||
|-style="background-color:#DCDCDC"
| Nº || Não || Input || Alfanuméricos || 10 || Vazio ||
|-
| Complemento || Não || Input || Alfanuméricos || 20 || Vazio ||
|-style="background-color:#DCDCDC"
| Bairro || Não || Input || Alfanuméricos || 30 || Vazio ||
|-
| Cidade || Não || Input || Cidades cadastradas || || Vazio ||
|-style="background-color:#DCDCDC"
| Observação || Não || Input || Alfanuméricos || Blob || Vazio ||
|}

=== Ficha cadastral ===
==== Pessoa física ====
{|class="wikitable"
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| Data da última alteração || Sim || Input || Data || || Vazio || Campo somente leitura
|-
| Usuário da última alteração || Sim || Input || Alfanuméricos || 60 || || Campo somente leitura
|-style="background-color:#DCDCDC"
| Avalista || Não || Input || Pessoas cadastradas no sistema || || Vazio || Pessoa pode ser um cliente, um vendedor e etc.
|-
| Identidade do avalista || Não || Input || Identidade informada no cadastro do avalista || || Vazio ||
|-style="background-color:#DCDCDC"
| Nome do cônjuge || Não || Input || Alfanuméricos || 60 || Vazio ||
|-
| Nome do pai || Não || Input || Alfanuméricos || 60 || Vazio ||
|-style="background-color:#DCDCDC"
| Nome da mãe || Não || Input || Alfanuméricos || 60 || Vazio ||
|-
| Estado civil || Não || Combobox ||
*Casado(a)
*Solteiro(a)
*União estável
*Viúvo(a)
|| || Vazio ||
|-style="background-color:#DCDCDC"
| Empresa || Não || Input || Alfanuméricos || 60 || Vazio ||
|-
| Contato na empresa || Não || Input || Alfanuméricos || 60 || Vazio ||
|-style="background-color:#DCDCDC"
| Cargo || Não || Input || Alfanuméricos || 60 || Vazio ||
|-
| Salário || Não || Input || Numéricos || Precision=10, scale=2 (00000000,00) || 00,00 ||
|-style="background-color:#DCDCDC"
| Renda total || Não || Input || Numéricos || Precision=12, scale=4 (0000000000,00) || 00,00 ||
|-
| Observação || Não || Input || Blob || || Vazio ||
|-style="background-color:#DCDCDC"
| Avaliação || Não || Input || Alfanuméricos || 255 || Vazio ||
|}

==== Pessoa jurídica ====
{|class="wikitable"
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| Data da última alteração || Sim || Input || Data || || Vazio || Campo somente leitura
|-
| Usuário da última alteração || Sim || Input || Alfanuméricos || 60 || || Campo somente leitura
|-style="background-color:#DCDCDC"
| Avalista || Não || Input || Pessoas cadastradas no sistema || || Vazio || Pessoa pode ser um cliente, um vendedor e etc.
|-
| Registro junta comercial || Não || Input || Alfanuméricos || 20 || Vazio ||
|-
| Avaliação || Não || Input || Alfanuméricos || 255 || Vazio ||
|-style="background-color:#DCDCDC"
| Limite de crédito || Não || Input || Numéricos || || Vazio ||
|-
| Saldo utilizado || Não || Input || Numéricos || || Vazio || Campo somente leitura
|-style="background-color:#DCDCDC"
| Saldo disponível || Não || Input || Limite de crédito - Saldo utilizado || || Vazio || Campo somente leitura calculado
|-
| Observação || Não || Input || Blob || || Vazio ||
|-style="background-color:#DCDCDC"
|}

==== Bancos onde opera ====
{|class="wikitable"
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| Descrição || Sim || Input || Alfanuméricos || 60 || Vazio ||
|-
| Banco || Sim || Input || Alfanuméricos || 30 || Vazio ||
|-style="background-color:#DCDCDC"
| Agência || Sim || Input || Alfanuméricos || 20 || Vazio ||
|-
| Conta || Sim || Input || Alfanuméricos || 20 || Vazio ||
|-style="background-color:#DCDCDC"
| Telefone || Não || Input || Inteiro || || Vazio ||
|-
| Cliente desde || Não || Input || Data || || Vazio ||
|}

==== Referências ====
{|class="wikitable"
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| Tipo de referência || Sim || Combobox ||
*Pessoal
*Comercial
|| || Pessoal ||
|-
| Nome || Sim || Input || Alfanuméricos || 30 || Vazio ||
|-style="background-color:#DCDCDC"
| Telefone || Sim || Input || Inteiros || || Vazio ||
|-
| Última compra || Sim || Input || Data || || Vazio ||
|-style="background-color:#DCDCDC"
| Observação || Não || Input || Blob || || Vazio ||
|}

==== Sócios ====
{|class="wikitable"
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| Nome || Sim || Input || Alfanuméricos || 60 || Vazio ||
|-
| Capital || Sim || Input || Numéricos || Precision=12, scale=4 (0000000000,00 || 00,00 ||
|-style="background-color:#DCDCDC"
| CPF || Sim || Input || Inteiros || 11 || Vazio ||
|-
| Identidade || Sim || Input || Alfanuméricos || 20 || Vazio ||
|-style="background-color:#DCDCDC"
|}

2015-04-24T17:05:14Z

Daniel:

= Objetivo =
*Fazer a consulta de clientes inativos, fornecendo ao usuário informações úteis para reativação do mesmo.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]]
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta clientes inativos'''. Este nome será utilizado para criar a página no Wiki.
*Ter desenvolvido o mecanismo de gravação da data do cadastramento do cliente.

= Resultado esperado =
*Gerar a consulta de clientes inativos, possibilitando gerar os vários formatos de arquivos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina no menu '''''Consulta -> Faturamento -> Clientes inativos'''''.
*Sistema exibe a tela inicial da rotina conforme [[#RN01 - Filtros da consulta | RN01]].

'''Fluxo 2:''' Usuário informa dados para filtragem e aciona o botão '''[Consultar]'''.
*Sistema procede conforme regra de negócio [[#RN03 - Resultados da consulta | RN02]].

= Regras de negócio =
== RN01 - Filtros da consulta ==
#'''Filiais:''' Campo onde o usuário poderá informar uma ou mais filiais cujos pedidos serão considerados na consulta. Se um determinado cliente possuir pedidos realizados '''somente em uma filial que não foi selecionada''', o mesmo será considerado como inativo nas filiais selecionadas.
#'''Clientes que não compraram entre:''' Depois de verificadas as filiais selecionadas, localizar o último pedido de venda do cliente nas mesmas considerando o período informado. Se não houver pedidos, o cliente é considerado inativo. Se houver pedidos, listar o último no grid com resultado da consulta.
#'''Rota do cliente:''' Considera na consulta somente clientes que possuírem informada em seu cadastro a rota informada neste filtro.
#'''Vendedor do cliente:''' Indica o vendedor responsável por aquele cliente (informado na aba "Dados adicionais" do cadastro do mesmo). Algumas empresas tem no cadastrado do cliente o vendedor que o atende. Se for informado este filtro, considerar para analise, apenas os clientes deste vendedor.
#'''Tipo de clientes:'''
#* Ativo, Inativo ou Ambos
#* Não Bloqueado, Bloqueado ou Ambos

== RN03 - Resultados da consulta ==
O resultado da consulta será listado em um grid com as seguintes colunas:
#'''CÓDIGO'''
#'''NOME'''
#'''NOME FANTASIA'''
#'''TP:''' De acordo com o tipo de pessoa informada no cadastro do cliente exibirá:
#*'''F:''' Física
#*'''J:''' Jurídica
#'''ENDEREÇO:''' Endereço completo do cliente.
#'''TELEFONE'''
#'''CELULAR'''
#'''E-MAIL'''
#'''CLASSIFICAÇÃO:''' Exibe a classificação de cliente informada no cadastro do mesmo.
#'''SEGMENTO:''' Exibe o segmento de mercado informado no cadastro do cliente.
#'''DT. RENOVAÇÃO''' (refere-se ao campo "Renovar cadastro em")
#'''DT. ÚLT. COMPRA:''' Data do último pedido de venda realizado para o cliente.
#'''R$ ÚLT. COMPRA:''' Valor total do último pedido realizado para o cliente.
#'''PDV:''' Caso último pedido do cliente listado no grid seja um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''ECF/NFC-e:''' Caso último pedido do cliente listado no grid seja um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso último pedido do cliente listado no grid seja uma nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.


As colunas ''PDV, ECF/NFC-e e NF''' do grid deverão ser implementadas seguindo o padrão das respectivas colunas existentes no grid da '''Consulta de faturamento por pedido'''.

=== Impressão dos dados ===
Por falta de espaço na impressão, alguns campos listados na tela, não serão impressos. Os campos que deverão ser impressos são:
* Cliente
* Tipo de pessoa (física ou jurídica)
* Telefone
* Celular
* E-mail
* Data da ultima compra
* Valor da ultima compra
* Cidade
* Tipo de pedido / Número do pedido

UC00083 - Consulta Clientes Inativos

2015-04-24T17:04:40Z

Daniel: /* Fluxos principais */

UC00083 - Consulta Clientes Inativos

2015-04-24T17:03:55Z

Daniel: /* RN03 - Tela exibição dos dados */

= Objetivo =
*Fazer a consulta de clientes inativos, fornecendo ao usuário informações úteis para reativação do mesmo.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]]
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta clientes inativos'''. Este nome será utilizado para criar a página no Wiki.
*Ter desenvolvido o mecanismo de gravação da data do cadastramento do cliente.

= Resultado esperado =
*Gerar a consulta de clientes inativos, possibilitando gerar os vários formatos de arquivos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina no menu '''Consulta -> Faturamento -> Clientes inativos.
*Sistema exibe a tela inicial da rotina conforme [[#RN01 - Filtros da consulta | RN01]].

'''Fluxo 2:''' Usuário informa dados para filtragem e aciona o botão '''[Consultar]'''.
*Sistema procede conforme regra de negócio [[#RN02 - Filtragem dos Dados da Curva ABC | RN02]], e em seguida, após clicar em <Pesquisa> o sistema exibe os dados conforme [[#RN03 - Tela exibição dos dados| RN03]].

= Regras de negócio =
== RN01 - Filtros da consulta ==
#'''Filiais:''' Campo onde o usuário poderá informar uma ou mais filiais cujos pedidos serão considerados na consulta. Se um determinado cliente possuir pedidos realizados '''somente em uma filial que não foi selecionada''', o mesmo será considerado como inativo nas filiais selecionadas.
#'''Clientes que não compraram entre:''' Depois de verificadas as filiais selecionadas, localizar o último pedido de venda do cliente nas mesmas considerando o período informado. Se não houver pedidos, o cliente é considerado inativo. Se houver pedidos, listar o último no grid com resultado da consulta.
#'''Rota do cliente:''' Considera na consulta somente clientes que possuírem informada em seu cadastro a rota informada neste filtro.
#'''Vendedor do cliente:''' Indica o vendedor responsável por aquele cliente (informado na aba "Dados adicionais" do cadastro do mesmo). Algumas empresas tem no cadastrado do cliente o vendedor que o atende. Se for informado este filtro, considerar para analise, apenas os clientes deste vendedor.
#'''Tipo de clientes:'''
#* Ativo, Inativo ou Ambos
#* Não Bloqueado, Bloqueado ou Ambos

== RN03 - Resultados da consulta ==
O resultado da consulta será listado em um grid com as seguintes colunas:
#'''CÓDIGO'''
#'''NOME'''
#'''NOME FANTASIA'''
#'''TP:''' De acordo com o tipo de pessoa informada no cadastro do cliente exibirá:
#*'''F:''' Física
#*'''J:''' Jurídica
#'''ENDEREÇO:''' Endereço completo do cliente.
#'''TELEFONE'''
#'''CELULAR'''
#'''E-MAIL'''
#'''CLASSIFICAÇÃO:''' Exibe a classificação de cliente informada no cadastro do mesmo.
#'''SEGMENTO:''' Exibe o segmento de mercado informado no cadastro do cliente.
#'''DT. RENOVAÇÃO''' (refere-se ao campo "Renovar cadastro em")
#'''DT. ÚLT. COMPRA:''' Data do último pedido de venda realizado para o cliente.
#'''R$ ÚLT. COMPRA:''' Valor total do último pedido realizado para o cliente.
#'''PDV:''' Caso último pedido do cliente listado no grid seja um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''ECF/NFC-e:''' Caso último pedido do cliente listado no grid seja um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso último pedido do cliente listado no grid seja uma nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.


As colunas ''PDV, ECF/NFC-e e NF''' do grid deverão ser implementadas seguindo o padrão das respectivas colunas existentes no grid da '''Consulta de faturamento por pedido'''.

=== Impressão dos dados ===
Por falta de espaço na impressão, alguns campos listados na tela, não serão impressos. Os campos que deverão ser impressos são:
* Cliente
* Tipo de pessoa (física ou jurídica)
* Telefone
* Celular
* E-mail
* Data da ultima compra
* Valor da ultima compra
* Cidade
* Tipo de pedido / Número do pedido

UC00083 - Consulta Clientes Inativos

2015-04-24T17:03:30Z

Daniel: /* Fluxos principais */

= Objetivo =
*Fazer a consulta de clientes inativos, fornecendo ao usuário informações úteis para reativação do mesmo.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]]
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta clientes inativos'''. Este nome será utilizado para criar a página no Wiki.
*Ter desenvolvido o mecanismo de gravação da data do cadastramento do cliente.

= Resultado esperado =
*Gerar a consulta de clientes inativos, possibilitando gerar os vários formatos de arquivos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina no menu '''Consulta -> Faturamento -> Clientes inativos.
*Sistema exibe a tela inicial da rotina conforme [[#RN01 - Filtros da consulta | RN01]].

'''Fluxo 2:''' Usuário informa dados para filtragem e aciona o botão '''[Consultar]'''.
*Sistema procede conforme regra de negócio [[#RN02 - Filtragem dos Dados da Curva ABC | RN02]], e em seguida, após clicar em <Pesquisa> o sistema exibe os dados conforme [[#RN03 - Tela exibição dos dados| RN03]].

= Regras de negócio =
== RN01 - Filtros da consulta ==
#'''Filiais:''' Campo onde o usuário poderá informar uma ou mais filiais cujos pedidos serão considerados na consulta. Se um determinado cliente possuir pedidos realizados '''somente em uma filial que não foi selecionada''', o mesmo será considerado como inativo nas filiais selecionadas.
#'''Clientes que não compraram entre:''' Depois de verificadas as filiais selecionadas, localizar o último pedido de venda do cliente nas mesmas considerando o período informado. Se não houver pedidos, o cliente é considerado inativo. Se houver pedidos, listar o último no grid com resultado da consulta.
#'''Rota do cliente:''' Considera na consulta somente clientes que possuírem informada em seu cadastro a rota informada neste filtro.
#'''Vendedor do cliente:''' Indica o vendedor responsável por aquele cliente (informado na aba "Dados adicionais" do cadastro do mesmo). Algumas empresas tem no cadastrado do cliente o vendedor que o atende. Se for informado este filtro, considerar para analise, apenas os clientes deste vendedor.
#'''Tipo de clientes:'''
#* Ativo, Inativo ou Ambos
#* Não Bloqueado, Bloqueado ou Ambos

== RN03 - Tela exibição dos dados ==
O resultado da consulta será listado em um grid com as seguintes colunas:
#'''CÓDIGO'''
#'''NOME'''
#'''NOME FANTASIA'''
#'''TP:''' De acordo com o tipo de pessoa informada no cadastro do cliente exibirá:
#*'''F:''' Física
#*'''J:''' Jurídica
#'''ENDEREÇO:''' Endereço completo do cliente.
#'''TELEFONE'''
#'''CELULAR'''
#'''E-MAIL'''
#'''CLASSIFICAÇÃO:''' Exibe a classificação de cliente informada no cadastro do mesmo.
#'''SEGMENTO:''' Exibe o segmento de mercado informado no cadastro do cliente.
#'''DT. RENOVAÇÃO''' (refere-se ao campo "Renovar cadastro em")
#'''DT. ÚLT. COMPRA:''' Data do último pedido de venda realizado para o cliente.
#'''R$ ÚLT. COMPRA:''' Valor total do último pedido realizado para o cliente.
#'''PDV:''' Caso último pedido do cliente listado no grid seja um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''ECF/NFC-e:''' Caso último pedido do cliente listado no grid seja um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso último pedido do cliente listado no grid seja uma nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.


As colunas ''PDV, ECF/NFC-e e NF''' do grid deverão ser implementadas seguindo o padrão das respectivas colunas existentes no grid da '''Consulta de faturamento por pedido'''.

=== Impressão dos dados ===
Por falta de espaço na impressão, alguns campos listados na tela, não serão impressos. Os campos que deverão ser impressos são:
* Cliente
* Tipo de pessoa (física ou jurídica)
* Telefone
* Celular
* E-mail
* Data da ultima compra
* Valor da ultima compra
* Cidade
* Tipo de pedido / Número do pedido

UC00083 - Consulta Clientes Inativos

2015-04-24T17:01:50Z

Daniel: /* Regras de negócio */

= Objetivo =
*Fazer a consulta de clientes inativos, fornecendo ao usuário informações úteis para reativação do mesmo.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]]
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta clientes inativos'''. Este nome será utilizado para criar a página no Wiki.
*Ter desenvolvido o mecanismo de gravação da data do cadastramento do cliente.

= Resultado esperado =
*Gerar a consulta de clientes inativos, possibilitando gerar os vários formatos de arquivos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina no menu '''Consulta -> Faturamento -> Clientes inativos.
*Sistema exibe os campos de filtragem conforme [[#RN01 - Tela inicial de filtragem| RN01]].

'''Fluxo 2:''' Usuário informa dados para filtragem das vendas.
*Sistema procede conforme regra de negócio [[#RN02 - Filtragem dos Dados da Curva ABC | RN02]], e em seguida, após clicar em <Pesquisa> o sistema exibe os dados conforme [[#RN03 - Tela exibição dos dados| RN03]].

= Regras de negócio =
== RN01 - Filtros da consulta ==
#'''Filiais:''' Campo onde o usuário poderá informar uma ou mais filiais cujos pedidos serão considerados na consulta. Se um determinado cliente possuir pedidos realizados '''somente em uma filial que não foi selecionada''', o mesmo será considerado como inativo nas filiais selecionadas.
#'''Clientes que não compraram entre:''' Depois de verificadas as filiais selecionadas, localizar o último pedido de venda do cliente nas mesmas considerando o período informado. Se não houver pedidos, o cliente é considerado inativo. Se houver pedidos, listar o último no grid com resultado da consulta.
#'''Rota do cliente:''' Considera na consulta somente clientes que possuírem informada em seu cadastro a rota informada neste filtro.
#'''Vendedor do cliente:''' Indica o vendedor responsável por aquele cliente (informado na aba "Dados adicionais" do cadastro do mesmo). Algumas empresas tem no cadastrado do cliente o vendedor que o atende. Se for informado este filtro, considerar para analise, apenas os clientes deste vendedor.
#'''Tipo de clientes:'''
#* Ativo, Inativo ou Ambos
#* Não Bloqueado, Bloqueado ou Ambos

== RN03 - Tela exibição dos dados ==
O resultado da consulta será listado em um grid com as seguintes colunas:
#'''CÓDIGO'''
#'''NOME'''
#'''NOME FANTASIA'''
#'''TP:''' De acordo com o tipo de pessoa informada no cadastro do cliente exibirá:
#*'''F:''' Física
#*'''J:''' Jurídica
#'''ENDEREÇO:''' Endereço completo do cliente.
#'''TELEFONE'''
#'''CELULAR'''
#'''E-MAIL'''
#'''CLASSIFICAÇÃO:''' Exibe a classificação de cliente informada no cadastro do mesmo.
#'''SEGMENTO:''' Exibe o segmento de mercado informado no cadastro do cliente.
#'''DT. RENOVAÇÃO''' (refere-se ao campo "Renovar cadastro em")
#'''DT. ÚLT. COMPRA:''' Data do último pedido de venda realizado para o cliente.
#'''R$ ÚLT. COMPRA:''' Valor total do último pedido realizado para o cliente.
#'''PDV:''' Caso último pedido do cliente listado no grid seja um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''ECF/NFC-e:''' Caso último pedido do cliente listado no grid seja um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso último pedido do cliente listado no grid seja uma nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.


As colunas ''PDV, ECF/NFC-e e NF''' do grid deverão ser implementadas seguindo o padrão das respectivas colunas existentes no grid da '''Consulta de faturamento por pedido'''.

=== Impressão dos dados ===
Por falta de espaço na impressão, alguns campos listados na tela, não serão impressos. Os campos que deverão ser impressos são:
* Cliente
* Tipo de pessoa (física ou jurídica)
* Telefone
* Celular
* E-mail
* Data da ultima compra
* Valor da ultima compra
* Cidade
* Tipo de pedido / Número do pedido

UC00087 - Consulta Produtos Inativos

2015-04-22T21:12:19Z

Daniel: /* Fluxos alternativos */

= Objetivo =
*Fazer a consulta de produtos inativos, fornecendo ao usuário informações úteis para gerenciamento do seu mix.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]]
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta produtos inativos'''. Este nome será utilizado para criar a página no Wiki.
*Ter desenvolvido o mecanismo de gravação da data do cadastramento do produto.

= Resultado esperado =
*Gerar a consulta de produtos inativos, possibilitando gerar os vários formatos de arquivos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina no menu '''Consulta -> Faturamento -> Produtos inativos.
*Sistema exibe os campos de filtragem conforme [[#RN01 - Tela inicial de filtragem| RN01]].

'''Fluxo 2:''' Usuário informa dados para filtragem.
*Sistema procede conforme regra de negócio [[#RN02 - Filtragem dos Produtos Inativos | RN02]], e em seguida, após clicar em <Pesquisa> o sistema exibe os dados conforme [[#RN03 - Tela exibição dos dados| RN03]].

== Fluxos alternativos ==
'''Fluxo 1:''' Usuário realiza a consulta em questão informando filtros cujos resultados apresentam produtos que tiveram como último documento de saída um cupom fiscal e/ou uma NFC-e acionando o ícone da coluna '''ECF/NFC-e''' em seguida.
*Conforme regra de negócio [[#RN03 - Tela exibição dos dados| RN03]], se o último documento de saída foi um cupom fiscal quando o ícone em questão for acionado será exibido ao usuário um ''preview'' do cupom. Se o último documento de saída foi uma NFC-e, quando o ícone for acionado a DANFE da mesma será aberta em uma nova aba.

= Regras de negócio =
== RN01 - Tela inicial de filtragem ==
#'''Filiais:''' Usar componente padrão do sistema.
#'''Produtos não movimentados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Produtos cadastrados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Grupo:''' Campo presente na guia inicial do produto.
#'''Sub-grupo:''' Campo presente na guia inicial do produto.
#'''Família:''' Campo presente na guia inicial do produto.
#'''Marca:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fabricante:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fornecedor Principal:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Tipo de produtos:'''
#* Ativo, Inativo ou Ambos
#* Não Bloqueado, Bloqueado ou Ambos
#'''Apenas Movimentos de Venda ?'''
#''' Apenas produtos com Estoque ?'''

== RN02 - Filtragem dos Produtos Inativos ==
O sistema procurará por movimentos de estoque, os itens que forem considerados válidos na filtragem. Neste contexto, desconsiderar itens que são serviços.

* Filais: se marcado alguma, considerar os movimentos apenas destas. Ou seja: pode até ter havido um movimento de estoque em uma filial, mas, se a mesma não estiver sendo considerada, e este for o único pedido, o produto esta inativo.
* Produtos não movimentados entre: verificar se entre o período informado, não houve nenhum movimento de estoque para o produto. Caso afirmativo, o item entrará na consulta.
* Produtos cadastrados entre: verificar se os itens foram cadastrados dentro deste período. Caso negativo, ignorar.
* Grupo: Filtragem padrão, caso campo seja informado.
* Sub-grupo: Filtragem padrão, caso campo seja informado.
* Família: Filtragem padrão, caso campo seja informado.
* Marca: Filtragem padrão, caso campo seja informado.
* Fabricante: Filtragem padrão, caso campo seja informado.
* Fornecedor Principal: Filtragem padrão, caso campo seja informado. Não considerar fornecedores secundários.
* Tipo de produtos: verificar os ativos e bloqueados de acordo com os campos presente na guia principal do cadastro de itens.
* Apenas Movimentos de Venda ?: se o usuário marcas esta opção, mesmo observando o movimento de estoque, considerar apenas os que são referente a venda, que seriam os movimentos 51, 55 e 56 (MovimentoEstoque.tipomovestoque).
* Apenas produtos com Estoque: se marcado, o produto deve ter estoque em pelo menos uma filial, para ser considerado no relatório.

== RN03 - Tela exibição dos dados ==
Após realizar a filtragem, o sistema deverá listar os resultados em um grid com as as seguintes colunas:
#'''PRODUTO:''' Código do produto.
#'''DESCRIÇÃO:''' Descrição do produto.
#'''DATA ÚLT. ENTRADA:''' Exibe a data do último movimento de entrada realizado para o produto.
#'''TIPO DE ENTRADA:''' Exibe o tipo de movimento de entrada cuja data é informada na coluna anterior. Os possíveis tipos de movimento de entrada serão:
#*Entrada via NF
#*Entrada via inventário/acerto
#*Início de estoque
#*Entradas/Saídas
#*Entrada via documento próprio
#*Entrada via troca
#*Entrada via transferência
#'''DATA ÚLT. SAÍDA:''' Exibe a data do último movimento de saída realizado para o produto.
#'''Nº DOC. SAÍDA:''' Exibirá o número do último documento de saída para o produto cuja data é listada na coluna anterior. O último documento de saída será exibido independente se houve devolução para o mesmo.
#'''PDV:''' Caso o último documento de saída do produto seja um PDV, será exibido nesta coluna um ícone que quando acionado exibirá ao usuário um ''preview'' do pedido.
#'''ECF/NFC-e:''' Caso o último documento de saída do produto seja um cupom fiscal ou uma NFC-e, será exibido nesta coluna um ícone que quando acionado procederá conforme segue abaixo:
#*Se o último documento de saída for um cupom fiscal, será exibido um ícone que quando acionado exibirá ao usuário um ''preview'' do cupom.
#*Se o último documento de saída for uma NFC-e, será exibido um ícone que quando acionado abrirá em uma nova aba o link de acesso à DANFE da NFC-e.
#'''PREÇO DE CUSTO:''' Exibe o preço de custo do produto na filial logada.

#'''ESTOQUE:''' Exibir a soma do estoque de todas as filiais marcadas na filtragem.
#'''VALOR DO ESTOQUE:''' Custo * soma do estoque acima.

UC00087 - Consulta Produtos Inativos

2015-04-22T21:09:28Z

Daniel: /* Fluxos alternativos */

= Objetivo =
*Fazer a consulta de produtos inativos, fornecendo ao usuário informações úteis para gerenciamento do seu mix.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]]
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta produtos inativos'''. Este nome será utilizado para criar a página no Wiki.
*Ter desenvolvido o mecanismo de gravação da data do cadastramento do produto.

= Resultado esperado =
*Gerar a consulta de produtos inativos, possibilitando gerar os vários formatos de arquivos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina no menu '''Consulta -> Faturamento -> Produtos inativos.
*Sistema exibe os campos de filtragem conforme [[#RN01 - Tela inicial de filtragem| RN01]].

'''Fluxo 2:''' Usuário informa dados para filtragem.
*Sistema procede conforme regra de negócio [[#RN02 - Filtragem dos Produtos Inativos | RN02]], e em seguida, após clicar em <Pesquisa> o sistema exibe os dados conforme [[#RN03 - Tela exibição dos dados| RN03]].

== Fluxos alternativos ==
'''Fluxo 1:''' Usuário realiza a consulta em questão informando filtros cujos resultados apresentam produtos que tiveram como último movimento
[[#RN03 - Tela exibição dos dados| RN03]]

= Regras de negócio =
== RN01 - Tela inicial de filtragem ==
#'''Filiais:''' Usar componente padrão do sistema.
#'''Produtos não movimentados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Produtos cadastrados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Grupo:''' Campo presente na guia inicial do produto.
#'''Sub-grupo:''' Campo presente na guia inicial do produto.
#'''Família:''' Campo presente na guia inicial do produto.
#'''Marca:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fabricante:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fornecedor Principal:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Tipo de produtos:'''
#* Ativo, Inativo ou Ambos
#* Não Bloqueado, Bloqueado ou Ambos
#'''Apenas Movimentos de Venda ?'''
#''' Apenas produtos com Estoque ?'''

== RN02 - Filtragem dos Produtos Inativos ==
O sistema procurará por movimentos de estoque, os itens que forem considerados válidos na filtragem. Neste contexto, desconsiderar itens que são serviços.

* Filais: se marcado alguma, considerar os movimentos apenas destas. Ou seja: pode até ter havido um movimento de estoque em uma filial, mas, se a mesma não estiver sendo considerada, e este for o único pedido, o produto esta inativo.
* Produtos não movimentados entre: verificar se entre o período informado, não houve nenhum movimento de estoque para o produto. Caso afirmativo, o item entrará na consulta.
* Produtos cadastrados entre: verificar se os itens foram cadastrados dentro deste período. Caso negativo, ignorar.
* Grupo: Filtragem padrão, caso campo seja informado.
* Sub-grupo: Filtragem padrão, caso campo seja informado.
* Família: Filtragem padrão, caso campo seja informado.
* Marca: Filtragem padrão, caso campo seja informado.
* Fabricante: Filtragem padrão, caso campo seja informado.
* Fornecedor Principal: Filtragem padrão, caso campo seja informado. Não considerar fornecedores secundários.
* Tipo de produtos: verificar os ativos e bloqueados de acordo com os campos presente na guia principal do cadastro de itens.
* Apenas Movimentos de Venda ?: se o usuário marcas esta opção, mesmo observando o movimento de estoque, considerar apenas os que são referente a venda, que seriam os movimentos 51, 55 e 56 (MovimentoEstoque.tipomovestoque).
* Apenas produtos com Estoque: se marcado, o produto deve ter estoque em pelo menos uma filial, para ser considerado no relatório.

== RN03 - Tela exibição dos dados ==
Após realizar a filtragem, o sistema deverá listar os resultados em um grid com as as seguintes colunas:
#'''PRODUTO:''' Código do produto.
#'''DESCRIÇÃO:''' Descrição do produto.
#'''DATA ÚLT. ENTRADA:''' Exibe a data do último movimento de entrada realizado para o produto.
#'''TIPO DE ENTRADA:''' Exibe o tipo de movimento de entrada cuja data é informada na coluna anterior. Os possíveis tipos de movimento de entrada serão:
#*Entrada via NF
#*Entrada via inventário/acerto
#*Início de estoque
#*Entradas/Saídas
#*Entrada via documento próprio
#*Entrada via troca
#*Entrada via transferência
#'''DATA ÚLT. SAÍDA:''' Exibe a data do último movimento de saída realizado para o produto.
#'''Nº DOC. SAÍDA:''' Exibirá o número do último documento de saída para o produto cuja data é listada na coluna anterior. O último documento de saída será exibido independente se houve devolução para o mesmo.
#'''PDV:''' Caso o último documento de saída do produto seja um PDV, será exibido nesta coluna um ícone que quando acionado exibirá ao usuário um ''preview'' do pedido.
#'''ECF/NFC-e:''' Caso o último documento de saída do produto seja um cupom fiscal ou uma NFC-e, será exibido nesta coluna um ícone que quando acionado procederá conforme segue abaixo:
#*Se o último documento de saída for um cupom fiscal, será exibido um ícone que quando acionado exibirá ao usuário um ''preview'' do cupom.
#*Se o último documento de saída for uma NFC-e, será exibido um ícone que quando acionado abrirá em uma nova aba o link de acesso à DANFE da NFC-e.
#'''PREÇO DE CUSTO:''' Exibe o preço de custo do produto na filial logada.

#'''ESTOQUE:''' Exibir a soma do estoque de todas as filiais marcadas na filtragem.
#'''VALOR DO ESTOQUE:''' Custo * soma do estoque acima.

UC00087 - Consulta Produtos Inativos

2015-04-22T21:07:48Z

Daniel: /* Fluxo de eventos */

= Objetivo =
*Fazer a consulta de produtos inativos, fornecendo ao usuário informações úteis para gerenciamento do seu mix.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]]
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta produtos inativos'''. Este nome será utilizado para criar a página no Wiki.
*Ter desenvolvido o mecanismo de gravação da data do cadastramento do produto.

= Resultado esperado =
*Gerar a consulta de produtos inativos, possibilitando gerar os vários formatos de arquivos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina no menu '''Consulta -> Faturamento -> Produtos inativos.
*Sistema exibe os campos de filtragem conforme [[#RN01 - Tela inicial de filtragem| RN01]].

'''Fluxo 2:''' Usuário informa dados para filtragem.
*Sistema procede conforme regra de negócio [[#RN02 - Filtragem dos Produtos Inativos | RN02]], e em seguida, após clicar em <Pesquisa> o sistema exibe os dados conforme [[#RN03 - Tela exibição dos dados| RN03]].

== Fluxos alternativos ==
'''Fluxo 1:'''

= Regras de negócio =
== RN01 - Tela inicial de filtragem ==
#'''Filiais:''' Usar componente padrão do sistema.
#'''Produtos não movimentados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Produtos cadastrados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Grupo:''' Campo presente na guia inicial do produto.
#'''Sub-grupo:''' Campo presente na guia inicial do produto.
#'''Família:''' Campo presente na guia inicial do produto.
#'''Marca:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fabricante:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fornecedor Principal:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Tipo de produtos:'''
#* Ativo, Inativo ou Ambos
#* Não Bloqueado, Bloqueado ou Ambos
#'''Apenas Movimentos de Venda ?'''
#''' Apenas produtos com Estoque ?'''

== RN02 - Filtragem dos Produtos Inativos ==
O sistema procurará por movimentos de estoque, os itens que forem considerados válidos na filtragem. Neste contexto, desconsiderar itens que são serviços.

* Filais: se marcado alguma, considerar os movimentos apenas destas. Ou seja: pode até ter havido um movimento de estoque em uma filial, mas, se a mesma não estiver sendo considerada, e este for o único pedido, o produto esta inativo.
* Produtos não movimentados entre: verificar se entre o período informado, não houve nenhum movimento de estoque para o produto. Caso afirmativo, o item entrará na consulta.
* Produtos cadastrados entre: verificar se os itens foram cadastrados dentro deste período. Caso negativo, ignorar.
* Grupo: Filtragem padrão, caso campo seja informado.
* Sub-grupo: Filtragem padrão, caso campo seja informado.
* Família: Filtragem padrão, caso campo seja informado.
* Marca: Filtragem padrão, caso campo seja informado.
* Fabricante: Filtragem padrão, caso campo seja informado.
* Fornecedor Principal: Filtragem padrão, caso campo seja informado. Não considerar fornecedores secundários.
* Tipo de produtos: verificar os ativos e bloqueados de acordo com os campos presente na guia principal do cadastro de itens.
* Apenas Movimentos de Venda ?: se o usuário marcas esta opção, mesmo observando o movimento de estoque, considerar apenas os que são referente a venda, que seriam os movimentos 51, 55 e 56 (MovimentoEstoque.tipomovestoque).
* Apenas produtos com Estoque: se marcado, o produto deve ter estoque em pelo menos uma filial, para ser considerado no relatório.

== RN03 - Tela exibição dos dados ==
Após realizar a filtragem, o sistema deverá listar os resultados em um grid com as as seguintes colunas:
#'''PRODUTO:''' Código do produto.
#'''DESCRIÇÃO:''' Descrição do produto.
#'''DATA ÚLT. ENTRADA:''' Exibe a data do último movimento de entrada realizado para o produto.
#'''TIPO DE ENTRADA:''' Exibe o tipo de movimento de entrada cuja data é informada na coluna anterior. Os possíveis tipos de movimento de entrada serão:
#*Entrada via NF
#*Entrada via inventário/acerto
#*Início de estoque
#*Entradas/Saídas
#*Entrada via documento próprio
#*Entrada via troca
#*Entrada via transferência
#'''DATA ÚLT. SAÍDA:''' Exibe a data do último movimento de saída realizado para o produto.
#'''Nº DOC. SAÍDA:''' Exibirá o número do último documento de saída para o produto cuja data é listada na coluna anterior. O último documento de saída será exibido independente se houve devolução para o mesmo.
#'''PDV:''' Caso o último documento de saída do produto seja um PDV, será exibido nesta coluna um ícone que quando acionado exibirá ao usuário um ''preview'' do pedido.
#'''ECF/NFC-e:''' Caso o último documento de saída do produto seja um cupom fiscal ou uma NFC-e, será exibido nesta coluna um ícone que quando acionado procederá conforme segue abaixo:
#*Se o último documento de saída for um cupom fiscal, será exibido um ícone que quando acionado exibirá ao usuário um ''preview'' do cupom.
#*Se o último documento de saída for uma NFC-e, será exibido um ícone que quando acionado abrirá em uma nova aba o link de acesso à DANFE da NFC-e.
#'''PREÇO DE CUSTO:''' Exibe o preço de custo do produto na filial logada.

#'''ESTOQUE:''' Exibir a soma do estoque de todas as filiais marcadas na filtragem.
#'''VALOR DO ESTOQUE:''' Custo * soma do estoque acima.

UC00087 - Consulta Produtos Inativos

2015-04-22T21:05:19Z

Daniel: /* Regras de negócio */

= Objetivo =
*Fazer a consulta de produtos inativos, fornecendo ao usuário informações úteis para gerenciamento do seu mix.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]]
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta produtos inativos'''. Este nome será utilizado para criar a página no Wiki.
*Ter desenvolvido o mecanismo de gravação da data do cadastramento do produto.

= Resultado esperado =
*Gerar a consulta de produtos inativos, possibilitando gerar os vários formatos de arquivos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina no menu '''Consulta -> Faturamento -> Produtos inativos.
*Sistema exibe os campos de filtragem conforme [[#RN01 - Tela inicial de filtragem| RN01]].

'''Fluxo 2:''' Usuário informa dados para filtragem.

*Sistema procede conforme regra de negócio [[#RN02 - Filtragem dos Produtos Inativos | RN02]], e em seguida, após clicar em <Pesquisa> o sistema exibe os dados conforme [[#RN03 - Tela exibição dos dados| RN03]].

= Regras de negócio =
== RN01 - Tela inicial de filtragem ==
#'''Filiais:''' Usar componente padrão do sistema.
#'''Produtos não movimentados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Produtos cadastrados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Grupo:''' Campo presente na guia inicial do produto.
#'''Sub-grupo:''' Campo presente na guia inicial do produto.
#'''Família:''' Campo presente na guia inicial do produto.
#'''Marca:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fabricante:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fornecedor Principal:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Tipo de produtos:'''
#* Ativo, Inativo ou Ambos
#* Não Bloqueado, Bloqueado ou Ambos
#'''Apenas Movimentos de Venda ?'''
#''' Apenas produtos com Estoque ?'''

== RN02 - Filtragem dos Produtos Inativos ==
O sistema procurará por movimentos de estoque, os itens que forem considerados válidos na filtragem. Neste contexto, desconsiderar itens que são serviços.

* Filais: se marcado alguma, considerar os movimentos apenas destas. Ou seja: pode até ter havido um movimento de estoque em uma filial, mas, se a mesma não estiver sendo considerada, e este for o único pedido, o produto esta inativo.
* Produtos não movimentados entre: verificar se entre o período informado, não houve nenhum movimento de estoque para o produto. Caso afirmativo, o item entrará na consulta.
* Produtos cadastrados entre: verificar se os itens foram cadastrados dentro deste período. Caso negativo, ignorar.
* Grupo: Filtragem padrão, caso campo seja informado.
* Sub-grupo: Filtragem padrão, caso campo seja informado.
* Família: Filtragem padrão, caso campo seja informado.
* Marca: Filtragem padrão, caso campo seja informado.
* Fabricante: Filtragem padrão, caso campo seja informado.
* Fornecedor Principal: Filtragem padrão, caso campo seja informado. Não considerar fornecedores secundários.
* Tipo de produtos: verificar os ativos e bloqueados de acordo com os campos presente na guia principal do cadastro de itens.
* Apenas Movimentos de Venda ?: se o usuário marcas esta opção, mesmo observando o movimento de estoque, considerar apenas os que são referente a venda, que seriam os movimentos 51, 55 e 56 (MovimentoEstoque.tipomovestoque).
* Apenas produtos com Estoque: se marcado, o produto deve ter estoque em pelo menos uma filial, para ser considerado no relatório.

== RN03 - Tela exibição dos dados ==
Após realizar a filtragem, o sistema deverá listar os resultados em um grid com as as seguintes colunas:
#'''PRODUTO:''' Código do produto.
#'''DESCRIÇÃO:''' Descrição do produto.
#'''DATA ÚLT. ENTRADA:''' Exibe a data do último movimento de entrada realizado para o produto.
#'''TIPO DE ENTRADA:''' Exibe o tipo de movimento de entrada cuja data é informada na coluna anterior. Os possíveis tipos de movimento de entrada serão:
#*Entrada via NF
#*Entrada via inventário/acerto
#*Início de estoque
#*Entradas/Saídas
#*Entrada via documento próprio
#*Entrada via troca
#*Entrada via transferência
#'''DATA ÚLT. SAÍDA:''' Exibe a data do último movimento de saída realizado para o produto.
#'''Nº DOC. SAÍDA:''' Exibirá o número do último documento de saída para o produto cuja data é listada na coluna anterior. O último documento de saída será exibido independente se houve devolução para o mesmo.
#'''PDV:''' Caso o último documento de saída do produto seja um PDV, será exibido nesta coluna um ícone que quando acionado exibirá ao usuário um ''preview'' do pedido.
#'''ECF/NFC-e:''' Caso o último documento de saída do produto seja um cupom fiscal ou uma NFC-e, será exibido nesta coluna um ícone que quando acionado procederá conforme segue abaixo:
#*Se o último documento de saída for um cupom fiscal, será exibido um ícone que quando acionado exibirá ao usuário um ''preview'' do cupom.
#*Se o último documento de saída for uma NFC-e, será exibido um ícone que quando acionado abrirá em uma nova aba o link de acesso à DANFE da NFC-e.
#'''PREÇO DE CUSTO:''' Exibe o preço de custo do produto na filial logada.

#'''ESTOQUE:''' Exibir a soma do estoque de todas as filiais marcadas na filtragem.
#'''VALOR DO ESTOQUE:''' Custo * soma do estoque acima.

UC00099 - Integração Java/ECF

2015-04-22T21:02:12Z

Daniel: /* Itens da NFC-e */

= Objetivo =

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =

= Diagrama de classes =
[[File:ECF.png|400px]]

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:'''

== Fluxos alternativos ==
'''Fluxo 1:''' Com os [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros de ECF da filial logada]] configurados como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', o usuário faz um pedido no Resulth WEB que contem produtos e serviços e em seguida tenta importa-lo no ECF.
*O ECF importará o pedido normalmente, mas '''considerará somente os produtos''' do mesmo. Enquanto '''OPERAÇÃO DO PAF = NFC-e''' os '''serviços serão desprezados''' na importação de pedidos.

'''Fluxo 2:''' Usuário acessa no Resulth WEB o cadastro de operações de saída e entra em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando '''somente''' o estado do parâmetro '''Gera contabilidade''' e acionando o botão '''[Salvar]''' em seguida.
*Desde que tenha sido alterado '''somente''' o estado do parâmetro '''Gera contabilidade''' na aba '''Movimentos''', o sistema irá atualizar o cadastro da operação em questão.

== Fluxos de exceção ==
'''Fluxo 1:''' Usuário inicializa o módulo ECF, sendo que ele possui em uma determinada filial dois ou mais ECF´s cujas configurações estão diferentes uma da outra.
*Se nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] as configurações de todos os ECF´s/PDV´s não forem '''exatamente iguais para a filial logada''', será emitida ao usuário a seguinte mensagem de alerta: ''Para a filial XXX - XXXXXX existem um ou mais ECF´s cujas configurações diferem dos demais. É altamente recomendado que todos os ECF´s utilizem a mesma configuração.'' Onde X corresponde ao código e nome da filial.
*A mensagem será apenas um alerta e não impedirá o usuário de prosseguir com seu fluxo.

'''Fluxo 2:''' No Resulth WEB o usuário acessa o cadastro de operação de saída entrando em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando configurações que sejam '''diferentes''' do parâmetro '''Gera contabilidade''' acionando o botão '''[Salvar]''' em seguida.
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido alterar as configurações desta operação, pois suas configurações são definidas por padrão no sistema e a mesma é utilizada na sincronização de dados com o módulo ECF.''

'''Fluxo 3:''' No Resulth WEB o usuário acessa o cadastro de operação de saída e tenta excluir uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]].
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido excluir esta operação, pois a mesma é utilizada na sincronização de dados com o módulo ECF.''

= Regras de negócio =
== RN01 - Operações ==
=== VENDA DIRETA NO ECF ===
Operação padrão do sistema para vendas realizadas diretamente no ECF que serão sincronizadas/enviadas para o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Sim''
#Considera em comissão = ''Sim''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Sim'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA NO ECF IMPORTANDO PDV ===
Operação padrão do sistema para vendas no ECF através da importação de PDV ('''não será utilizada na importação de DAV''') que serão sincronizadas com o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA DIRETA NO ECF OU IMPORTAÇÃO DE PEDIDO PARA EMISSÃO DE NFC-e ===
Tanto vendas diretas no ECF quanto importação de PDV´s que resultem na emissão de NFC-e, na sincronização com o Resulth WEB será gerado um documento fiscal de saída e para este deverá ser utilizada uma operação com as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Não'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera SPED Contribuições = '''Sim'''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''


Para pedidos do tipo OS não será necessário ter uma operação padrão definida uma vez que as movimentações de estoque e geração do financeiro '''já foram realizados'''.
Em outras palavras, o cupom gerado para um pedido de OS '''não''' movimentará estoque nem gerará financeiro.


Pedidos do tipo DAV não podem movimentar estoque e nem gerar financeiro. Sendo assim, quando importados no ECF, as movimentações serão geradas quando o cupom for
sincronizado com o Resulth WEB a exemplo de como ocorre com a venda direta no ECF.


Operações padrão para integração com o ECF '''não''' podem ser alteradas ou excluídas pelo usuário.

== RN02 - Sincronização ==
=== PDV´s importados para o ECF ===
Ao importar PDV´s para o ECF as seguintes regras devem ser observadas:
#'''PDV´s que já movimentaram estoque:''' Estes pedidos serão listados no ECF junto com os demais pedidos que ainda não movimentaram estoque, porém não poderão ser importados para emissão do cupom. Caso usuário informe diretamente o código ou selecione na filtragem um PDV que já movimentou estoque, o ECF abortará a importação do mesmo e emitirá ao usuário a seguinte mensagem de alerta: ''A emissão de cupom fiscal a partir da importação de um PDV é configurada por padrão para movimentar estoque e portanto o pedido selecionado não poderá ser importado, uma vez que ele já movimentou estoque de seus itens.''
#'''Formas de pagamento:''' As formas de pagamento utilizadas no encerramento do cupom deverão ser compatíveis com as formas de pagamento do PDV importado. Para isto, quando um PDV for importado para o ECF, o sistema (ECF) deverá '''desabilitar''' todas as formas de pagamento e preencher automaticamente os valores de cada uma conforme as formas de pagamento utilizadas no PDV.
#*Se o ECF estiver configurado para '''não''' importar serviço e um determinado PDV '''conter''' serviço(s), para esta importação em específico as regras acima deverão ser desconsideradas.
#*Caso no PDV tenha sido utilizada a forma de pagamento ''financeira'', ao preencher automaticamente as formas de pagamento no encerramento do cupom o sistema considerará o total financiado como '''dinheiro'''.

Os cupons dos PDV´s importados para o ECF serão enviados para o Resulth WEB, e neste ponto será gerado o movimento de estoque dos itens de cada cupom utilizando a operação '''VENDA NO ECF IMPORTANDO PDV''' conforme regra de negócio [[#RN01 - Operações | RN01]].

=== Vendas diretas e DAV´s importados ===
Os cupons dos DAV´s importados e das vendas feitas diretamente no ECF serão enviados para o Resulth WEB, e neste ponto serão gerados os movimentos de estoque dos itens e também o financeiro de acordo com as formas de pagamento informadas em cada cupom utilizando a operação '''VENDA DIRETA NO ECF''' conforme regra de negócio [[#RN01 - Operações | RN01]].

Antes de gerar o financeiro para os cupons sincronizados, o sistema deverá verificar nos parâmetros do PDV:
#'''Gerar movimento de caixa para as vendas?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa informado para centralizar vendas do PDV (logo à direita do parâmetro em questão) serão gerados movimentos de caixa para cada cupom com o subcaixa informado.
#'''Utiliza fechamento de caixa?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa do operador que emitiu os cupons serão gerados movimentos de caixa.
#Independente se '''Gerar movimento de caixa para as vendas? = Sim''' ou '''Utiliza fechamento de caixa? = Sim''', ao gerar movimento de caixa será considerado:
#*Se a opção '''Para todas as vendas''' estiver marcada como '''Sim''', na conta caixa informada logo à sua direita será gerado o movimento de caixa com o valor total de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons.
#*Caso uma ou mais formas de pagamento esteja(m) marcada(s) como '''Sim''', na(s) conta(s) caixa informada(s) será(ão) gerado(s) movimento(s) de caixa com o(s) valor(es) da(s) respectiva(s) forma(s) de pagamento de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons. Se houver em um determinado cupom um forma de pagamento que está marcada nos parâmetros do PDV como '''Não''' e que não possui uma conta caixa informada, '''não será gerado movimento de caixa''' com o valor da mesma.

=== NFC-e ===
A sincronização entenderá que os procedimentos de NFC-e deverão ser realizados quando nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada, para o número de um determinado PDV/ECF, estiverem marcados os parâmetros '''OPERAÇÃO DO PAF = NFC-e''' e '''AMBIENTE NFC-e = Produção'''.

Uma vez que o sistema identificou que ao invés de cupom fiscal será sincronizada a NFC-e, o procedimento será o seguinte:
#Quando o ECF consumir o ''webservice'' de sincronização ao invés de popular o objeto '''DadosCupomDelphi''' com os dados do cupom a partir das tabelas VENDPDV e ENCERRA, ele deverá popular o objeto '''DadosNFCeDelphi''' com os dados do pedido da NFC-e (tabelas PEDIDOC e PEDIDOI), com os dados fiscais da mesma (tabelas NFSAIDI e NFSAIDC) e também com os dados eletrônicos complementares (tabela COMPLNFCE).
#Com o objeto '''DadosNFCeDelphi''' populado, será utilizada a classe '''MontaCupomFiscalImportacaoServiceImpl''' para preparar um objeto do tipo '''CupomFiscal''' e persisti-lo no banco de dados '''gravando no Resulth WEB o pedido da NFC-e exatamente na mesma estrutura onde é gravado o cupom fiscal'''.
#*O pedido da NFC-e deverá ser gravado no Resulth WEB com o mesmo código gerado pelo Delphi na tabela PEDIDOC.
#*Para NFC-e no atributo '''tipoCupom''' da classe '''CupomFiscal''' deverá ser informada a opção '''NFC-E'''. Este atributo foi criado para diferenciar o pedido da NFC-e do pedido do Cupom Fiscal e deverá ser criado com o valor padrão '''CUPOM_FISCAL''' para registros já existentes no banco de dados dos clientes.
#Em seguida deverá ser gerado um documento fiscal de saída para o pedido da NFC-e que fora gravado. Para isto poderá ser utilizada a classe '''PedidoNotaServiceImpl'''.
#Para preencher o documento fiscal o Resulth WEB '''não calculará nenhum imposto'''. Estes serão preenchidos a partir do XML da NFC-e que será sincronizado também. ''Para isto pode ser reaproveitado um recurso existente na importação de XML da nota de entrada, que preenche um objeto a partir de um arquivo XML que tenha a mesma estrutura da NF-e''.

== RN03 - Integração com controle de caixa/checkouts ==
Para vendas serem consideradas pelo controle de caixa, independente de sua origem, deverão ser observados:
*Caso de uso [[UC00066 - Abertura de caixa]].
*Caso de uso [[UC00067 - Controle de caixa]].
*Regra de negócio RN03 do caso de uso [[UC00064 - Parâmetros do PDV#Movimentação de caixa | UC00064 - Parâmetros do PDV]].
*Caso de uso [[UC00072 - Ponto de venda]].

=== Importação de PDV e OS para o ECF ===
Pedidos do tipo '''55''' e '''65''' importados para o ECF serão considerados pela rotina de controle de caixa '''descartando''' a existência do cupom fiscal uma vez que a geração do financeiro só pode ser realizada pelo PDV. Em outras palavras, OS´s e PDV´s serão considerados pelo controle de caixa normalmente (se o PDV for configurado para tal) independente deles terem sido importados para o ECF ou não.


Se o PDV gera financeiro, movimento no subcaixa do operador que possui caixa aberto será gerado pelo Resulth WEB.

=== Importação de DAV e venda direta no ECF ===
Partindo do pré-suposto que o DAV '''não''' movimenta estoque nem gera financeiro, após importado para o ECF o mesmo será tratado como uma venda direta ao sincronizar seu cupom com o Resulth WEB. Para vendas diretas no ECF o movimento de estoque e a geração do financeiro serão realizados quando os respectivos cupons forem sincronizados com o Resulth WEB.

Antes de cada venda direta ou a importação de um DAV, o sistema (ECF) deverá:
#'''Verificar se o retaguarda (Resulth WEB) utiliza fechamento de caixa:''' Na aba ''Faturamento'' dos parâmetros do PDV deverá ser verificado o estado do parâmetro '''Utiliza fechamento de caixa?'''. Se o parâmetro em questão estiver como '''Não''', os demais passos deverão ser ignorados e a venda direta ou importação do DAV procederá normalmente. Se o parâmetro estiver como '''Sim''', executar os próximos passos.
#'''Verificar se o caixa do operador foi/está aberto:''' Para que um determinado operador consiga vender ou importar DAV no ECF é necessário que seu caixa esteja aberto no retaguarda (Resulth WEB). Caso o caixa do operador não esteja aberto o sistema (ECF) deverá abortar a venda ou importação do DAV e emitir ao usuário uma mensagem de alerta com a não conformidade.
#*Caso '''não exista''' no retaguarda caixa aberto para o usuário/operador logado no ECF, exibir a mensagem: ''O sistema de retaguarda (Resulth WEB) está configurado para utilizar fechamento de caixa e não ha caixa aberto para o operador logado. Faça a abertura do caixa do operador em questão e tente novamente.''
#*Caso o caixa do usuário/operador já tenha sido '''fechado''', exibir a mensagem: ''O caixa do operador logado já foi fechado e portanto o mesmo não poderá realizar vendas.''

== RN04 - NFC-e ==
Em resumo a NFC-e será tratada/sincronizada como um cupom fiscal no Resulth WEB, ou seja, os dados de um pedido de NFC-e serão visualizados e considerados da mesma maneira que um pedido de cupom fiscal. O que irá diferenciar um pedido de cupom fiscal de um pedido de NFC-e no Resulth WEB será a existência de um documento fiscal (a NFC-e propriamente dita), que será criado para todas as NFC-e´s sincronizadas para o Resulth WEB e considerado também em rotinas fiscais como SPED e livros de saída.


No Resulth WEB o documento fiscal da NFC-e será contabilizado '''somente em rotinas/relatórios fiscais''', ou seja, '''não será possível visualizar ou manipular a NFC-e'''
'''em qualquer outra rotina do sistema'''. Para isto o usuário deverá utilizar os recursos do módulo ECF.


Todas as regras e validações já existentes para cupom fiscal '''deverão ser mantidas para NFC-e''', seja na venda direta ou na importação de pedido.

=== Visualização/Impressão do CUPOM/DANFE ===
Conforme citado acima, quaisquer operações pertinentes a NFC-e deverão ser realizadas no módulo ECF, inclusive a visualização ou impressão da DANFE. Em função disso nas rotinas do Resulth WEB onde hoje é gerado um ''preview'' do cupom fiscal, para NFC-e o procedimento será o seguinte:
#Na emissão de NFC-e, o módulo ECF deverá gravar em seu banco de dados o link para consulta da DANFE da NFC-e já com o respectivo HASH do QRCode. Note que o link de consulta da DANFE poderá variar de acordo com a UF onde a NFC-e foi emitida.
#Quando a NFC-e for sincronizada para o Resulth WEB, o ''webservice'' deverá transportar o link de acesso à DANFE para o atributo '''linkAcessoDANFE''' da classe '''DadosNFCeDelphi'''.
#Ao gravar o pedido da NFC-e no banco de dados do Resulth WEB o link de acesso à DANFE da NFC-e deverá ser gravado no atributo '''linkAcessoDanfeNFCe''' da classe '''CupomFiscal'''.
#Nas consultas do Resulth WEB onde hoje é exibido o ''preview'' do cupom, para NFC-e, quando usuário clicar no ícone será aberta uma nova aba no navegador com o link de consulta da DANFE.

==== Validações e regras de sincronização ====
#Somente serão sincronizadas para o Resulth WEB NFC-e´s cujo status junto a SEFAZ é '''Autorizada''' ou '''Cancelada'''.
#*A sincronização de NFC-e´s de status '''Cancelada''' deverá '''manter no sistema''' tanto o pedido quanto o documento fiscal de saída gerados no Resulth WEB para a NFC-e colocando sobre os mesmos a marca de '''cancelado''' nas classes '''CupomFiscal''' e '''DocumentoSaida'''. Para o pedido da NFC-e, deverão ser desfeitas as movimentações financeiras e de estoque caso existam.
#Caso nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada o ECF esteja configurado como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', para pedidos realizados no Resulth WEB que contenham produtos e serviços importados para o ECF, '''serão considerados somente produtos'''.

==== DadosNFCeDelphi ====
{|class="wikitable"
|'''Atributo da classe DadosNFCeDelphi''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO ||
|-
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-style="background-color:#DCDCDC"
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-
| dataSaida || NFSAIDC || DATASAIDA ||
|-style="background-color:#DCDCDC"
| horaSaida || NFSAIDC || HORASAIDA ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| numeroNFCe || COMPLNFCE || NUMNFCE ||
|-
| numeroPedidoNFCe || PEDIDOC || CODPEDIDO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| status || COMPLNFCE || STATUS ||
|-style="background-color:#DCDCDC"
| tipoAmbiente || COMPLNFCE || TIPOAMBIENTE ||
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| xmlNFCe || -- || -- || Utilizar informação que vem no ''webservice''.
|}

=== Equivalência dos dados de documento fiscal ===
==== Cabeçalho da NFC-e ====
{|class="wikitable"
|'''Atributo da classe DocumentoSaida extends DocumentoFiscal''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| filial || NFSAIDC || CODEMPRESA || Código da filial do ECF correspondente a uma filial do Resulth WEB
|-
| pessoa || NFSAIDC || CODCLIENTE ||
|-style="background-color:#DCDCDC"
| numero || NFSAIDC || NUMNF ||
|-
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| modeloNotaFiscal || -- || -- || Utilizar modelo 65, ou seja, '''''NFC-e - Nota Fiscal Eletrônica ao Consumidor Final'''''
|-style="background-color:#DCDCDC"
| especieNotaFiscal || -- || -- || Utilizar o modelo '''NFC-e, //Nota Fiscal Eletrônica ao Consumidor Final'''
|-
| observacaoLivrosFiscais || NFSAIDC || OBSLIVROFISCAL ||
|-style="background-color:#DCDCDC"
| pagamento || -- || -- || Será gerado se no encerramento da NFC-e foi gerado contas a receber ou parcelas avulsas.
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| observacao || NFSAIDC || OBSERVACAO ||
|-
| numDocOrig || -- || -- || Armazena os documentos a receber gerados caso existam.
|-style="background-color:#DCDCDC"
| transportador || NFSAIDC || CODTRANSPT ||
|-
| notaFiscalEletronica || -- || -- ||
|-style="background-color:#DCDCDC"
| portalFiscalPrefeitura || -- || -- ||
|-
| pagamentosRetencoes || -- || -- ||
|-style="background-color:#DCDCDC"
| operacao || -- || -- ||
|-
| itens || NFSAIDI || -- || Ver tabela '''Itens da NFC-e'''.
|-style="background-color:#DCDCDC"
| dataSaida || NFSAIDC || DATASAIDA ||
|-
| horaSaida || NFSAIDC || HORASAIDA ||
|-style="background-color:#DCDCDC"
| cancelada || NFSAIDC || CANCELADO ||
|-
| notaManual || -- || -- ||
|-style="background-color:#DCDCDC"
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-
| pedidos || -- || -- || Utilizar o '''''CupomFiscal -> DoctoPedidoDevolucao''''' gerado na sincronização do pedido NFC-e para o Resulth WEB.
|-style="background-color:#DCDCDC"
| encerramento || -- || -- || Não gerar. O encerramento ficará na '''''CupomFiscal -> DoctoPedidoDevolucao'''''.
|-
| notasRetencaoPisCofinsCsll || -- || -- ||
|-style="background-color:#DCDCDC"
| pisCofinsCsllRetidoFonte || -- || -- ||
|-
| idNotaAdevolver || -- || -- ||
|}

==== Itens da NFC-e ====
{|class="wikitable"
|'''Atributo da classe ItemNota''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| nota|| -- || -- || Utilizar objeto gerado para o cabeçalho da NFC-e.
|-
| item || NFSAIDI || CODPROD ||
|-style="background-color:#DCDCDC"
| grade || NFSAIDI || CODGRADE || Irrelevante, pois o ''webservice'' de sincronização irá devolver o ID do RrelacionamentoGrade.
|-
| sequencia || -- || -- || Gerado automaticamente para notas digitadas.
|-style="background-color:#DCDCDC"
| cfop || <prod> || CFOP ||
|-
| quantidade || NFSAIDI || QUANTIDADE ||
|-style="background-color:#DCDCDC"
| quantidadeConvertida || -- || -- ||
|-
| unidade || NFSAIDI || UNIDADESAIDA ||
|-style="background-color:#DCDCDC"
| preco || NFSAIDI || PRECOUNIT ||
|-
| precoConvertido || -- || -- ||
|-style="background-color:#DCDCDC"
| iss || NFSAIDI || ALIQISS || Aplicar a alíquota de ISS sobre o total do item para obter o valor do imposto.
|-
| ipi || NFSAIDI ||
*VALORIPI
*VLRBASEIPI
||
|-style="background-color:#DCDCDC"
| icm || NFSAIDI ||
*VLRICMS
*VLRBASEICMS
||
|-
| st || NFSAIDI ||
*VLRICMSST
*VLRBASEICMSST
||
|-style="background-color:#DCDCDC"
| stForaNF || -- || -- ||
|-
| pis || NFSAIDI ||
*VLRPIS
*BASEPIS
||
|-style="background-color:#DCDCDC"
| cofins || NFSAIDI ||
*VLRCOFINS
*BASECOFINS
||
|-
| aproveitamentoCredito || -- || -- ||
|-style="background-color:#DCDCDC"
| descontoItem || NFSAIDI || DESCONTOVLR ||
|-
| totalItem || NFSAIDI || QUANTIDADE * PRECOUNIT ||
|-style="background-color:#DCDCDC"
| totalRateado || NFSAIDI || TOTALRATEADO ||
|-
| cst || NFSAIDI || CODTRIBUT ||
|-style="background-color:#DCDCDC"
| csosn || NFSAIDI || CODCSOSN ||
|-
| rateio || -- || -- ||
|-style="background-color:#DCDCDC"
| seriaisDigitados || CONTSER || ||
|-
| lotesDigitados || -- || -- ||
|-style="background-color:#DCDCDC"
| itensNotaEntradaSerial || -- || -- ||
|-
| itensNotaEntradaLote || -- || -- ||
|-style="background-color:#DCDCDC"
| complemento || -- || -- ||
|-
| original || -- || -- ||
|-style="background-color:#DCDCDC"
| itemBonificado || -- || -- ||
|}

==== Dados eletrônicos da NFC-e ====
{|class="wikitable"
|'''Atributo da classe NotaFiscalEletronica''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| tipoNotaEletronica || -- || -- || Utilizar a opção '''NFC-e'''.
|-
| ambiente || -- || -- || Uma vez que serão sincronizadas somente NFC-e´s emitidas em ambiente de produção, utilizar a opção '''PRODUÇÃO'''.
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO || '''Alterar o tamanho deste campo''' no banco do Resulth WEB de 44 para 50.
|-
| codigoStatus || COMPLNFCE || STATUSPROC || Se neste campo estiver vazio ou nulo, utilizar a informação do campo '''STATUS''' da mesma tabela.
|-style="background-color:#DCDCDC"
| status || -- || -- || A descrição referente ao stauts informado no campo '''codigoStatus''' deverá ser passada para o ''webservice'' de sincronização em tempo de execução, uma vez que estas informações não ficam salvas no banco de dados, mas dentro do próprio código fonte do Delphi na ''unit'' '''GerarXMLNFe'''. Atenção para qual status será preenchido, levando em consideração que temos ''Status da ComplNFe'' e ''CÓDIGO RESULTADO DO PROCESSAMENTO DA SOLICITACAO (retorno SEFAZ)''
|-
| recibo || COMPLNFCE || RECEBIMENTOXML ||
|-style="background-color:#DCDCDC"
| dataHoraRecibo || COMPLNFCE || DATAHORAPROTOCOLO ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| statusInterno || -- || -- ||
|-
| enviouCartaCorrecao || -- || -- || Utilizar padrão '''''false'''''.
|-style="background-color:#DCDCDC"
| imprimiuDanfe || COMPLNFCE || IMPDANFE || S = true; N = false.
|-
| enviouEmail || -- || -- ||
|-style="background-color:#DCDCDC"
| falhaComunicacao || -- || -- ||
|-
| statusDisponibilizacao || -- || -- ||
|-style="background-color:#DCDCDC"
| nfse || -- || -- ||
|-
| xmlNFCe || -- || -- || Popular este objeto a partir das informações do atributo '''xmlNFCe''' da classe '''DadosNFCeDelphi'''.
|-style="background-color:#DCDCDC"
| xmlNFe || -- || -- ||
|-
| xmlNFSe || -- || -- ||
|-style="background-color:#DCDCDC"
| cartaCorrecao ||| -- || -- ||
|}

UC00087 - Consulta Produtos Inativos

2015-04-20T18:55:50Z

Daniel: /* RN03 - Tela exibição dos dados */

= Objetivo =
*Fazer a consulta de produtos inativos, fornecendo ao usuário informações úteis para gerenciamento do seu mix.

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]]
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta produtos inativos'''. Este nome será utilizado para criar a página no Wiki.
*Ter desenvolvido o mecanismo de gravação da data do cadastramento do produto.

= Resultado esperado =
*Gerar a consulta de produtos inativos, possibilitando gerar os vários formatos de arquivos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina no menu '''Consulta -> Faturamento -> Produtos inativos.
*Sistema exibe os campos de filtragem conforme [[#RN01 - Tela inicial de filtragem| RN01]].

'''Fluxo 2:''' Usuário informa dados para filtragem.

*Sistema procede conforme regra de negócio [[#RN02 - Filtragem dos Produtos Inativos | RN02]], e em seguida, após clicar em <Pesquisa> o sistema exibe os dados conforme [[#RN03 - Tela exibição dos dados| RN03]].

= Regras de negócio =

== RN01 - Tela inicial de filtragem ==

#'''Filiais:''' Usar componente padrão do sistema.
#'''Produtos não movimentados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Produtos cadastrados entre:''' Usar componente padrão do sistema, para data inicial e final.
#'''Grupo:''' Campo presente na guia inicial do produto.
#'''Sub-grupo:''' Campo presente na guia inicial do produto.
#'''Família:''' Campo presente na guia inicial do produto.
#'''Marca:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fabricante:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Fornecedor Principal:''' Campo presente na guia "Fornecedores/marcas/fabricantes".
#'''Tipo de produtos:'''
#* Ativo, Inativo ou Ambos
#* Não Bloqueado, Bloqueado ou Ambos
#'''Apenas Movimentos de Venda ?'''
#''' Apenas produtos com Estoque ?'''

== RN02 - Filtragem dos Produtos Inativos ==

O sistema procurará por movimentos de estoque, os itens que forem considerados válidos na filtragem. Neste contexto, desconsiderar itens que são serviços.

* Filais: se marcado alguma, considerar os movimentos apenas destas. Ou seja: pode até ter havido um movimento de estoque em uma filial, mas, se a mesma não estiver sendo considerada, e este for o único pedido, o produto esta inativo.
* Produtos não movimentados entre: verificar se entre o período informado, não houve nenhum movimento de estoque para o produto. Caso afirmativo, o item entrará na consulta.
* Produtos cadastrados entre: verificar se os itens foram cadastrados dentro deste período. Caso negativo, ignorar.
* Grupo: Filtragem padrão, caso campo seja informado.
* Sub-grupo: Filtragem padrão, caso campo seja informado.
* Família: Filtragem padrão, caso campo seja informado.
* Marca: Filtragem padrão, caso campo seja informado.
* Fabricante: Filtragem padrão, caso campo seja informado.
* Fornecedor Principal: Filtragem padrão, caso campo seja informado. Não considerar fornecedores secundários.
* Tipo de produtos: verificar os ativos e bloqueados de acordo com os campos presente na guia principal do cadastro de itens.
* Apenas Movimentos de Venda ?: se o usuário marcas esta opção, mesmo observando o movimento de estoque, considerar apenas os que são referente a venda, que seriam os movimentos 51, 55 e 56 (MovimentoEstoque.tipomovestoque).
* Apenas produtos com Estoque: se marcado, o produto deve ter estoque em pelo menos uma filial, para ser considerado no relatório.

== RN03 - Tela exibição dos dados ==
Após realizar a filtragem, o sistema deverá listar os resultados em um grid com as as seguintes colunas:
#'''PRODUTO:''' Código do produto.
#'''DESCRIÇÃO:''' Descrição do produto.
#'''DATA ÚLT. ENTRADA:''' Exibe a data do último movimento de entrada realizado para o produto.
#'''TIPO DE ENTRADA:''' Exibe o tipo de movimento de entrada cuja data é informada na coluna anterior. Os possíveis tipos de movimento de entrada serão:
#*Entrada via NF
#*Entrada via inventário/acerto
#*Início de estoque
#*Entradas/Saídas
#*Entrada via documento próprio
#*Entrada via troca
#*Entrada via transferência
#'''DATA ÚLT. SAÍDA:''' Exibe a data do último movimento de saída realizado para o produto.
#'''Nº DOC. SAÍDA:''' Exibirá o número do último documento de saída para o produto cuja data é listada na coluna anterior. O último documento de saída será exibido independente se houve devolução para o mesmo.
#'''PDV:''' Caso o último documento de saída do produto seja um PDV, será exibido nesta coluna um ícone que quando acionado exibirá ao usuário um ''preview'' do pedido.
#'''ECF/NFC-e:''' Caso o último documento de saída do produto seja um cupom fiscal ou uma NFC-e, será exibido nesta coluna um ícone que quando acionado procederá conforme segue abaixo:
#*Se o último documento de saída for um cupom fiscal, será exibido um ícone que quando acionado exibirá ao usuário um ''preview'' do cupom.
#*Se o último documento de saída for uma NFC-e, será exibido um ícone que quando acionado abrirá em uma nova aba o link de acesso à DANFE da NFC-e.
#'''PREÇO DE CUSTO:''' Exibe o preço de custo do produto na filial logada.

#'''ESTOQUE:''' Exibir a soma do estoque de todas as filiais marcadas na filtragem.
#'''VALOR DO ESTOQUE:''' Custo * soma do estoque acima.

UC00099 - Integração Java/ECF

2015-04-20T17:55:29Z

Daniel: /* RN04 - NFC-e */

= Objetivo =

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =

= Diagrama de classes =
[[File:ECF.png|400px]]

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:'''

== Fluxos alternativos ==
'''Fluxo 1:''' Com os [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros de ECF da filial logada]] configurados como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', o usuário faz um pedido no Resulth WEB que contem produtos e serviços e em seguida tenta importa-lo no ECF.
*O ECF importará o pedido normalmente, mas '''considerará somente os produtos''' do mesmo. Enquanto '''OPERAÇÃO DO PAF = NFC-e''' os '''serviços serão desprezados''' na importação de pedidos.

'''Fluxo 2:''' Usuário acessa no Resulth WEB o cadastro de operações de saída e entra em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando '''somente''' o estado do parâmetro '''Gera contabilidade''' e acionando o botão '''[Salvar]''' em seguida.
*Desde que tenha sido alterado '''somente''' o estado do parâmetro '''Gera contabilidade''' na aba '''Movimentos''', o sistema irá atualizar o cadastro da operação em questão.

== Fluxos de exceção ==
'''Fluxo 1:''' Usuário inicializa o módulo ECF, sendo que ele possui em uma determinada filial dois ou mais ECF´s cujas configurações estão diferentes uma da outra.
*Se nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] as configurações de todos os ECF´s/PDV´s não forem '''exatamente iguais para a filial logada''', será emitida ao usuário a seguinte mensagem de alerta: ''Para a filial XXX - XXXXXX existem um ou mais ECF´s cujas configurações diferem dos demais. É altamente recomendado que todos os ECF´s utilizem a mesma configuração.'' Onde X corresponde ao código e nome da filial.
*A mensagem será apenas um alerta e não impedirá o usuário de prosseguir com seu fluxo.

'''Fluxo 2:''' No Resulth WEB o usuário acessa o cadastro de operação de saída entrando em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando configurações que sejam '''diferentes''' do parâmetro '''Gera contabilidade''' acionando o botão '''[Salvar]''' em seguida.
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido alterar as configurações desta operação, pois suas configurações são definidas por padrão no sistema e a mesma é utilizada na sincronização de dados com o módulo ECF.''

'''Fluxo 3:''' No Resulth WEB o usuário acessa o cadastro de operação de saída e tenta excluir uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]].
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido excluir esta operação, pois a mesma é utilizada na sincronização de dados com o módulo ECF.''

= Regras de negócio =
== RN01 - Operações ==
=== VENDA DIRETA NO ECF ===
Operação padrão do sistema para vendas realizadas diretamente no ECF que serão sincronizadas/enviadas para o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Sim''
#Considera em comissão = ''Sim''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Sim'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA NO ECF IMPORTANDO PDV ===
Operação padrão do sistema para vendas no ECF através da importação de PDV ('''não será utilizada na importação de DAV''') que serão sincronizadas com o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA DIRETA NO ECF OU IMPORTAÇÃO DE PEDIDO PARA EMISSÃO DE NFC-e ===
Tanto vendas diretas no ECF quanto importação de PDV´s que resultem na emissão de NFC-e, na sincronização com o Resulth WEB será gerado um documento fiscal de saída e para este deverá ser utilizada uma operação com as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Não'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera SPED Contribuições = '''Sim'''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''


Para pedidos do tipo OS não será necessário ter uma operação padrão definida uma vez que as movimentações de estoque e geração do financeiro '''já foram realizados'''.
Em outras palavras, o cupom gerado para um pedido de OS '''não''' movimentará estoque nem gerará financeiro.


Pedidos do tipo DAV não podem movimentar estoque e nem gerar financeiro. Sendo assim, quando importados no ECF, as movimentações serão geradas quando o cupom for
sincronizado com o Resulth WEB a exemplo de como ocorre com a venda direta no ECF.


Operações padrão para integração com o ECF '''não''' podem ser alteradas ou excluídas pelo usuário.

== RN02 - Sincronização ==
=== PDV´s importados para o ECF ===
Ao importar PDV´s para o ECF as seguintes regras devem ser observadas:
#'''PDV´s que já movimentaram estoque:''' Estes pedidos serão listados no ECF junto com os demais pedidos que ainda não movimentaram estoque, porém não poderão ser importados para emissão do cupom. Caso usuário informe diretamente o código ou selecione na filtragem um PDV que já movimentou estoque, o ECF abortará a importação do mesmo e emitirá ao usuário a seguinte mensagem de alerta: ''A emissão de cupom fiscal a partir da importação de um PDV é configurada por padrão para movimentar estoque e portanto o pedido selecionado não poderá ser importado, uma vez que ele já movimentou estoque de seus itens.''
#'''Formas de pagamento:''' As formas de pagamento utilizadas no encerramento do cupom deverão ser compatíveis com as formas de pagamento do PDV importado. Para isto, quando um PDV for importado para o ECF, o sistema (ECF) deverá '''desabilitar''' todas as formas de pagamento e preencher automaticamente os valores de cada uma conforme as formas de pagamento utilizadas no PDV.
#*Se o ECF estiver configurado para '''não''' importar serviço e um determinado PDV '''conter''' serviço(s), para esta importação em específico as regras acima deverão ser desconsideradas.
#*Caso no PDV tenha sido utilizada a forma de pagamento ''financeira'', ao preencher automaticamente as formas de pagamento no encerramento do cupom o sistema considerará o total financiado como '''dinheiro'''.

Os cupons dos PDV´s importados para o ECF serão enviados para o Resulth WEB, e neste ponto será gerado o movimento de estoque dos itens de cada cupom utilizando a operação '''VENDA NO ECF IMPORTANDO PDV''' conforme regra de negócio [[#RN01 - Operações | RN01]].

=== Vendas diretas e DAV´s importados ===
Os cupons dos DAV´s importados e das vendas feitas diretamente no ECF serão enviados para o Resulth WEB, e neste ponto serão gerados os movimentos de estoque dos itens e também o financeiro de acordo com as formas de pagamento informadas em cada cupom utilizando a operação '''VENDA DIRETA NO ECF''' conforme regra de negócio [[#RN01 - Operações | RN01]].

Antes de gerar o financeiro para os cupons sincronizados, o sistema deverá verificar nos parâmetros do PDV:
#'''Gerar movimento de caixa para as vendas?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa informado para centralizar vendas do PDV (logo à direita do parâmetro em questão) serão gerados movimentos de caixa para cada cupom com o subcaixa informado.
#'''Utiliza fechamento de caixa?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa do operador que emitiu os cupons serão gerados movimentos de caixa.
#Independente se '''Gerar movimento de caixa para as vendas? = Sim''' ou '''Utiliza fechamento de caixa? = Sim''', ao gerar movimento de caixa será considerado:
#*Se a opção '''Para todas as vendas''' estiver marcada como '''Sim''', na conta caixa informada logo à sua direita será gerado o movimento de caixa com o valor total de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons.
#*Caso uma ou mais formas de pagamento esteja(m) marcada(s) como '''Sim''', na(s) conta(s) caixa informada(s) será(ão) gerado(s) movimento(s) de caixa com o(s) valor(es) da(s) respectiva(s) forma(s) de pagamento de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons. Se houver em um determinado cupom um forma de pagamento que está marcada nos parâmetros do PDV como '''Não''' e que não possui uma conta caixa informada, '''não será gerado movimento de caixa''' com o valor da mesma.

=== NFC-e ===
A sincronização entenderá que os procedimentos de NFC-e deverão ser realizados quando nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada, para o número de um determinado PDV/ECF, estiverem marcados os parâmetros '''OPERAÇÃO DO PAF = NFC-e''' e '''AMBIENTE NFC-e = Produção'''.

Uma vez que o sistema identificou que ao invés de cupom fiscal será sincronizada a NFC-e, o procedimento será o seguinte:
#Quando o ECF consumir o ''webservice'' de sincronização ao invés de popular o objeto '''DadosCupomDelphi''' com os dados do cupom a partir das tabelas VENDPDV e ENCERRA, ele deverá popular o objeto '''DadosNFCeDelphi''' com os dados do pedido da NFC-e (tabelas PEDIDOC e PEDIDOI), com os dados fiscais da mesma (tabelas NFSAIDI e NFSAIDC) e também com os dados eletrônicos complementares (tabela COMPLNFCE).
#Com o objeto '''DadosNFCeDelphi''' populado, será utilizada a classe '''MontaCupomFiscalImportacaoServiceImpl''' para preparar um objeto do tipo '''CupomFiscal''' e persisti-lo no banco de dados '''gravando no Resulth WEB o pedido da NFC-e exatamente na mesma estrutura onde é gravado o cupom fiscal'''.
#*O pedido da NFC-e deverá ser gravado no Resulth WEB com o mesmo código gerado pelo Delphi na tabela PEDIDOC.
#*Para NFC-e no atributo '''tipoCupom''' da classe '''CupomFiscal''' deverá ser informada a opção '''NFC-E'''. Este atributo foi criado para diferenciar o pedido da NFC-e do pedido do Cupom Fiscal e deverá ser criado com o valor padrão '''CUPOM_FISCAL''' para registros já existentes no banco de dados dos clientes.
#Em seguida deverá ser gerado um documento fiscal de saída para o pedido da NFC-e que fora gravado. Para isto poderá ser utilizada a classe '''PedidoNotaServiceImpl'''.
#Para preencher o documento fiscal o Resulth WEB '''não calculará nenhum imposto'''. Estes serão preenchidos a partir do XML da NFC-e que será sincronizado também. ''Para isto pode ser reaproveitado um recurso existente na importação de XML da nota de entrada, que preenche um objeto a partir de um arquivo XML que tenha a mesma estrutura da NF-e''.

== RN03 - Integração com controle de caixa/checkouts ==
Para vendas serem consideradas pelo controle de caixa, independente de sua origem, deverão ser observados:
*Caso de uso [[UC00066 - Abertura de caixa]].
*Caso de uso [[UC00067 - Controle de caixa]].
*Regra de negócio RN03 do caso de uso [[UC00064 - Parâmetros do PDV#Movimentação de caixa | UC00064 - Parâmetros do PDV]].
*Caso de uso [[UC00072 - Ponto de venda]].

=== Importação de PDV e OS para o ECF ===
Pedidos do tipo '''55''' e '''65''' importados para o ECF serão considerados pela rotina de controle de caixa '''descartando''' a existência do cupom fiscal uma vez que a geração do financeiro só pode ser realizada pelo PDV. Em outras palavras, OS´s e PDV´s serão considerados pelo controle de caixa normalmente (se o PDV for configurado para tal) independente deles terem sido importados para o ECF ou não.


Se o PDV gera financeiro, movimento no subcaixa do operador que possui caixa aberto será gerado pelo Resulth WEB.

=== Importação de DAV e venda direta no ECF ===
Partindo do pré-suposto que o DAV '''não''' movimenta estoque nem gera financeiro, após importado para o ECF o mesmo será tratado como uma venda direta ao sincronizar seu cupom com o Resulth WEB. Para vendas diretas no ECF o movimento de estoque e a geração do financeiro serão realizados quando os respectivos cupons forem sincronizados com o Resulth WEB.

Antes de cada venda direta ou a importação de um DAV, o sistema (ECF) deverá:
#'''Verificar se o retaguarda (Resulth WEB) utiliza fechamento de caixa:''' Na aba ''Faturamento'' dos parâmetros do PDV deverá ser verificado o estado do parâmetro '''Utiliza fechamento de caixa?'''. Se o parâmetro em questão estiver como '''Não''', os demais passos deverão ser ignorados e a venda direta ou importação do DAV procederá normalmente. Se o parâmetro estiver como '''Sim''', executar os próximos passos.
#'''Verificar se o caixa do operador foi/está aberto:''' Para que um determinado operador consiga vender ou importar DAV no ECF é necessário que seu caixa esteja aberto no retaguarda (Resulth WEB). Caso o caixa do operador não esteja aberto o sistema (ECF) deverá abortar a venda ou importação do DAV e emitir ao usuário uma mensagem de alerta com a não conformidade.
#*Caso '''não exista''' no retaguarda caixa aberto para o usuário/operador logado no ECF, exibir a mensagem: ''O sistema de retaguarda (Resulth WEB) está configurado para utilizar fechamento de caixa e não ha caixa aberto para o operador logado. Faça a abertura do caixa do operador em questão e tente novamente.''
#*Caso o caixa do usuário/operador já tenha sido '''fechado''', exibir a mensagem: ''O caixa do operador logado já foi fechado e portanto o mesmo não poderá realizar vendas.''

== RN04 - NFC-e ==
Em resumo a NFC-e será tratada/sincronizada como um cupom fiscal no Resulth WEB, ou seja, os dados de um pedido de NFC-e serão visualizados e considerados da mesma maneira que um pedido de cupom fiscal. O que irá diferenciar um pedido de cupom fiscal de um pedido de NFC-e no Resulth WEB será a existência de um documento fiscal (a NFC-e propriamente dita), que será criado para todas as NFC-e´s sincronizadas para o Resulth WEB e considerado também em rotinas fiscais como SPED e livros de saída.


No Resulth WEB o documento fiscal da NFC-e será contabilizado '''somente em rotinas/relatórios fiscais''', ou seja, '''não será possível visualizar ou manipular a NFC-e'''
'''em qualquer outra rotina do sistema'''. Para isto o usuário deverá utilizar os recursos do módulo ECF.


Todas as regras e validações já existentes para cupom fiscal '''deverão ser mantidas para NFC-e''', seja na venda direta ou na importação de pedido.

=== Visualização/Impressão do CUPOM/DANFE ===
Conforme citado acima, quaisquer operações pertinentes a NFC-e deverão ser realizadas no módulo ECF, inclusive a visualização ou impressão da DANFE. Em função disso nas rotinas do Resulth WEB onde hoje é gerado um ''preview'' do cupom fiscal, para NFC-e o procedimento será o seguinte:
#Na emissão de NFC-e, o módulo ECF deverá gravar em seu banco de dados o link para consulta da DANFE da NFC-e já com o respectivo HASH do QRCode. Note que o link de consulta da DANFE poderá variar de acordo com a UF onde a NFC-e foi emitida.
#Quando a NFC-e for sincronizada para o Resulth WEB, o ''webservice'' deverá transportar o link de acesso à DANFE para o atributo '''linkAcessoDANFE''' da classe '''DadosNFCeDelphi'''.
#Ao gravar o pedido da NFC-e no banco de dados do Resulth WEB o link de acesso à DANFE da NFC-e deverá ser gravado no atributo '''linkAcessoDanfeNFCe''' da classe '''CupomFiscal'''.
#Nas consultas do Resulth WEB onde hoje é exibido o ''preview'' do cupom, para NFC-e, quando usuário clicar no ícone será aberta uma nova aba no navegador com o link de consulta da DANFE.

==== Validações e regras de sincronização ====
#Somente serão sincronizadas para o Resulth WEB NFC-e´s cujo status junto a SEFAZ é '''Autorizada''' ou '''Cancelada'''.
#*A sincronização de NFC-e´s de status '''Cancelada''' deverá '''manter no sistema''' tanto o pedido quanto o documento fiscal de saída gerados no Resulth WEB para a NFC-e colocando sobre os mesmos a marca de '''cancelado''' nas classes '''CupomFiscal''' e '''DocumentoSaida'''. Para o pedido da NFC-e, deverão ser desfeitas as movimentações financeiras e de estoque caso existam.
#Caso nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada o ECF esteja configurado como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', para pedidos realizados no Resulth WEB que contenham produtos e serviços importados para o ECF, '''serão considerados somente produtos'''.

==== DadosNFCeDelphi ====
{|class="wikitable"
|'''Atributo da classe DadosNFCeDelphi''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO ||
|-
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-style="background-color:#DCDCDC"
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-
| dataSaida || NFSAIDC || DATASAIDA ||
|-style="background-color:#DCDCDC"
| horaSaida || NFSAIDC || HORASAIDA ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| numeroNFCe || COMPLNFCE || NUMNFCE ||
|-
| numeroPedidoNFCe || PEDIDOC || CODPEDIDO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| status || COMPLNFCE || STATUS ||
|-style="background-color:#DCDCDC"
| tipoAmbiente || COMPLNFCE || TIPOAMBIENTE ||
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| xmlNFCe || -- || -- || Utilizar informação que vem no ''webservice''.
|}

=== Equivalência dos dados de documento fiscal ===
==== Cabeçalho da NFC-e ====
{|class="wikitable"
|'''Atributo da classe DocumentoSaida extends DocumentoFiscal''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| filial || NFSAIDC || CODEMPRESA || Código da filial do ECF correspondente a uma filial do Resulth WEB
|-
| pessoa || NFSAIDC || CODCLIENTE ||
|-style="background-color:#DCDCDC"
| numero || NFSAIDC || NUMNF ||
|-
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| modeloNotaFiscal || -- || -- || Utilizar modelo 65, ou seja, '''''NFC-e - Nota Fiscal Eletrônica ao Consumidor Final'''''
|-style="background-color:#DCDCDC"
| especieNotaFiscal || -- || -- || Utilizar o modelo '''NFC-e, //Nota Fiscal Eletrônica ao Consumidor Final'''
|-
| observacaoLivrosFiscais || NFSAIDC || OBSLIVROFISCAL ||
|-style="background-color:#DCDCDC"
| pagamento || -- || -- || Será gerado se no encerramento da NFC-e foi gerado contas a receber ou parcelas avulsas.
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| observacao || NFSAIDC || OBSERVACAO ||
|-
| numDocOrig || -- || -- || Armazena os documentos a receber gerados caso existam.
|-style="background-color:#DCDCDC"
| transportador || NFSAIDC || CODTRANSPT ||
|-
| notaFiscalEletronica || -- || -- ||
|-style="background-color:#DCDCDC"
| portalFiscalPrefeitura || -- || -- ||
|-
| pagamentosRetencoes || -- || -- ||
|-style="background-color:#DCDCDC"
| operacao || -- || -- ||
|-
| itens || NFSAIDI || -- || Ver tabela '''Itens da NFC-e'''.
|-style="background-color:#DCDCDC"
| dataSaida || NFSAIDC || DATASAIDA ||
|-
| horaSaida || NFSAIDC || HORASAIDA ||
|-style="background-color:#DCDCDC"
| cancelada || NFSAIDC || CANCELADO ||
|-
| notaManual || -- || -- ||
|-style="background-color:#DCDCDC"
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-
| pedidos || -- || -- || Utilizar o '''''CupomFiscal -> DoctoPedidoDevolucao''''' gerado na sincronização do pedido NFC-e para o Resulth WEB.
|-style="background-color:#DCDCDC"
| encerramento || -- || -- || Não gerar. O encerramento ficará na '''''CupomFiscal -> DoctoPedidoDevolucao'''''.
|-
| notasRetencaoPisCofinsCsll || -- || -- ||
|-style="background-color:#DCDCDC"
| pisCofinsCsllRetidoFonte || -- || -- ||
|-
| idNotaAdevolver || -- || -- ||
|}

==== Itens da NFC-e ====
{|class="wikitable"
|'''Atributo da classe ItemNota''' || '''TABELA BD ECF/Tag XML NFCe''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| nota|| -- || -- || Utilizar objeto gerado para o cabeçalho da NFC-e.
|-
| item || NFSAIDI || CODPROD ||
|-style="background-color:#DCDCDC"
| grade || NFSAIDI || CODGRADE || Irrelevante, pois o ''webservice'' de sincronização irá devolver o ID do RrelacionamentoGrade.
|-
| sequencia || -- || -- || Gerado automaticamente para notas digitadas.
|-style="background-color:#DCDCDC"
| cfop || <prod> || CFOP ||
|-
| quantidade || <prod> || qCom ||
|-style="background-color:#DCDCDC"
| quantidadeConvertida || -- || -- ||
|-
| unidade || <prod> || uCom ||
|-style="background-color:#DCDCDC"
| preco || <prod> || vUnCom ||
|-
| precoConvertido || -- || -- ||
|-style="background-color:#DCDCDC"
| iss || <ISSQN> ||
*vBC (Valor da Base de Cálculo do ISSQN)
*vAliq (Alíquota do ISSQN)
*vISSQN (Valor do ISSQN)
|| Inicialmente, a NFC-e (no ECF) '''não irá conter serviços'''.
|-
| ipi || <IPI> ||
*vBC (Valor da BC do IPI)
*pIPI (Alíquota do IPI)
*vIPI (Valor do IPI)
||
|-style="background-color:#DCDCDC"
| icm || <ICMSXX> ||
*vBC (Valor da BC do ICMS)
*pICMS (Alíquota do imposto)
*vICMS (Valor do ICMS)
|| Lembrando que o ''XX'' ao fim do nome da ''Tag'' do XML refere-se aos dois últimos dígitos do CST correspondente. Exemplo: ''<ICMS10> está para CST´s terminados em 10''; ''<ICMS20> está para CST´s terminados em 20''.
|-
| st || <ICMSXX> ||
*vBCST (Valor da BC do ICMS ST)
*pICMSST (Alíquota do imposto do ICMS ST)
*vICMSST (Valor do ICMS ST)
|| Lembrando que o ''XX'' ao fim do nome da ''Tag'' do XML refere-se aos dois últimos dígitos do CST correspondente. Exemplo: ''<ICMS10> está para CST´s terminados em 10''; ''<ICMS20> está para CST´s terminados em 20''.
|-style="background-color:#DCDCDC"
| stForaNF || -- || -- ||
|-
| pis || <PIS> ||
*vBC (Valor da Base de Cálculo do PIS)
*pPIS (Alíquota do PIS (em percentual)
*vPIS (Valor do PIS)
||
|-style="background-color:#DCDCDC"
| cofins || <COFINS> ||
*vBC (Valor da Base de Cálculo da COFINS)
*pCOFINS (Alíquota da COFINS (em percentual))
*vCOFINS (Valor da COFINS)
||
|-
| aproveitamentoCredito || -- || -- ||
|-style="background-color:#DCDCDC"
| descontoItem || <prod> || vDesc ||
|-
| totalItem || NFSAIDI || QUANTIDADE * PRECOUNIT ||
|-style="background-color:#DCDCDC"
| totalRateado || NFSAIDI || TOTALRATEADO ||
|-
| cst || NFSAIDI || CODTRIBUT ||
|-style="background-color:#DCDCDC"
| csosn || <ICMSSNXXX> ||
*CSOSN
|| Lembrando que o ''XXX'' ao fim do nome da ''Tag'' do XML refere-se aos três últimos dígitos do CSOSN correspondente. Exemplo: ''<ICMSSN101> está para CSOSN´s terminados em 101''; ''<ICMSSN102> está para CSOSN´s terminados em 102''.
|-
| rateio || -- || -- ||
|-style="background-color:#DCDCDC"
| seriaisDigitados || CONTSER || ||
|-
| lotesDigitados || -- || -- ||
|-style="background-color:#DCDCDC"
| itensNotaEntradaSerial || -- || -- ||
|-
| itensNotaEntradaLote || -- || -- ||
|-style="background-color:#DCDCDC"
| complemento || -- || -- ||
|-
| original || -- || -- ||
|-style="background-color:#DCDCDC"
| itemBonificado || -- || -- ||
|}

==== Dados eletrônicos da NFC-e ====
{|class="wikitable"
|'''Atributo da classe NotaFiscalEletronica''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| tipoNotaEletronica || -- || -- || Utilizar a opção '''NFC-e'''.
|-
| ambiente || -- || -- || Uma vez que serão sincronizadas somente NFC-e´s emitidas em ambiente de produção, utilizar a opção '''PRODUÇÃO'''.
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO || '''Alterar o tamanho deste campo''' no banco do Resulth WEB de 44 para 50.
|-
| codigoStatus || COMPLNFCE || STATUSPROC || Se neste campo estiver vazio ou nulo, utilizar a informação do campo '''STATUS''' da mesma tabela.
|-style="background-color:#DCDCDC"
| status || -- || -- || A descrição referente ao stauts informado no campo '''codigoStatus''' deverá ser passada para o ''webservice'' de sincronização em tempo de execução, uma vez que estas informações não ficam salvas no banco de dados, mas dentro do próprio código fonte do Delphi na ''unit'' '''GerarXMLNFe'''. Atenção para qual status será preenchido, levando em consideração que temos ''Status da ComplNFe'' e ''CÓDIGO RESULTADO DO PROCESSAMENTO DA SOLICITACAO (retorno SEFAZ)''
|-
| recibo || COMPLNFCE || RECEBIMENTOXML ||
|-style="background-color:#DCDCDC"
| dataHoraRecibo || COMPLNFCE || DATAHORAPROTOCOLO ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| statusInterno || -- || -- ||
|-
| enviouCartaCorrecao || -- || -- || Utilizar padrão '''''false'''''.
|-style="background-color:#DCDCDC"
| imprimiuDanfe || COMPLNFCE || IMPDANFE || S = true; N = false.
|-
| enviouEmail || -- || -- ||
|-style="background-color:#DCDCDC"
| falhaComunicacao || -- || -- ||
|-
| statusDisponibilizacao || -- || -- ||
|-style="background-color:#DCDCDC"
| nfse || -- || -- ||
|-
| xmlNFCe || -- || -- || Popular este objeto a partir das informações do atributo '''xmlNFCe''' da classe '''DadosNFCeDelphi'''.
|-style="background-color:#DCDCDC"
| xmlNFe || -- || -- ||
|-
| xmlNFSe || -- || -- ||
|-style="background-color:#DCDCDC"
| cartaCorrecao ||| -- || -- ||
|}

UC00099 - Integração Java/ECF

2015-04-20T17:53:18Z

Daniel: /* RN04 - NFC-e */

= Objetivo =

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =

= Diagrama de classes =
[[File:ECF.png|400px]]

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:'''

== Fluxos alternativos ==
'''Fluxo 1:''' Com os [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros de ECF da filial logada]] configurados como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', o usuário faz um pedido no Resulth WEB que contem produtos e serviços e em seguida tenta importa-lo no ECF.
*O ECF importará o pedido normalmente, mas '''considerará somente os produtos''' do mesmo. Enquanto '''OPERAÇÃO DO PAF = NFC-e''' os '''serviços serão desprezados''' na importação de pedidos.

'''Fluxo 2:''' Usuário acessa no Resulth WEB o cadastro de operações de saída e entra em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando '''somente''' o estado do parâmetro '''Gera contabilidade''' e acionando o botão '''[Salvar]''' em seguida.
*Desde que tenha sido alterado '''somente''' o estado do parâmetro '''Gera contabilidade''' na aba '''Movimentos''', o sistema irá atualizar o cadastro da operação em questão.

== Fluxos de exceção ==
'''Fluxo 1:''' Usuário inicializa o módulo ECF, sendo que ele possui em uma determinada filial dois ou mais ECF´s cujas configurações estão diferentes uma da outra.
*Se nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] as configurações de todos os ECF´s/PDV´s não forem '''exatamente iguais para a filial logada''', será emitida ao usuário a seguinte mensagem de alerta: ''Para a filial XXX - XXXXXX existem um ou mais ECF´s cujas configurações diferem dos demais. É altamente recomendado que todos os ECF´s utilizem a mesma configuração.'' Onde X corresponde ao código e nome da filial.
*A mensagem será apenas um alerta e não impedirá o usuário de prosseguir com seu fluxo.

'''Fluxo 2:''' No Resulth WEB o usuário acessa o cadastro de operação de saída entrando em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando configurações que sejam '''diferentes''' do parâmetro '''Gera contabilidade''' acionando o botão '''[Salvar]''' em seguida.
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido alterar as configurações desta operação, pois suas configurações são definidas por padrão no sistema e a mesma é utilizada na sincronização de dados com o módulo ECF.''

'''Fluxo 3:''' No Resulth WEB o usuário acessa o cadastro de operação de saída e tenta excluir uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]].
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido excluir esta operação, pois a mesma é utilizada na sincronização de dados com o módulo ECF.''

= Regras de negócio =
== RN01 - Operações ==
=== VENDA DIRETA NO ECF ===
Operação padrão do sistema para vendas realizadas diretamente no ECF que serão sincronizadas/enviadas para o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Sim''
#Considera em comissão = ''Sim''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Sim'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA NO ECF IMPORTANDO PDV ===
Operação padrão do sistema para vendas no ECF através da importação de PDV ('''não será utilizada na importação de DAV''') que serão sincronizadas com o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA DIRETA NO ECF OU IMPORTAÇÃO DE PEDIDO PARA EMISSÃO DE NFC-e ===
Tanto vendas diretas no ECF quanto importação de PDV´s que resultem na emissão de NFC-e, na sincronização com o Resulth WEB será gerado um documento fiscal de saída e para este deverá ser utilizada uma operação com as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Não'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera SPED Contribuições = '''Sim'''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''


Para pedidos do tipo OS não será necessário ter uma operação padrão definida uma vez que as movimentações de estoque e geração do financeiro '''já foram realizados'''.
Em outras palavras, o cupom gerado para um pedido de OS '''não''' movimentará estoque nem gerará financeiro.


Pedidos do tipo DAV não podem movimentar estoque e nem gerar financeiro. Sendo assim, quando importados no ECF, as movimentações serão geradas quando o cupom for
sincronizado com o Resulth WEB a exemplo de como ocorre com a venda direta no ECF.


Operações padrão para integração com o ECF '''não''' podem ser alteradas ou excluídas pelo usuário.

== RN02 - Sincronização ==
=== PDV´s importados para o ECF ===
Ao importar PDV´s para o ECF as seguintes regras devem ser observadas:
#'''PDV´s que já movimentaram estoque:''' Estes pedidos serão listados no ECF junto com os demais pedidos que ainda não movimentaram estoque, porém não poderão ser importados para emissão do cupom. Caso usuário informe diretamente o código ou selecione na filtragem um PDV que já movimentou estoque, o ECF abortará a importação do mesmo e emitirá ao usuário a seguinte mensagem de alerta: ''A emissão de cupom fiscal a partir da importação de um PDV é configurada por padrão para movimentar estoque e portanto o pedido selecionado não poderá ser importado, uma vez que ele já movimentou estoque de seus itens.''
#'''Formas de pagamento:''' As formas de pagamento utilizadas no encerramento do cupom deverão ser compatíveis com as formas de pagamento do PDV importado. Para isto, quando um PDV for importado para o ECF, o sistema (ECF) deverá '''desabilitar''' todas as formas de pagamento e preencher automaticamente os valores de cada uma conforme as formas de pagamento utilizadas no PDV.
#*Se o ECF estiver configurado para '''não''' importar serviço e um determinado PDV '''conter''' serviço(s), para esta importação em específico as regras acima deverão ser desconsideradas.
#*Caso no PDV tenha sido utilizada a forma de pagamento ''financeira'', ao preencher automaticamente as formas de pagamento no encerramento do cupom o sistema considerará o total financiado como '''dinheiro'''.

Os cupons dos PDV´s importados para o ECF serão enviados para o Resulth WEB, e neste ponto será gerado o movimento de estoque dos itens de cada cupom utilizando a operação '''VENDA NO ECF IMPORTANDO PDV''' conforme regra de negócio [[#RN01 - Operações | RN01]].

=== Vendas diretas e DAV´s importados ===
Os cupons dos DAV´s importados e das vendas feitas diretamente no ECF serão enviados para o Resulth WEB, e neste ponto serão gerados os movimentos de estoque dos itens e também o financeiro de acordo com as formas de pagamento informadas em cada cupom utilizando a operação '''VENDA DIRETA NO ECF''' conforme regra de negócio [[#RN01 - Operações | RN01]].

Antes de gerar o financeiro para os cupons sincronizados, o sistema deverá verificar nos parâmetros do PDV:
#'''Gerar movimento de caixa para as vendas?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa informado para centralizar vendas do PDV (logo à direita do parâmetro em questão) serão gerados movimentos de caixa para cada cupom com o subcaixa informado.
#'''Utiliza fechamento de caixa?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa do operador que emitiu os cupons serão gerados movimentos de caixa.
#Independente se '''Gerar movimento de caixa para as vendas? = Sim''' ou '''Utiliza fechamento de caixa? = Sim''', ao gerar movimento de caixa será considerado:
#*Se a opção '''Para todas as vendas''' estiver marcada como '''Sim''', na conta caixa informada logo à sua direita será gerado o movimento de caixa com o valor total de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons.
#*Caso uma ou mais formas de pagamento esteja(m) marcada(s) como '''Sim''', na(s) conta(s) caixa informada(s) será(ão) gerado(s) movimento(s) de caixa com o(s) valor(es) da(s) respectiva(s) forma(s) de pagamento de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons. Se houver em um determinado cupom um forma de pagamento que está marcada nos parâmetros do PDV como '''Não''' e que não possui uma conta caixa informada, '''não será gerado movimento de caixa''' com o valor da mesma.

=== NFC-e ===
A sincronização entenderá que os procedimentos de NFC-e deverão ser realizados quando nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada, para o número de um determinado PDV/ECF, estiverem marcados os parâmetros '''OPERAÇÃO DO PAF = NFC-e''' e '''AMBIENTE NFC-e = Produção'''.

Uma vez que o sistema identificou que ao invés de cupom fiscal será sincronizada a NFC-e, o procedimento será o seguinte:
#Quando o ECF consumir o ''webservice'' de sincronização ao invés de popular o objeto '''DadosCupomDelphi''' com os dados do cupom a partir das tabelas VENDPDV e ENCERRA, ele deverá popular o objeto '''DadosNFCeDelphi''' com os dados do pedido da NFC-e (tabelas PEDIDOC e PEDIDOI), com os dados fiscais da mesma (tabelas NFSAIDI e NFSAIDC) e também com os dados eletrônicos complementares (tabela COMPLNFCE).
#Com o objeto '''DadosNFCeDelphi''' populado, será utilizada a classe '''MontaCupomFiscalImportacaoServiceImpl''' para preparar um objeto do tipo '''CupomFiscal''' e persisti-lo no banco de dados '''gravando no Resulth WEB o pedido da NFC-e exatamente na mesma estrutura onde é gravado o cupom fiscal'''.
#*O pedido da NFC-e deverá ser gravado no Resulth WEB com o mesmo código gerado pelo Delphi na tabela PEDIDOC.
#*Para NFC-e no atributo '''tipoCupom''' da classe '''CupomFiscal''' deverá ser informada a opção '''NFC-E'''. Este atributo foi criado para diferenciar o pedido da NFC-e do pedido do Cupom Fiscal e deverá ser criado com o valor padrão '''CUPOM_FISCAL''' para registros já existentes no banco de dados dos clientes.
#Em seguida deverá ser gerado um documento fiscal de saída para o pedido da NFC-e que fora gravado. Para isto poderá ser utilizada a classe '''PedidoNotaServiceImpl'''.
#Para preencher o documento fiscal o Resulth WEB '''não calculará nenhum imposto'''. Estes serão preenchidos a partir do XML da NFC-e que será sincronizado também. ''Para isto pode ser reaproveitado um recurso existente na importação de XML da nota de entrada, que preenche um objeto a partir de um arquivo XML que tenha a mesma estrutura da NF-e''.

== RN03 - Integração com controle de caixa/checkouts ==
Para vendas serem consideradas pelo controle de caixa, independente de sua origem, deverão ser observados:
*Caso de uso [[UC00066 - Abertura de caixa]].
*Caso de uso [[UC00067 - Controle de caixa]].
*Regra de negócio RN03 do caso de uso [[UC00064 - Parâmetros do PDV#Movimentação de caixa | UC00064 - Parâmetros do PDV]].
*Caso de uso [[UC00072 - Ponto de venda]].

=== Importação de PDV e OS para o ECF ===
Pedidos do tipo '''55''' e '''65''' importados para o ECF serão considerados pela rotina de controle de caixa '''descartando''' a existência do cupom fiscal uma vez que a geração do financeiro só pode ser realizada pelo PDV. Em outras palavras, OS´s e PDV´s serão considerados pelo controle de caixa normalmente (se o PDV for configurado para tal) independente deles terem sido importados para o ECF ou não.


Se o PDV gera financeiro, movimento no subcaixa do operador que possui caixa aberto será gerado pelo Resulth WEB.

=== Importação de DAV e venda direta no ECF ===
Partindo do pré-suposto que o DAV '''não''' movimenta estoque nem gera financeiro, após importado para o ECF o mesmo será tratado como uma venda direta ao sincronizar seu cupom com o Resulth WEB. Para vendas diretas no ECF o movimento de estoque e a geração do financeiro serão realizados quando os respectivos cupons forem sincronizados com o Resulth WEB.

Antes de cada venda direta ou a importação de um DAV, o sistema (ECF) deverá:
#'''Verificar se o retaguarda (Resulth WEB) utiliza fechamento de caixa:''' Na aba ''Faturamento'' dos parâmetros do PDV deverá ser verificado o estado do parâmetro '''Utiliza fechamento de caixa?'''. Se o parâmetro em questão estiver como '''Não''', os demais passos deverão ser ignorados e a venda direta ou importação do DAV procederá normalmente. Se o parâmetro estiver como '''Sim''', executar os próximos passos.
#'''Verificar se o caixa do operador foi/está aberto:''' Para que um determinado operador consiga vender ou importar DAV no ECF é necessário que seu caixa esteja aberto no retaguarda (Resulth WEB). Caso o caixa do operador não esteja aberto o sistema (ECF) deverá abortar a venda ou importação do DAV e emitir ao usuário uma mensagem de alerta com a não conformidade.
#*Caso '''não exista''' no retaguarda caixa aberto para o usuário/operador logado no ECF, exibir a mensagem: ''O sistema de retaguarda (Resulth WEB) está configurado para utilizar fechamento de caixa e não ha caixa aberto para o operador logado. Faça a abertura do caixa do operador em questão e tente novamente.''
#*Caso o caixa do usuário/operador já tenha sido '''fechado''', exibir a mensagem: ''O caixa do operador logado já foi fechado e portanto o mesmo não poderá realizar vendas.''

== RN04 - NFC-e ==
Em resumo a NFC-e será tratada/sincronizada como um cupom fiscal no Resulth WEB, ou seja, os dados de um pedido de NFC-e serão visualizados e considerados da mesma maneira que um pedido de cupom fiscal. O que irá diferenciar um pedido de cupom fiscal de um pedido de NFC-e no Resulth WEB será a existência de um documento fiscal (a NFC-e propriamente dita), que será criado para todas as NFC-e´s sincronizadas para o Resulth WEB e considerado também em rotinas fiscais como SPED e livros de saída.


No Resulth WEB o documento fiscal da NFC-e será contabilizado '''somente em rotinas/relatórios fiscais''', ou seja, '''não será possível visualizar ou manipular a NFC-e'''
'''em qualquer outra rotina do sistema'''. Para isto o usuário deverá utilizar os recursos do módulo ECF.


Todas as regras e validações já existentes para cupom fiscal '''deverão ser mantidas para NFC-e''', seja na venda direta ou na importação de pedido.

=== Visualização/Impressão do CUPOM/DANFE ===
Conforme citado acima, quaisquer operações pertinentes a NFC-e deverão ser realizadas no módulo ECF, inclusive a visualização ou impressão da DANFE. Em função disso nas rotinas do Resulth WEB onde hoje é gerado um ''preview'' do cupom fiscal, para NFC-e o procedimento será o seguinte:
#Na emissão de NFC-e, o módulo ECF deverá gravar em seu banco de dados o link para consulta da DANFE da NFC-e já com o respectivo HASH do QRCode. Note que o link de consulta da DANFE poderá variar de acordo com a UF onde a NFC-e foi emitida.
#Quando a NFC-e for sincronizada para o Resulth WEB, o ''webservice'' deverá transportar o link de acesso à DANFE para o atributo '''linkAcessoDANFE''' da classe '''DadosNFCeDelphi'''.
#Ao gravar o pedido da NFC-e no banco de dados do Resulth WEB o link de acesso à DANFE da NFC-e deverá ser gravado no atributo '''linkAcessoDanfeNFCe''' da classe '''CupomFiscal'''.
#Nas consultas do Resulth WEB onde hoje é exibido o ''preview'' do cupom, para NFC-e, quando usuário clicar no ícone será aberta uma nova aba no navegador com o link de consulta da DANFE.

==== Validações e regras de sincronização ====
#Somente serão sincronizadas para o Resulth WEB NFC-e´s cujo status junto a SEFAZ é '''Autorizada''' ou '''Cancelada'''.
#*A sincronização de NFC-e´s de status '''Cancelada''' deverá '''manter no sistema''' tanto o pedido quanto o documento fiscal de saída gerados no Resulth WEB para a NFC-e colocando sobre os mesmos a marca de '''cancelado'''. Para o pedido da NFC-e, deverão ser desfeitas as movimentações financeiras e de estoque caso existam.
#Caso nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada o ECF esteja configurado como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', para pedidos realizados no Resulth WEB que contenham produtos e serviços importados para o ECF, '''serão considerados somente produtos'''.

==== DadosNFCeDelphi ====
{|class="wikitable"
|'''Atributo da classe DadosNFCeDelphi''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO ||
|-
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-style="background-color:#DCDCDC"
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-
| dataSaida || NFSAIDC || DATASAIDA ||
|-style="background-color:#DCDCDC"
| horaSaida || NFSAIDC || HORASAIDA ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| numeroNFCe || COMPLNFCE || NUMNFCE ||
|-
| numeroPedidoNFCe || PEDIDOC || CODPEDIDO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| status || COMPLNFCE || STATUS ||
|-style="background-color:#DCDCDC"
| tipoAmbiente || COMPLNFCE || TIPOAMBIENTE ||
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| xmlNFCe || -- || -- || Utilizar informação que vem no ''webservice''.
|}

=== Equivalência dos dados de documento fiscal ===
==== Cabeçalho da NFC-e ====
{|class="wikitable"
|'''Atributo da classe DocumentoSaida extends DocumentoFiscal''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| filial || NFSAIDC || CODEMPRESA || Código da filial do ECF correspondente a uma filial do Resulth WEB
|-
| pessoa || NFSAIDC || CODCLIENTE ||
|-style="background-color:#DCDCDC"
| numero || NFSAIDC || NUMNF ||
|-
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| modeloNotaFiscal || -- || -- || Utilizar modelo 65, ou seja, '''''NFC-e - Nota Fiscal Eletrônica ao Consumidor Final'''''
|-style="background-color:#DCDCDC"
| especieNotaFiscal || -- || -- || Utilizar o modelo '''NFC-e, //Nota Fiscal Eletrônica ao Consumidor Final'''
|-
| observacaoLivrosFiscais || NFSAIDC || OBSLIVROFISCAL ||
|-style="background-color:#DCDCDC"
| pagamento || -- || -- || Será gerado se no encerramento da NFC-e foi gerado contas a receber ou parcelas avulsas.
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| observacao || NFSAIDC || OBSERVACAO ||
|-
| numDocOrig || -- || -- || Armazena os documentos a receber gerados caso existam.
|-style="background-color:#DCDCDC"
| transportador || NFSAIDC || CODTRANSPT ||
|-
| notaFiscalEletronica || -- || -- ||
|-style="background-color:#DCDCDC"
| portalFiscalPrefeitura || -- || -- ||
|-
| pagamentosRetencoes || -- || -- ||
|-style="background-color:#DCDCDC"
| operacao || -- || -- ||
|-
| itens || NFSAIDI || -- || Ver tabela '''Itens da NFC-e'''.
|-style="background-color:#DCDCDC"
| dataSaida || NFSAIDC || DATASAIDA ||
|-
| horaSaida || NFSAIDC || HORASAIDA ||
|-style="background-color:#DCDCDC"
| cancelada || NFSAIDC || CANCELADO ||
|-
| notaManual || -- || -- ||
|-style="background-color:#DCDCDC"
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-
| pedidos || -- || -- || Utilizar o '''''CupomFiscal -> DoctoPedidoDevolucao''''' gerado na sincronização do pedido NFC-e para o Resulth WEB.
|-style="background-color:#DCDCDC"
| encerramento || -- || -- || Não gerar. O encerramento ficará na '''''CupomFiscal -> DoctoPedidoDevolucao'''''.
|-
| notasRetencaoPisCofinsCsll || -- || -- ||
|-style="background-color:#DCDCDC"
| pisCofinsCsllRetidoFonte || -- || -- ||
|-
| idNotaAdevolver || -- || -- ||
|}

==== Itens da NFC-e ====
{|class="wikitable"
|'''Atributo da classe ItemNota''' || '''TABELA BD ECF/Tag XML NFCe''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| nota|| -- || -- || Utilizar objeto gerado para o cabeçalho da NFC-e.
|-
| item || NFSAIDI || CODPROD ||
|-style="background-color:#DCDCDC"
| grade || NFSAIDI || CODGRADE || Irrelevante, pois o ''webservice'' de sincronização irá devolver o ID do RrelacionamentoGrade.
|-
| sequencia || -- || -- || Gerado automaticamente para notas digitadas.
|-style="background-color:#DCDCDC"
| cfop || <prod> || CFOP ||
|-
| quantidade || <prod> || qCom ||
|-style="background-color:#DCDCDC"
| quantidadeConvertida || -- || -- ||
|-
| unidade || <prod> || uCom ||
|-style="background-color:#DCDCDC"
| preco || <prod> || vUnCom ||
|-
| precoConvertido || -- || -- ||
|-style="background-color:#DCDCDC"
| iss || <ISSQN> ||
*vBC (Valor da Base de Cálculo do ISSQN)
*vAliq (Alíquota do ISSQN)
*vISSQN (Valor do ISSQN)
|| Inicialmente, a NFC-e (no ECF) '''não irá conter serviços'''.
|-
| ipi || <IPI> ||
*vBC (Valor da BC do IPI)
*pIPI (Alíquota do IPI)
*vIPI (Valor do IPI)
||
|-style="background-color:#DCDCDC"
| icm || <ICMSXX> ||
*vBC (Valor da BC do ICMS)
*pICMS (Alíquota do imposto)
*vICMS (Valor do ICMS)
|| Lembrando que o ''XX'' ao fim do nome da ''Tag'' do XML refere-se aos dois últimos dígitos do CST correspondente. Exemplo: ''<ICMS10> está para CST´s terminados em 10''; ''<ICMS20> está para CST´s terminados em 20''.
|-
| st || <ICMSXX> ||
*vBCST (Valor da BC do ICMS ST)
*pICMSST (Alíquota do imposto do ICMS ST)
*vICMSST (Valor do ICMS ST)
|| Lembrando que o ''XX'' ao fim do nome da ''Tag'' do XML refere-se aos dois últimos dígitos do CST correspondente. Exemplo: ''<ICMS10> está para CST´s terminados em 10''; ''<ICMS20> está para CST´s terminados em 20''.
|-style="background-color:#DCDCDC"
| stForaNF || -- || -- ||
|-
| pis || <PIS> ||
*vBC (Valor da Base de Cálculo do PIS)
*pPIS (Alíquota do PIS (em percentual)
*vPIS (Valor do PIS)
||
|-style="background-color:#DCDCDC"
| cofins || <COFINS> ||
*vBC (Valor da Base de Cálculo da COFINS)
*pCOFINS (Alíquota da COFINS (em percentual))
*vCOFINS (Valor da COFINS)
||
|-
| aproveitamentoCredito || -- || -- ||
|-style="background-color:#DCDCDC"
| descontoItem || <prod> || vDesc ||
|-
| totalItem || NFSAIDI || QUANTIDADE * PRECOUNIT ||
|-style="background-color:#DCDCDC"
| totalRateado || NFSAIDI || TOTALRATEADO ||
|-
| cst || NFSAIDI || CODTRIBUT ||
|-style="background-color:#DCDCDC"
| csosn || <ICMSSNXXX> ||
*CSOSN
|| Lembrando que o ''XXX'' ao fim do nome da ''Tag'' do XML refere-se aos três últimos dígitos do CSOSN correspondente. Exemplo: ''<ICMSSN101> está para CSOSN´s terminados em 101''; ''<ICMSSN102> está para CSOSN´s terminados em 102''.
|-
| rateio || -- || -- ||
|-style="background-color:#DCDCDC"
| seriaisDigitados || CONTSER || ||
|-
| lotesDigitados || -- || -- ||
|-style="background-color:#DCDCDC"
| itensNotaEntradaSerial || -- || -- ||
|-
| itensNotaEntradaLote || -- || -- ||
|-style="background-color:#DCDCDC"
| complemento || -- || -- ||
|-
| original || -- || -- ||
|-style="background-color:#DCDCDC"
| itemBonificado || -- || -- ||
|}

==== Dados eletrônicos da NFC-e ====
{|class="wikitable"
|'''Atributo da classe NotaFiscalEletronica''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| tipoNotaEletronica || -- || -- || Utilizar a opção '''NFC-e'''.
|-
| ambiente || -- || -- || Uma vez que serão sincronizadas somente NFC-e´s emitidas em ambiente de produção, utilizar a opção '''PRODUÇÃO'''.
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO || '''Alterar o tamanho deste campo''' no banco do Resulth WEB de 44 para 50.
|-
| codigoStatus || COMPLNFCE || STATUSPROC || Se neste campo estiver vazio ou nulo, utilizar a informação do campo '''STATUS''' da mesma tabela.
|-style="background-color:#DCDCDC"
| status || -- || -- || A descrição referente ao stauts informado no campo '''codigoStatus''' deverá ser passada para o ''webservice'' de sincronização em tempo de execução, uma vez que estas informações não ficam salvas no banco de dados, mas dentro do próprio código fonte do Delphi na ''unit'' '''GerarXMLNFe'''. Atenção para qual status será preenchido, levando em consideração que temos ''Status da ComplNFe'' e ''CÓDIGO RESULTADO DO PROCESSAMENTO DA SOLICITACAO (retorno SEFAZ)''
|-
| recibo || COMPLNFCE || RECEBIMENTOXML ||
|-style="background-color:#DCDCDC"
| dataHoraRecibo || COMPLNFCE || DATAHORAPROTOCOLO ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| statusInterno || -- || -- ||
|-
| enviouCartaCorrecao || -- || -- || Utilizar padrão '''''false'''''.
|-style="background-color:#DCDCDC"
| imprimiuDanfe || COMPLNFCE || IMPDANFE || S = true; N = false.
|-
| enviouEmail || -- || -- ||
|-style="background-color:#DCDCDC"
| falhaComunicacao || -- || -- ||
|-
| statusDisponibilizacao || -- || -- ||
|-style="background-color:#DCDCDC"
| nfse || -- || -- ||
|-
| xmlNFCe || -- || -- || Popular este objeto a partir das informações do atributo '''xmlNFCe''' da classe '''DadosNFCeDelphi'''.
|-style="background-color:#DCDCDC"
| xmlNFe || -- || -- ||
|-
| xmlNFSe || -- || -- ||
|-style="background-color:#DCDCDC"
| cartaCorrecao ||| -- || -- ||
|}

UC00089 - Consulta de faturamento por pedido

2015-04-20T14:27:01Z

Daniel: /* RN02 - Grid da consulta */

= Módulos/Sistemas =
*Resulth WEB Start
*Resulth WEB Business
*Resulth WEB ERP
*Resulth WEB Telefonia

= Objetivo =
*Consultar/exibir de forma sintética e analítica dados referentes ao faturamento.

= Atores =
*Usuário

= Pré-requisitos =
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta de faturamento por pedido'''. Este nome será utilizado para criar a página no Wiki
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =
Consultar vendas exibindo resultados com base nos diversos filtros disponíveis possibilitando ao usuário imprimi-los em diferentes visões/formatos e também gerar gráficos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina ''Menu > Consultas > Faturamento > Faturamento por pedido.''.
*Sistema exibe a tela inicial da rotina com a aba de filtragem aberta posicionando o foco no primeiro campo (filiais).

'''Fluxo 2:''' Usuário informa os filtros desejados e aciona o botão <Consultar>.
*Sistema verifica se existem movimentos pertinentes aos filtros utilizados.
*Se forem encontrados registros de vendas, sistema os exibe no grid.
*Se nenhum movimento for encontrado, sistema exibe informa ao usuário que de acordo com os filtros utilizados nenhum dado foi encontrado.

'''Fluxo 3:''' Com os resultados da consulta listados no grid, usuário clica sobre os ícones PDV, DAV, ECF ou NF.
*Sistema exibe o registro de venda referente ao ícone acionado.

'''Fluxo 4:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário seleciona no combobox o tipo de visão da consulta que deseja imprimir e em seguida aciona o botão <Imprimir> escolhendo o formato desejado.
*Sistema procede conforme regra de negócio [[#RN03 - Tipos/Visões de impressão da consulta | RN03]].

'''Fluxo 5:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário aciona o botão <Gerar gráfico>.
*Sistema procede conforme regra de negócio [[#RN04 - Graficos | RN04]].

== Fluxos alternativos ==
'''Fluxo 1:''' Ao acessar a rotina em questão usuário clica diretamente no botão [Consultar].
*Uma vez que por padrão a filial logada é selecionada e o período é preenchido com o mês corrente (com base na data de login), sistema filtra as vendas com base nestes dados e lista os resultados no grid caso existam.

'''Fluxo 2:''' Usuário acessa a rotina em questão e informa no filtro '''Operação''' uma determinada operação de saída.
*Sistema faz a consulta de todos os pedidos cuja operação corresponde a que foi informada no filtro, independente se o parâmetro '''Considerar em vendas''' está marcado '''ou não''' em seu cadastro.

'''Fluxo 3:''' Utilizando o módulo de '''telefonia''' o usuário acessa a rotina em questão, faz a filtragem dos dados optando por imprimi-los em seguida.
*Na filtragem, sistema procede conforme [[#RN01 - Filtragem dos dados | RN01]].
*Na impressão dos dados, sistema procede conforme [[#Telefonia | RN03]].

'''Fluxo 4:''' Tendo seu PAF configurado para emitir NFC-e e com NFC-e´s já emitidas por venda direta ou por importação de pedidos o usuário acessa a rotina em questão e informa filtros que listem no grid pedidos do tipo 56.
*O sistema irá listar pedidos de NFC-e exatamente da mesma forma como lista pedidos de cupons fiscais.
*Quando o ícone da coluna ECF for acionado em pedidos de NFC-e, o sistema irá apresentar em uma nova aba do navegador a DANFE da NFC-e, conforme item 3 da regra de negócio [[#RN02 - Grid da consulta | RN02]].

== Fluxos de exceções ==
'''Fluxo 1:''' Sem filtrar nenhum dado usuário fecha a aba de consulta e tenta clicar sobre os botões que geram gráfico e impressão.
*Enquanto o grid que exibe os resultados da consulta estiver vazio, sistema mantem os botões que geram gráfico e impressão desabilitados.
*Caso usuário posicione o mouse sobre estes botões, o seguinte ''hint'' será exibido: ''Este botão ficará ativo somente quando houver registros listados no grid.''

= Regras de negócio =
== RN01 - Filtragem dos dados ==
A filtragem dos dados será dividida em dois níveis. O primeiro nível, que será de preenchimento obrigatório, apresentará filtros essenciais para a busca dos dados. O segundo nível, que será opcional, apresentará filtros adicionais que permitirá uma melhor filtragem, organização e exibição dos dados.

Para os filtros de segundo nível o sistema deverá exibir apenas o nome da categoria dos mesmos. Quando usuário clicar sobe o nome de um determinado filtro, então o sistema renderizará os campos pertinentes ao mesmo. Após preencher os campos o usuário poderá oculta-los clicando novamente sobre o nome do filtro.

Uma vez que a rotina em questão atende a vários módulos serão destacados mais abaixo os filtros que são exclusivos de um determinado módulo. Os demais filtros que não estão destacados serão accessíveis em todos os módulos.


É importante ressaltar que um filtro '''não deverá anular o outro'''.

Primeiro nível:
#'''Filiais:''' Com a filial logada marcada como padrão e exibindo as demais filiais cujo usuário logado possui acesso conforme [[Padrões de desenvolvimento]].
#'''Período:''' Campo onde deverá ser informado um período de emissão ou de faturamento dependendo do tipo de período que o usuário optar. O usuário poderá informar também, mais de um período para filtrar as movimentações adicionando vários intervalos na lista do filtro. Por exemplo: ''O usuário pode filtrar as vendas realizadas em "01/12/2012 a 31/12/2012" e também as vendas realizadas em "01/12/2013 a 31/12/2013", com o intuito de comparar um período com o outro.''
#'''Usuário:''' Campo onde poderá ser selecionado um usuário dentre os cadastrados e ativos no sistema para filtrar somente vendas realizadas pelo mesmo.

Segundo nível:
#'''Dados do pedido'''
#*'''Somente faturados?''' Neste campo o usuário poderá optar por visualizar todos os pedidos (desmarcado) ou somente pedidos faturados (marcado).
#*'''Tipo de pedido:''' Neste filtro o usuário poderá filtrar suas vendas por tipo de pedido, selecionando os desejados. As opções serão:
#** '''51 - NF de saída''' para notas fiscais de saída.
#**'''55 - PDV''' para pedidos realizados no ponto de venda.
#**'''56 - CUPOM/NFC-e''' para cupons fiscais ou NFC-e´s realizadas no módulo ECF.
#*'''Tabela de preço:''' No caso de pedidos do tipo 55 (PDV) será possível filtra-los através da tabela de preço utilizada (seja no cabeçalho ou por item). Neste campo só poderão ser exibidas tabelas de preço que em seu cadastro estejam configuradas para ser utilizadas com as filiais selecionadas no filtro '''Filiais'''. Este filtro só poderá ser utilizado caso no filtro '''Tipo de pedido''' esteja selecionado o tipo ''55''.
#*'''Vendedor:''' Neste campo poderão ser filtradas vendas de um determinado vendedor apenas.
#*'''Data de entrega:''' Neste campo as vendas poderão ser filtradas por data de entrega (caso possuam), seja a data por pedido ou por item.
#*'''Hora:''' Neste campo o usuário poderá filtrar pedidos realizados em uma determinada faixa de horário.
#*'''Operador de caixa:''' Neste campo o usuário poderá filtrar vendas realizadas por um determinado operador de caixa. Este filtro só vai aparecer caso o usuário tenha fechamento de caixa, configurado no PDV, aba "Faturamento".
#*'''Operação:''' Este filtro permitirá ao usuário selecionar uma '''operação de saída''' específica para a filtragem dos pedidos. É importante ressaltar que, quando utilizado o filtro em questão, serão listados na consulta '''todos''' os pedidos emitidos com a operação selecionada '''independente''' se o parâmetro '''Considerar em vendas''' está ativado '''ou não''' em seu cadastro. À direita do filtro deverá ser exibido o texto: ''Lista pedidos cuja operação '''não''' considera em vendas''.
#*'''Faturamento:''' Campo onde o usuário poderá filtrar pedidos do tipo 51 e 55 pela forma em que foram faturados com as seguintes opções:
#**'''Todos:''' Opção padrão que '''não''' filtra pedidos por uma determinada forma de pagamento, neste caso todas as formas de pagamento serão consideradas.
#**'''Dinheiro:''' Traz pedidos que contenham em seu faturamento a forma de pagamento '''Dinheiro'''.
#**'''Cartão:''' Com esta opção selecionada o sistema considerará pedidos que contenham em seu faturamento a forma de pagamento '''Cartão'''. Caso esta opção seja selecionada serão exibidos à direita do campo '''Faturamento''' outros dois ''comboboxes'' conforme segue abaixo:
#**#'''Cartão:''' Campo onde serão listadas as administradoras de cartão cadastradas e ativas no sistema.
#**#'''Plano:''' Habilitado somente após o cartão ser selecionado, este campo listará os planos de financeira ativos e vinculados ao cartão em questão.
#**'''Cheque:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Cheque'''.
#**'''Receber:''' Com esta opção selecionada o sistema considerará todos pedidos que contenham em seu faturamento a forma de pagamento '''Receber'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o ''combobox'' '''Prazo''', que listará as formas de pagamento cadastradas caso usuário deseje filtrar pedidos cujo receber foi gerar com uma delas. Parcelas avulsas '''não''' serão consideradas no ''combobox'' '''Prazo''', e se o mesmo for deixado em branco na filtragem de pedidos cujo faturamento contem a forma de pagamento '''Receber''' serão considerados todos os prazos e também as parcelas avulsas.
#**'''Crédito:''' Traz todos os pedidos que contenham em seu faturamento a forma de pagamento '''Crédito'''.
#**'''Convênio:''' Com esta opção selecionada o sistema considerará todos os pedidos que contenham em seu faturamento a forma de pagamento '''Convênio'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o combobox '''Bandeira''', que listará todos os convênios cadastrados e ativos caso usuário deseje filtrar pedidos cujo faturamento utilizou convênio de uma bandeira específica. Se o ''combobox'' '''Bandeira''' for deixado em branco, na filtragem de pedidos cujo faturamento contém convênio serão consideradas todas as bandeiras.
#**'''Depósito:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Depósito'''.
#'''Dados do cliente'''
#*'''Cliente:''' Neste campo o usuário poderá filtrar vendas realizadas para um determinado cliente.
#*'''Segmento:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de um determinado segmento.
#*'''Classificação:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de uma determinada classificação.
#*'''Rota:''' Neste campo o usuário poderá filtrar vendas para todos clientes de uma determinada rota.
#*'''Região (Estado e cidade):''' Nestes campos pedidos poderão ser filtrados por região, onde de acordo com os dados informados, serão considerados o estado e a cidade dos clientes dos pedidos.
#'''Dados do item'''
#*'''Item:''' Neste campo o usuário poderá informar um determinado item (produto ou serviço) cujas vendas deseja visualizar. Ou seja, se informado, só listar as vendas que tiveram este item informado (mesmo que tenha outros).
#*'''Telefonia:''' Conjunto de filtros que estarão dentro do agrupamento '''Dados do item''', mas que serão visíveis somente quando o módulo utilizado for de telefonia.
#**Tabela de preço
#**Tipo de preço
#**Promoção

== RN02 - Grid da consulta ==
O grid deverá exibir dados que sejam coerentes com os filtros utilizados nas seguintes colunas:
#'''PDV:''' Caso registro listado no grid possua um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''DAV:''' Caso registro listado seja um DAV, será exibido um ícone (D) que quando acionado exibirá na tela a visualização do mesmo. Ao lado do ícone será exibido o número do DAV.
#'''ECF/NFC-e:''' Caso registro listado possua um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso registro listado possua nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.
#'''FILIAL:''' Filial em que a venda foi realizada (apenas código).
#'''TOTAL DA VENDA:''' Exibe o valor total do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''DATA DA VENDA:''' Mostra a data de faturamento do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''CLIENTE:''' Coluna onde será exibido o código+nome do cliente da venda.
#'''VENDEDOR:''' Código+nome do vendedor do pedido.
#'''TABELA DE PREÇO:''' Tabela de preço utilizada na venda (do cabeçalho).

Na 1ª à 4ª coluna do grid, a venda cujo tipo de operação possuir marcado o parâmetro '''Considerar em vendas'''
deverá ter seu número exibido em '''negrito'''.

Na parte superior do grid, na linha acima aos títulos das colunas deverão estar disponíveis as seguintes configurações:
#'''Tipo de visão ao imprimir:''' Determina a formatação e diagramação dos dados do relatório ao imprimir com as seguintes variações:
#*Faturamento analítico
#*Faturamento sintético
#*Somatório de vendas
#*Vendas por hora
#*Vendas por operador
#*Resumo diário
#*Vendas por grupo
#'''Gerar gráfico:''' Botão que quando acionado gera um gráfico com os registros filtrados.
#'''Imprimir:''' Botão que gera impressão dos registros filtrados.

== RN03 - Tipos/Visões de impressão da consulta ==
A consulta em questão possibilitará ao usuário gerar diferentes visões/impressões para os dados filtrados, com diferentes informações e formatações conforme descrito abaixo.


É importante ressaltar que todos os relatórios deverão ser implementados seguindo os padrões do sistema.
Os layouts/modelos deste documento tem como objetivo demonstrar os dados e diagramação de cada visão.

#'''Visão ''Faturamento sintético'':''' A visão de faturamento sintética consiste em exibir de forma mais sintética os dados dos pedidos agrupados e totalizados por filial com o total geral ao fim do relatório.
#'''Visão ''Faturamento analítico'':''' A visão de faturamento analítica tem o objetivo de detalhar cada pedido exibindo para os mesmos dados de cabeçalho e detalhamento dos itens. Cada pedido terá seu total bruto e líquido e ao final do relatório haverá um total geral.
#'''Visão ''Somatório de vendas'':''' A visão de somatória de vendas tem como objetivo detalhar e totalizar vendas por forma de pagamento, exibindo o cliente e o vendedor de cada pedido. Ao final do relatório é exibido o total geral, a quantidade de pedidos e a totalização das vendas por convênio/plano.
#'''Visão ''Vendas por hora'':''' A visão de vendas por hora tem como objetivo exibir, no período filtrado, a quantidade e o valor total dos pedidos agrupados por dia e hora. Ao final do resumo de cada dia será exibido o total do dia, o total das devoluções do dia, o saldo final do dia e também o total de pedidos daquele dia.
#'''Visão ''Vendas por operador'':''' A visão de vendas por operador consiste em exibir os itens vendidos pelos operadores detalhando por item a quantidade, preço médio de venda e total da venda. O relatório totalizará os dados por operador e também exibirá um total geral. Esta visão somente estará disponível caso na filtragem o campo '''Operador''' esteja habilitado.
#'''Visão ''Resumo diário'':''' A visão de resumo diário tem como objetivo totalizar as vendas por dia de acordo com período filtrado. Ao final será exibido um total geral.
#'''Visão ''Vendas por grupo'':''' A visão de vendas por grupo tem como objetivo agrupar e totalizar vendas por grupo e subgrupo, exibindo para cada grupo a quantidade vendida e a venda, em valor e em percentual. Ao final de cada agrupamento será apresentado um totalizador e ao final do relatório será apresentado um totalizador geral.
<gallery>
File:RelFatPedVisaoFaturamento.png|Visão '''''Faturamento sintético'''''
File:RelFatPedVisaoFaturamentoAnalitico.png|Visão '''Faturamento analítico'''
File:RelFatPedVisaoOperador.png|Visão '''''Vendas por operador'''
File:RelFatPedVisaoSomatoria.png|Visão '''''Somatório de vendas'''
File:RelFatPedVisaoVendasHora.jpg|Visão '''''Vendas por hora'''
File:RelFatPedVisaoResumoDiario.jpg|Visão '''''Resumo diário'''''
File:RelFatPedVisaoVendasGrupo.jpg|Visão '''''Vendas por grupo'''
</gallery>


O combobox que permite ao usuário selecionar o tipo de visão para impressão somente será habilitado após os resultados
da consulta serem listados no grid.


Quando a impressão dos dados resultar em mais de 1 página, independente da visão escolhida, os títulos/cabeçalhos das colunas deverão ser replicados em cada página gerada.

=== Telefonia ===
Para o módulo de telefonia as visões de ''Faturamento'' analítica e sintética terão diagramações diferenciadas (conforme respectivos layouts mais abaixo) onde:
*'''Faturamento sintético''' -> Equivalente ao ''antigo relatório de somatório de vendas resumido''.
*'''Faturamento analítico''' -> Equivalente ao ''antigo relatório de somatório de vendas detalhado''.


Os pedidos ou itens devolvidos deverão ser destacados na cor vermelha em ambas as visões citadas acima.

<gallery>
File:RelFatPedVisaoFaturamentoSinteticoTelefonia.png|Visão '''''Faturamento sintético Telefonia'''''
File:RelFatPedVisaoFaturamentoAnaliticoTelefonia.png|Visão '''''Faturamento analítico Telefonia'''''
</gallery>

Ainda, exclusivamente para o módulo de telefonia, em todas as visões de impressão disponíveis deverão ser adicionadas ao final do relatório páginas com totalizadores exclusivos do segmento de telefonia conforme segue abaixo:
*'''Total de vendas:''' Exibirá informações sobre os totais vendidos com os seguintes dados:
*#'''QUANTIDADE DE PEDIDOS:''' Quantidade de pedidos encontrados/considerados com base nos filtros informados.
*#'''TOTAL DE VENDAS:''' Somatória do valor total de cada venda considerada na filtragem dos dados. Lembrando que este é o total líquido, já considerando descontos, acréscimos, devoluções e etc.
*#'''DESCONTOS DA OPERADORA:''' Somatória dos valores de descontos de operadora informados nos itens dos pedidos considerados na filtragem.
*#'''DESCONTOS ITENS/GLOBAL:''' Somatória dos valores de descontos informados nos itens e/ou na finalização dos pedidos considerados na filtragem.
*#'''TOTAL DE TROCAS:''' Somatória das formas de pagamento do tipo ''troca'' existentes nos pedidos considerados na filtragem.
*#'''TOTAL DE DEVOLUÇÕES:''' Somatória dos pedidos e/ou itens que constam em notas fiscais de devolução.
*#'''CRÉD. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de créditos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''DÉB. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de débitos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''TOTAL GERAL:''' Exibe o total geral do período filtrado considerando os totalizadores acima na seguinte formula: '''''total de vendas + créditos avulsos no caixa - débitos avulsos no caixa - total de devoluções'''''.
*'''Lançamentos avulsos no caixa:''' Exibirá informações detalhadas sobre lançamentos avulsos de caixa realizados no período da filtragem nas seguintes colunas:
*#'''CONTA CAIXA:''' Conta onde o lançamento foi realizado.
*#'''DÉBITO/CRÉDITO:''' Informa se o lançamento foi de DÉBITO ou CRÉDITO.
*#'''SUBCAIXA:''' Informa o subcaixa utilizado no movimento de caixa.
*#'''DATA:''' Data em que o movimento de caixa foi realizado.
*#'''VALOR:''' Valor do movimento de caixa.
*'''Totais por forma de pagamento:''' Com base nos pedidos encontrados na consulta, exibira o total geral por forma de pagamento, ou seja:
*#'''DINHEIRO
*#'''CARTÃO:''' Este totalizador será dividido em '''mestre''', '''detalhe''' e '''sub-detalhe''' onde:
*#*'''Mestre:''' Exibe o total geral de '''todas''' as administradoras de cartão utilizadas.
*#*'''Detalhe:''' Exibe o total de cada administradora de cartão utilizada nos pedidos listados.
*#*'''Sub-detalhe:''' Exibe, para cada administradora listada no detalhe, o total por plano de financeira.
*#'''CHEQUE'''
*#'''RECEBER'''
*#'''CRÉDITO APROVEITADO'''
*#'''CRÉDITO GERADO:''' Este totalizador considera créditos gerados nos pedidos e também na devolução dos mesmos.
*#'''CONVÊNIO'''
*#'''DEPÓSITO'''
*#'''TROCA'''
*'''Vendas por grupo/subgrupo:''' Exibirá o total de vendas divido por grupo e subgrupo, sendo que os subgrupos ficarão agrupados dentro de seu respectivo grupo.
*'''Totais por serviço:''' Todos os serviços utilizados nos pedidos considerados na consulta serão agrupados e totalizados. Na listagem dos serviços o sistema fará o seguinte agrupamento:
*#'''Serviços da operadora:''' Serviços oficiais da operadora.
*#'''Serviços do lojista:''' Serviços cadastrados pelo próprio lojista.
*'''Unidades vendidas:''' Todos os produtos utilizados nos pedidos considerados na consulta serão agrupados e totalizados e listados nesta seção.
*'''Totais por plano/operação:''' Todos os planos e operações utilizados nos itens das vendas consideradas na consulta serão agrupados, totalizados e listados nas seguintes colunas:
*#'''PLANO'''
*#'''OPERAÇÃO'''
*#'''QTDE:''' Quantidade de ocorrências deste plano + operação dentre os pedidos listados na consulta.
*#'''VALOR'''

== RN04 - Graficos ==
Serão elegíveis para geração de gráficos as seguintes visões:
*Somatório de vendas
*Vendas por hora
*Resumo diário

Quando usuário acionar o botão que gera gráficos, o sistema deverá gerar uma mesma janela (pop-up) os gráficos citados acima permitindo que o usuário alterne entre os mesmos. Os gráficos deverão seguir os modelos sugeridos abaixo:
<gallery>
File:GraficoSomatoria.jpg|'''''Somatória de vendas'''''
File:GraficoVendasHora.jpg|'''''Vendas por hora'''''
File:GraficoResumoDiario.jpg|'''''Resumo diário'''''
</gallery>

== RN05 - Devoluções/Trocas ==
'''Devoluções''' deverão ser automaticamente deduzidas caso existam dentre os dados filtrados. No grid, estas deverão ser exibidas, na data em que foram realizadas, com a linha na cor vermelha e com valores negativos.

Pedidos que possuírem a forma de pagamento '''troca''' serão exibidos no grid na cor vermelha e com os valores normais do pedido.

Na visão '''Faturamento sintético''' a exibição de trocas e devoluções será semelhante à do grid, mostrando uma linha na cor vermelha com a devolução tendo valores negativos.

Na visão '''Faturamento analítico''' as devoluções e trocas deverão ser exibidas em forma de pedido com seus dados na cor vermelha logo abaixo de seu pedido de origem. No canto superior direito do pedido deverá haver um campo informando que o mesmo trata-se de uma devolução.

Na visão '''Vendas por operador''' as devoluções e trocas não serão exibidas. As vendas que possuem devolução simplesmente não serão consideradas (no caso de devolução total).

Na visão '''Somatório de vendas''' o valor das devoluções e trocas serão exibidos na respectiva coluna.

Nas visões '''Vendas por hora''', '''Resumo diário''' e '''Vendas por grupo''' trocas e devoluções não serão exibidas, mas seus valores serão deduzidos.

UC00089 - Consulta de faturamento por pedido

2015-04-20T14:26:24Z

Daniel: /* RN01 - Filtragem dos dados */

= Módulos/Sistemas =
*Resulth WEB Start
*Resulth WEB Business
*Resulth WEB ERP
*Resulth WEB Telefonia

= Objetivo =
*Consultar/exibir de forma sintética e analítica dados referentes ao faturamento.

= Atores =
*Usuário

= Pré-requisitos =
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta de faturamento por pedido'''. Este nome será utilizado para criar a página no Wiki
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =
Consultar vendas exibindo resultados com base nos diversos filtros disponíveis possibilitando ao usuário imprimi-los em diferentes visões/formatos e também gerar gráficos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina ''Menu > Consultas > Faturamento > Faturamento por pedido.''.
*Sistema exibe a tela inicial da rotina com a aba de filtragem aberta posicionando o foco no primeiro campo (filiais).

'''Fluxo 2:''' Usuário informa os filtros desejados e aciona o botão <Consultar>.
*Sistema verifica se existem movimentos pertinentes aos filtros utilizados.
*Se forem encontrados registros de vendas, sistema os exibe no grid.
*Se nenhum movimento for encontrado, sistema exibe informa ao usuário que de acordo com os filtros utilizados nenhum dado foi encontrado.

'''Fluxo 3:''' Com os resultados da consulta listados no grid, usuário clica sobre os ícones PDV, DAV, ECF ou NF.
*Sistema exibe o registro de venda referente ao ícone acionado.

'''Fluxo 4:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário seleciona no combobox o tipo de visão da consulta que deseja imprimir e em seguida aciona o botão <Imprimir> escolhendo o formato desejado.
*Sistema procede conforme regra de negócio [[#RN03 - Tipos/Visões de impressão da consulta | RN03]].

'''Fluxo 5:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário aciona o botão <Gerar gráfico>.
*Sistema procede conforme regra de negócio [[#RN04 - Graficos | RN04]].

== Fluxos alternativos ==
'''Fluxo 1:''' Ao acessar a rotina em questão usuário clica diretamente no botão [Consultar].
*Uma vez que por padrão a filial logada é selecionada e o período é preenchido com o mês corrente (com base na data de login), sistema filtra as vendas com base nestes dados e lista os resultados no grid caso existam.

'''Fluxo 2:''' Usuário acessa a rotina em questão e informa no filtro '''Operação''' uma determinada operação de saída.
*Sistema faz a consulta de todos os pedidos cuja operação corresponde a que foi informada no filtro, independente se o parâmetro '''Considerar em vendas''' está marcado '''ou não''' em seu cadastro.

'''Fluxo 3:''' Utilizando o módulo de '''telefonia''' o usuário acessa a rotina em questão, faz a filtragem dos dados optando por imprimi-los em seguida.
*Na filtragem, sistema procede conforme [[#RN01 - Filtragem dos dados | RN01]].
*Na impressão dos dados, sistema procede conforme [[#Telefonia | RN03]].

'''Fluxo 4:''' Tendo seu PAF configurado para emitir NFC-e e com NFC-e´s já emitidas por venda direta ou por importação de pedidos o usuário acessa a rotina em questão e informa filtros que listem no grid pedidos do tipo 56.
*O sistema irá listar pedidos de NFC-e exatamente da mesma forma como lista pedidos de cupons fiscais.
*Quando o ícone da coluna ECF for acionado em pedidos de NFC-e, o sistema irá apresentar em uma nova aba do navegador a DANFE da NFC-e, conforme item 3 da regra de negócio [[#RN02 - Grid da consulta | RN02]].

== Fluxos de exceções ==
'''Fluxo 1:''' Sem filtrar nenhum dado usuário fecha a aba de consulta e tenta clicar sobre os botões que geram gráfico e impressão.
*Enquanto o grid que exibe os resultados da consulta estiver vazio, sistema mantem os botões que geram gráfico e impressão desabilitados.
*Caso usuário posicione o mouse sobre estes botões, o seguinte ''hint'' será exibido: ''Este botão ficará ativo somente quando houver registros listados no grid.''

= Regras de negócio =
== RN01 - Filtragem dos dados ==
A filtragem dos dados será dividida em dois níveis. O primeiro nível, que será de preenchimento obrigatório, apresentará filtros essenciais para a busca dos dados. O segundo nível, que será opcional, apresentará filtros adicionais que permitirá uma melhor filtragem, organização e exibição dos dados.

Para os filtros de segundo nível o sistema deverá exibir apenas o nome da categoria dos mesmos. Quando usuário clicar sobe o nome de um determinado filtro, então o sistema renderizará os campos pertinentes ao mesmo. Após preencher os campos o usuário poderá oculta-los clicando novamente sobre o nome do filtro.

Uma vez que a rotina em questão atende a vários módulos serão destacados mais abaixo os filtros que são exclusivos de um determinado módulo. Os demais filtros que não estão destacados serão accessíveis em todos os módulos.


É importante ressaltar que um filtro '''não deverá anular o outro'''.

Primeiro nível:
#'''Filiais:''' Com a filial logada marcada como padrão e exibindo as demais filiais cujo usuário logado possui acesso conforme [[Padrões de desenvolvimento]].
#'''Período:''' Campo onde deverá ser informado um período de emissão ou de faturamento dependendo do tipo de período que o usuário optar. O usuário poderá informar também, mais de um período para filtrar as movimentações adicionando vários intervalos na lista do filtro. Por exemplo: ''O usuário pode filtrar as vendas realizadas em "01/12/2012 a 31/12/2012" e também as vendas realizadas em "01/12/2013 a 31/12/2013", com o intuito de comparar um período com o outro.''
#'''Usuário:''' Campo onde poderá ser selecionado um usuário dentre os cadastrados e ativos no sistema para filtrar somente vendas realizadas pelo mesmo.

Segundo nível:
#'''Dados do pedido'''
#*'''Somente faturados?''' Neste campo o usuário poderá optar por visualizar todos os pedidos (desmarcado) ou somente pedidos faturados (marcado).
#*'''Tipo de pedido:''' Neste filtro o usuário poderá filtrar suas vendas por tipo de pedido, selecionando os desejados. As opções serão:
#** '''51 - NF de saída''' para notas fiscais de saída.
#**'''55 - PDV''' para pedidos realizados no ponto de venda.
#**'''56 - CUPOM/NFC-e''' para cupons fiscais ou NFC-e´s realizadas no módulo ECF.
#*'''Tabela de preço:''' No caso de pedidos do tipo 55 (PDV) será possível filtra-los através da tabela de preço utilizada (seja no cabeçalho ou por item). Neste campo só poderão ser exibidas tabelas de preço que em seu cadastro estejam configuradas para ser utilizadas com as filiais selecionadas no filtro '''Filiais'''. Este filtro só poderá ser utilizado caso no filtro '''Tipo de pedido''' esteja selecionado o tipo ''55''.
#*'''Vendedor:''' Neste campo poderão ser filtradas vendas de um determinado vendedor apenas.
#*'''Data de entrega:''' Neste campo as vendas poderão ser filtradas por data de entrega (caso possuam), seja a data por pedido ou por item.
#*'''Hora:''' Neste campo o usuário poderá filtrar pedidos realizados em uma determinada faixa de horário.
#*'''Operador de caixa:''' Neste campo o usuário poderá filtrar vendas realizadas por um determinado operador de caixa. Este filtro só vai aparecer caso o usuário tenha fechamento de caixa, configurado no PDV, aba "Faturamento".
#*'''Operação:''' Este filtro permitirá ao usuário selecionar uma '''operação de saída''' específica para a filtragem dos pedidos. É importante ressaltar que, quando utilizado o filtro em questão, serão listados na consulta '''todos''' os pedidos emitidos com a operação selecionada '''independente''' se o parâmetro '''Considerar em vendas''' está ativado '''ou não''' em seu cadastro. À direita do filtro deverá ser exibido o texto: ''Lista pedidos cuja operação '''não''' considera em vendas''.
#*'''Faturamento:''' Campo onde o usuário poderá filtrar pedidos do tipo 51 e 55 pela forma em que foram faturados com as seguintes opções:
#**'''Todos:''' Opção padrão que '''não''' filtra pedidos por uma determinada forma de pagamento, neste caso todas as formas de pagamento serão consideradas.
#**'''Dinheiro:''' Traz pedidos que contenham em seu faturamento a forma de pagamento '''Dinheiro'''.
#**'''Cartão:''' Com esta opção selecionada o sistema considerará pedidos que contenham em seu faturamento a forma de pagamento '''Cartão'''. Caso esta opção seja selecionada serão exibidos à direita do campo '''Faturamento''' outros dois ''comboboxes'' conforme segue abaixo:
#**#'''Cartão:''' Campo onde serão listadas as administradoras de cartão cadastradas e ativas no sistema.
#**#'''Plano:''' Habilitado somente após o cartão ser selecionado, este campo listará os planos de financeira ativos e vinculados ao cartão em questão.
#**'''Cheque:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Cheque'''.
#**'''Receber:''' Com esta opção selecionada o sistema considerará todos pedidos que contenham em seu faturamento a forma de pagamento '''Receber'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o ''combobox'' '''Prazo''', que listará as formas de pagamento cadastradas caso usuário deseje filtrar pedidos cujo receber foi gerar com uma delas. Parcelas avulsas '''não''' serão consideradas no ''combobox'' '''Prazo''', e se o mesmo for deixado em branco na filtragem de pedidos cujo faturamento contem a forma de pagamento '''Receber''' serão considerados todos os prazos e também as parcelas avulsas.
#**'''Crédito:''' Traz todos os pedidos que contenham em seu faturamento a forma de pagamento '''Crédito'''.
#**'''Convênio:''' Com esta opção selecionada o sistema considerará todos os pedidos que contenham em seu faturamento a forma de pagamento '''Convênio'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o combobox '''Bandeira''', que listará todos os convênios cadastrados e ativos caso usuário deseje filtrar pedidos cujo faturamento utilizou convênio de uma bandeira específica. Se o ''combobox'' '''Bandeira''' for deixado em branco, na filtragem de pedidos cujo faturamento contém convênio serão consideradas todas as bandeiras.
#**'''Depósito:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Depósito'''.
#'''Dados do cliente'''
#*'''Cliente:''' Neste campo o usuário poderá filtrar vendas realizadas para um determinado cliente.
#*'''Segmento:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de um determinado segmento.
#*'''Classificação:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de uma determinada classificação.
#*'''Rota:''' Neste campo o usuário poderá filtrar vendas para todos clientes de uma determinada rota.
#*'''Região (Estado e cidade):''' Nestes campos pedidos poderão ser filtrados por região, onde de acordo com os dados informados, serão considerados o estado e a cidade dos clientes dos pedidos.
#'''Dados do item'''
#*'''Item:''' Neste campo o usuário poderá informar um determinado item (produto ou serviço) cujas vendas deseja visualizar. Ou seja, se informado, só listar as vendas que tiveram este item informado (mesmo que tenha outros).
#*'''Telefonia:''' Conjunto de filtros que estarão dentro do agrupamento '''Dados do item''', mas que serão visíveis somente quando o módulo utilizado for de telefonia.
#**Tabela de preço
#**Tipo de preço
#**Promoção

== RN02 - Grid da consulta ==
O grid deverá exibir dados que sejam coerentes com os filtros utilizados nas seguintes colunas:
#'''PDV:''' Caso registro listado no grid possua um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''DAV:''' Caso registro listado seja um DAV, será exibido um ícone (D) que quando acionado exibirá na tela a visualização do mesmo. Ao lado do ícone será exibido o número do DAV.
#'''ECF:''' Caso registro listado possua um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso registro listado possua nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.
#'''FILIAL:''' Filial em que a venda foi realizada (apenas código).
#'''TOTAL DA VENDA:''' Exibe o valor total do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''DATA DA VENDA:''' Mostra a data de faturamento do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''CLIENTE:''' Coluna onde será exibido o código+nome do cliente da venda.
#'''VENDEDOR:''' Código+nome do vendedor do pedido.
#'''TABELA DE PREÇO:''' Tabela de preço utilizada na venda (do cabeçalho).

Na 1ª à 4ª coluna do grid, a venda cujo tipo de operação possuir marcado o parâmetro '''Considerar em vendas'''
deverá ter seu número exibido em '''negrito'''.

Na parte superior do grid, na linha acima aos títulos das colunas deverão estar disponíveis as seguintes configurações:
#'''Tipo de visão ao imprimir:''' Determina a formatação e diagramação dos dados do relatório ao imprimir com as seguintes variações:
#*Faturamento analítico
#*Faturamento sintético
#*Somatório de vendas
#*Vendas por hora
#*Vendas por operador
#*Resumo diário
#*Vendas por grupo
#'''Gerar gráfico:''' Botão que quando acionado gera um gráfico com os registros filtrados.
#'''Imprimir:''' Botão que gera impressão dos registros filtrados.

== RN03 - Tipos/Visões de impressão da consulta ==
A consulta em questão possibilitará ao usuário gerar diferentes visões/impressões para os dados filtrados, com diferentes informações e formatações conforme descrito abaixo.


É importante ressaltar que todos os relatórios deverão ser implementados seguindo os padrões do sistema.
Os layouts/modelos deste documento tem como objetivo demonstrar os dados e diagramação de cada visão.

#'''Visão ''Faturamento sintético'':''' A visão de faturamento sintética consiste em exibir de forma mais sintética os dados dos pedidos agrupados e totalizados por filial com o total geral ao fim do relatório.
#'''Visão ''Faturamento analítico'':''' A visão de faturamento analítica tem o objetivo de detalhar cada pedido exibindo para os mesmos dados de cabeçalho e detalhamento dos itens. Cada pedido terá seu total bruto e líquido e ao final do relatório haverá um total geral.
#'''Visão ''Somatório de vendas'':''' A visão de somatória de vendas tem como objetivo detalhar e totalizar vendas por forma de pagamento, exibindo o cliente e o vendedor de cada pedido. Ao final do relatório é exibido o total geral, a quantidade de pedidos e a totalização das vendas por convênio/plano.
#'''Visão ''Vendas por hora'':''' A visão de vendas por hora tem como objetivo exibir, no período filtrado, a quantidade e o valor total dos pedidos agrupados por dia e hora. Ao final do resumo de cada dia será exibido o total do dia, o total das devoluções do dia, o saldo final do dia e também o total de pedidos daquele dia.
#'''Visão ''Vendas por operador'':''' A visão de vendas por operador consiste em exibir os itens vendidos pelos operadores detalhando por item a quantidade, preço médio de venda e total da venda. O relatório totalizará os dados por operador e também exibirá um total geral. Esta visão somente estará disponível caso na filtragem o campo '''Operador''' esteja habilitado.
#'''Visão ''Resumo diário'':''' A visão de resumo diário tem como objetivo totalizar as vendas por dia de acordo com período filtrado. Ao final será exibido um total geral.
#'''Visão ''Vendas por grupo'':''' A visão de vendas por grupo tem como objetivo agrupar e totalizar vendas por grupo e subgrupo, exibindo para cada grupo a quantidade vendida e a venda, em valor e em percentual. Ao final de cada agrupamento será apresentado um totalizador e ao final do relatório será apresentado um totalizador geral.
<gallery>
File:RelFatPedVisaoFaturamento.png|Visão '''''Faturamento sintético'''''
File:RelFatPedVisaoFaturamentoAnalitico.png|Visão '''Faturamento analítico'''
File:RelFatPedVisaoOperador.png|Visão '''''Vendas por operador'''
File:RelFatPedVisaoSomatoria.png|Visão '''''Somatório de vendas'''
File:RelFatPedVisaoVendasHora.jpg|Visão '''''Vendas por hora'''
File:RelFatPedVisaoResumoDiario.jpg|Visão '''''Resumo diário'''''
File:RelFatPedVisaoVendasGrupo.jpg|Visão '''''Vendas por grupo'''
</gallery>


O combobox que permite ao usuário selecionar o tipo de visão para impressão somente será habilitado após os resultados
da consulta serem listados no grid.


Quando a impressão dos dados resultar em mais de 1 página, independente da visão escolhida, os títulos/cabeçalhos das colunas deverão ser replicados em cada página gerada.

=== Telefonia ===
Para o módulo de telefonia as visões de ''Faturamento'' analítica e sintética terão diagramações diferenciadas (conforme respectivos layouts mais abaixo) onde:
*'''Faturamento sintético''' -> Equivalente ao ''antigo relatório de somatório de vendas resumido''.
*'''Faturamento analítico''' -> Equivalente ao ''antigo relatório de somatório de vendas detalhado''.


Os pedidos ou itens devolvidos deverão ser destacados na cor vermelha em ambas as visões citadas acima.

<gallery>
File:RelFatPedVisaoFaturamentoSinteticoTelefonia.png|Visão '''''Faturamento sintético Telefonia'''''
File:RelFatPedVisaoFaturamentoAnaliticoTelefonia.png|Visão '''''Faturamento analítico Telefonia'''''
</gallery>

Ainda, exclusivamente para o módulo de telefonia, em todas as visões de impressão disponíveis deverão ser adicionadas ao final do relatório páginas com totalizadores exclusivos do segmento de telefonia conforme segue abaixo:
*'''Total de vendas:''' Exibirá informações sobre os totais vendidos com os seguintes dados:
*#'''QUANTIDADE DE PEDIDOS:''' Quantidade de pedidos encontrados/considerados com base nos filtros informados.
*#'''TOTAL DE VENDAS:''' Somatória do valor total de cada venda considerada na filtragem dos dados. Lembrando que este é o total líquido, já considerando descontos, acréscimos, devoluções e etc.
*#'''DESCONTOS DA OPERADORA:''' Somatória dos valores de descontos de operadora informados nos itens dos pedidos considerados na filtragem.
*#'''DESCONTOS ITENS/GLOBAL:''' Somatória dos valores de descontos informados nos itens e/ou na finalização dos pedidos considerados na filtragem.
*#'''TOTAL DE TROCAS:''' Somatória das formas de pagamento do tipo ''troca'' existentes nos pedidos considerados na filtragem.
*#'''TOTAL DE DEVOLUÇÕES:''' Somatória dos pedidos e/ou itens que constam em notas fiscais de devolução.
*#'''CRÉD. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de créditos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''DÉB. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de débitos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''TOTAL GERAL:''' Exibe o total geral do período filtrado considerando os totalizadores acima na seguinte formula: '''''total de vendas + créditos avulsos no caixa - débitos avulsos no caixa - total de devoluções'''''.
*'''Lançamentos avulsos no caixa:''' Exibirá informações detalhadas sobre lançamentos avulsos de caixa realizados no período da filtragem nas seguintes colunas:
*#'''CONTA CAIXA:''' Conta onde o lançamento foi realizado.
*#'''DÉBITO/CRÉDITO:''' Informa se o lançamento foi de DÉBITO ou CRÉDITO.
*#'''SUBCAIXA:''' Informa o subcaixa utilizado no movimento de caixa.
*#'''DATA:''' Data em que o movimento de caixa foi realizado.
*#'''VALOR:''' Valor do movimento de caixa.
*'''Totais por forma de pagamento:''' Com base nos pedidos encontrados na consulta, exibira o total geral por forma de pagamento, ou seja:
*#'''DINHEIRO
*#'''CARTÃO:''' Este totalizador será dividido em '''mestre''', '''detalhe''' e '''sub-detalhe''' onde:
*#*'''Mestre:''' Exibe o total geral de '''todas''' as administradoras de cartão utilizadas.
*#*'''Detalhe:''' Exibe o total de cada administradora de cartão utilizada nos pedidos listados.
*#*'''Sub-detalhe:''' Exibe, para cada administradora listada no detalhe, o total por plano de financeira.
*#'''CHEQUE'''
*#'''RECEBER'''
*#'''CRÉDITO APROVEITADO'''
*#'''CRÉDITO GERADO:''' Este totalizador considera créditos gerados nos pedidos e também na devolução dos mesmos.
*#'''CONVÊNIO'''
*#'''DEPÓSITO'''
*#'''TROCA'''
*'''Vendas por grupo/subgrupo:''' Exibirá o total de vendas divido por grupo e subgrupo, sendo que os subgrupos ficarão agrupados dentro de seu respectivo grupo.
*'''Totais por serviço:''' Todos os serviços utilizados nos pedidos considerados na consulta serão agrupados e totalizados. Na listagem dos serviços o sistema fará o seguinte agrupamento:
*#'''Serviços da operadora:''' Serviços oficiais da operadora.
*#'''Serviços do lojista:''' Serviços cadastrados pelo próprio lojista.
*'''Unidades vendidas:''' Todos os produtos utilizados nos pedidos considerados na consulta serão agrupados e totalizados e listados nesta seção.
*'''Totais por plano/operação:''' Todos os planos e operações utilizados nos itens das vendas consideradas na consulta serão agrupados, totalizados e listados nas seguintes colunas:
*#'''PLANO'''
*#'''OPERAÇÃO'''
*#'''QTDE:''' Quantidade de ocorrências deste plano + operação dentre os pedidos listados na consulta.
*#'''VALOR'''

== RN04 - Graficos ==
Serão elegíveis para geração de gráficos as seguintes visões:
*Somatório de vendas
*Vendas por hora
*Resumo diário

Quando usuário acionar o botão que gera gráficos, o sistema deverá gerar uma mesma janela (pop-up) os gráficos citados acima permitindo que o usuário alterne entre os mesmos. Os gráficos deverão seguir os modelos sugeridos abaixo:
<gallery>
File:GraficoSomatoria.jpg|'''''Somatória de vendas'''''
File:GraficoVendasHora.jpg|'''''Vendas por hora'''''
File:GraficoResumoDiario.jpg|'''''Resumo diário'''''
</gallery>

== RN05 - Devoluções/Trocas ==
'''Devoluções''' deverão ser automaticamente deduzidas caso existam dentre os dados filtrados. No grid, estas deverão ser exibidas, na data em que foram realizadas, com a linha na cor vermelha e com valores negativos.

Pedidos que possuírem a forma de pagamento '''troca''' serão exibidos no grid na cor vermelha e com os valores normais do pedido.

Na visão '''Faturamento sintético''' a exibição de trocas e devoluções será semelhante à do grid, mostrando uma linha na cor vermelha com a devolução tendo valores negativos.

Na visão '''Faturamento analítico''' as devoluções e trocas deverão ser exibidas em forma de pedido com seus dados na cor vermelha logo abaixo de seu pedido de origem. No canto superior direito do pedido deverá haver um campo informando que o mesmo trata-se de uma devolução.

Na visão '''Vendas por operador''' as devoluções e trocas não serão exibidas. As vendas que possuem devolução simplesmente não serão consideradas (no caso de devolução total).

Na visão '''Somatório de vendas''' o valor das devoluções e trocas serão exibidos na respectiva coluna.

Nas visões '''Vendas por hora''', '''Resumo diário''' e '''Vendas por grupo''' trocas e devoluções não serão exibidas, mas seus valores serão deduzidos.

UC00089 - Consulta de faturamento por pedido

2015-04-20T14:24:26Z

Daniel: /* Fluxos alternativos */

= Módulos/Sistemas =
*Resulth WEB Start
*Resulth WEB Business
*Resulth WEB ERP
*Resulth WEB Telefonia

= Objetivo =
*Consultar/exibir de forma sintética e analítica dados referentes ao faturamento.

= Atores =
*Usuário

= Pré-requisitos =
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta de faturamento por pedido'''. Este nome será utilizado para criar a página no Wiki
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =
Consultar vendas exibindo resultados com base nos diversos filtros disponíveis possibilitando ao usuário imprimi-los em diferentes visões/formatos e também gerar gráficos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina ''Menu > Consultas > Faturamento > Faturamento por pedido.''.
*Sistema exibe a tela inicial da rotina com a aba de filtragem aberta posicionando o foco no primeiro campo (filiais).

'''Fluxo 2:''' Usuário informa os filtros desejados e aciona o botão <Consultar>.
*Sistema verifica se existem movimentos pertinentes aos filtros utilizados.
*Se forem encontrados registros de vendas, sistema os exibe no grid.
*Se nenhum movimento for encontrado, sistema exibe informa ao usuário que de acordo com os filtros utilizados nenhum dado foi encontrado.

'''Fluxo 3:''' Com os resultados da consulta listados no grid, usuário clica sobre os ícones PDV, DAV, ECF ou NF.
*Sistema exibe o registro de venda referente ao ícone acionado.

'''Fluxo 4:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário seleciona no combobox o tipo de visão da consulta que deseja imprimir e em seguida aciona o botão <Imprimir> escolhendo o formato desejado.
*Sistema procede conforme regra de negócio [[#RN03 - Tipos/Visões de impressão da consulta | RN03]].

'''Fluxo 5:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário aciona o botão <Gerar gráfico>.
*Sistema procede conforme regra de negócio [[#RN04 - Graficos | RN04]].

== Fluxos alternativos ==
'''Fluxo 1:''' Ao acessar a rotina em questão usuário clica diretamente no botão [Consultar].
*Uma vez que por padrão a filial logada é selecionada e o período é preenchido com o mês corrente (com base na data de login), sistema filtra as vendas com base nestes dados e lista os resultados no grid caso existam.

'''Fluxo 2:''' Usuário acessa a rotina em questão e informa no filtro '''Operação''' uma determinada operação de saída.
*Sistema faz a consulta de todos os pedidos cuja operação corresponde a que foi informada no filtro, independente se o parâmetro '''Considerar em vendas''' está marcado '''ou não''' em seu cadastro.

'''Fluxo 3:''' Utilizando o módulo de '''telefonia''' o usuário acessa a rotina em questão, faz a filtragem dos dados optando por imprimi-los em seguida.
*Na filtragem, sistema procede conforme [[#RN01 - Filtragem dos dados | RN01]].
*Na impressão dos dados, sistema procede conforme [[#Telefonia | RN03]].

'''Fluxo 4:''' Tendo seu PAF configurado para emitir NFC-e e com NFC-e´s já emitidas por venda direta ou por importação de pedidos o usuário acessa a rotina em questão e informa filtros que listem no grid pedidos do tipo 56.
*O sistema irá listar pedidos de NFC-e exatamente da mesma forma como lista pedidos de cupons fiscais.
*Quando o ícone da coluna ECF for acionado em pedidos de NFC-e, o sistema irá apresentar em uma nova aba do navegador a DANFE da NFC-e, conforme item 3 da regra de negócio [[#RN02 - Grid da consulta | RN02]].

== Fluxos de exceções ==
'''Fluxo 1:''' Sem filtrar nenhum dado usuário fecha a aba de consulta e tenta clicar sobre os botões que geram gráfico e impressão.
*Enquanto o grid que exibe os resultados da consulta estiver vazio, sistema mantem os botões que geram gráfico e impressão desabilitados.
*Caso usuário posicione o mouse sobre estes botões, o seguinte ''hint'' será exibido: ''Este botão ficará ativo somente quando houver registros listados no grid.''

= Regras de negócio =
== RN01 - Filtragem dos dados ==
A filtragem dos dados será dividida em dois níveis. O primeiro nível, que será de preenchimento obrigatório, apresentará filtros essenciais para a busca dos dados. O segundo nível, que será opcional, apresentará filtros adicionais que permitirá uma melhor filtragem, organização e exibição dos dados.

Para os filtros de segundo nível o sistema deverá exibir apenas o nome da categoria dos mesmos. Quando usuário clicar sobe o nome de um determinado filtro, então o sistema renderizará os campos pertinentes ao mesmo. Após preencher os campos o usuário poderá oculta-los clicando novamente sobre o nome do filtro.

Uma vez que a rotina em questão atende a vários módulos serão destacados mais abaixo os filtros que são exclusivos de um determinado módulo. Os demais filtros que não estão destacados serão accessíveis em todos os módulos.


É importante ressaltar que um filtro '''não deverá anular o outro'''.

Primeiro nível:
#'''Filiais:''' Com a filial logada marcada como padrão e exibindo as demais filiais cujo usuário logado possui acesso conforme [[Padrões de desenvolvimento]].
#'''Período:''' Campo onde deverá ser informado um período de emissão ou de faturamento dependendo do tipo de período que o usuário optar. O usuário poderá informar também, mais de um período para filtrar as movimentações adicionando vários intervalos na lista do filtro. Por exemplo: ''O usuário pode filtrar as vendas realizadas em "01/12/2012 a 31/12/2012" e também as vendas realizadas em "01/12/2013 a 31/12/2013", com o intuito de comparar um período com o outro.''
#'''Usuário:''' Campo onde poderá ser selecionado um usuário dentre os cadastrados e ativos no sistema para filtrar somente vendas realizadas pelo mesmo.

Segundo nível:
#'''Dados do pedido'''
#*'''Somente faturados?''' Neste campo o usuário poderá optar por visualizar todos os pedidos (desmarcado) ou somente pedidos faturados (marcado).
#*'''Tipo de pedido:''' Neste filtro o usuário poderá filtrar suas vendas por tipo de pedido, selecionando os desejados. As opções serão:
#** '''51 - NF de saída''' para notas fiscais de saída.
#**'''55 - PDV''' para pedidos realizados no ponto de venda.
#**'''56 - CUPOM''' para cupons fiscais ou NFC-e´s realizadas no módulo ECF.
#*'''Tabela de preço:''' No caso de pedidos do tipo 55 (PDV) será possível filtra-los através da tabela de preço utilizada (seja no cabeçalho ou por item). Neste campo só poderão ser exibidas tabelas de preço que em seu cadastro estejam configuradas para ser utilizadas com as filiais selecionadas no filtro '''Filiais'''. Este filtro só poderá ser utilizado caso no filtro '''Tipo de pedido''' esteja selecionado o tipo ''55''.
#*'''Vendedor:''' Neste campo poderão ser filtradas vendas de um determinado vendedor apenas.
#*'''Data de entrega:''' Neste campo as vendas poderão ser filtradas por data de entrega (caso possuam), seja a data por pedido ou por item.
#*'''Hora:''' Neste campo o usuário poderá filtrar pedidos realizados em uma determinada faixa de horário.
#*'''Operador de caixa:''' Neste campo o usuário poderá filtrar vendas realizadas por um determinado operador de caixa. Este filtro só vai aparecer caso o usuário tenha fechamento de caixa, configurado no PDV, aba "Faturamento".
#*'''Operação:''' Este filtro permitirá ao usuário selecionar uma '''operação de saída''' específica para a filtragem dos pedidos. É importante ressaltar que, quando utilizado o filtro em questão, serão listados na consulta '''todos''' os pedidos emitidos com a operação selecionada '''independente''' se o parâmetro '''Considerar em vendas''' está ativado '''ou não''' em seu cadastro. À direita do filtro deverá ser exibido o texto: ''Lista pedidos cuja operação '''não''' considera em vendas''.
#*'''Faturamento:''' Campo onde o usuário poderá filtrar pedidos do tipo 51 e 55 pela forma em que foram faturados com as seguintes opções:
#**'''Todos:''' Opção padrão que '''não''' filtra pedidos por uma determinada forma de pagamento, neste caso todas as formas de pagamento serão consideradas.
#**'''Dinheiro:''' Traz pedidos que contenham em seu faturamento a forma de pagamento '''Dinheiro'''.
#**'''Cartão:''' Com esta opção selecionada o sistema considerará pedidos que contenham em seu faturamento a forma de pagamento '''Cartão'''. Caso esta opção seja selecionada serão exibidos à direita do campo '''Faturamento''' outros dois ''comboboxes'' conforme segue abaixo:
#**#'''Cartão:''' Campo onde serão listadas as administradoras de cartão cadastradas e ativas no sistema.
#**#'''Plano:''' Habilitado somente após o cartão ser selecionado, este campo listará os planos de financeira ativos e vinculados ao cartão em questão.
#**'''Cheque:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Cheque'''.
#**'''Receber:''' Com esta opção selecionada o sistema considerará todos pedidos que contenham em seu faturamento a forma de pagamento '''Receber'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o ''combobox'' '''Prazo''', que listará as formas de pagamento cadastradas caso usuário deseje filtrar pedidos cujo receber foi gerar com uma delas. Parcelas avulsas '''não''' serão consideradas no ''combobox'' '''Prazo''', e se o mesmo for deixado em branco na filtragem de pedidos cujo faturamento contem a forma de pagamento '''Receber''' serão considerados todos os prazos e também as parcelas avulsas.
#**'''Crédito:''' Traz todos os pedidos que contenham em seu faturamento a forma de pagamento '''Crédito'''.
#**'''Convênio:''' Com esta opção selecionada o sistema considerará todos os pedidos que contenham em seu faturamento a forma de pagamento '''Convênio'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o combobox '''Bandeira''', que listará todos os convênios cadastrados e ativos caso usuário deseje filtrar pedidos cujo faturamento utilizou convênio de uma bandeira específica. Se o ''combobox'' '''Bandeira''' for deixado em branco, na filtragem de pedidos cujo faturamento contém convênio serão consideradas todas as bandeiras.
#**'''Depósito:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Depósito'''.
#'''Dados do cliente'''
#*'''Cliente:''' Neste campo o usuário poderá filtrar vendas realizadas para um determinado cliente.
#*'''Segmento:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de um determinado segmento.
#*'''Classificação:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de uma determinada classificação.
#*'''Rota:''' Neste campo o usuário poderá filtrar vendas para todos clientes de uma determinada rota.
#*'''Região (Estado e cidade):''' Nestes campos pedidos poderão ser filtrados por região, onde de acordo com os dados informados, serão considerados o estado e a cidade dos clientes dos pedidos.
#'''Dados do item'''
#*'''Item:''' Neste campo o usuário poderá informar um determinado item (produto ou serviço) cujas vendas deseja visualizar. Ou seja, se informado, só listar as vendas que tiveram este item informado (mesmo que tenha outros).
#*'''Telefonia:''' Conjunto de filtros que estarão dentro do agrupamento '''Dados do item''', mas que serão visíveis somente quando o módulo utilizado for de telefonia.
#**Tabela de preço
#**Tipo de preço
#**Promoção

== RN02 - Grid da consulta ==
O grid deverá exibir dados que sejam coerentes com os filtros utilizados nas seguintes colunas:
#'''PDV:''' Caso registro listado no grid possua um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''DAV:''' Caso registro listado seja um DAV, será exibido um ícone (D) que quando acionado exibirá na tela a visualização do mesmo. Ao lado do ícone será exibido o número do DAV.
#'''ECF:''' Caso registro listado possua um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso registro listado possua nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.
#'''FILIAL:''' Filial em que a venda foi realizada (apenas código).
#'''TOTAL DA VENDA:''' Exibe o valor total do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''DATA DA VENDA:''' Mostra a data de faturamento do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''CLIENTE:''' Coluna onde será exibido o código+nome do cliente da venda.
#'''VENDEDOR:''' Código+nome do vendedor do pedido.
#'''TABELA DE PREÇO:''' Tabela de preço utilizada na venda (do cabeçalho).

Na 1ª à 4ª coluna do grid, a venda cujo tipo de operação possuir marcado o parâmetro '''Considerar em vendas'''
deverá ter seu número exibido em '''negrito'''.

Na parte superior do grid, na linha acima aos títulos das colunas deverão estar disponíveis as seguintes configurações:
#'''Tipo de visão ao imprimir:''' Determina a formatação e diagramação dos dados do relatório ao imprimir com as seguintes variações:
#*Faturamento analítico
#*Faturamento sintético
#*Somatório de vendas
#*Vendas por hora
#*Vendas por operador
#*Resumo diário
#*Vendas por grupo
#'''Gerar gráfico:''' Botão que quando acionado gera um gráfico com os registros filtrados.
#'''Imprimir:''' Botão que gera impressão dos registros filtrados.

== RN03 - Tipos/Visões de impressão da consulta ==
A consulta em questão possibilitará ao usuário gerar diferentes visões/impressões para os dados filtrados, com diferentes informações e formatações conforme descrito abaixo.


É importante ressaltar que todos os relatórios deverão ser implementados seguindo os padrões do sistema.
Os layouts/modelos deste documento tem como objetivo demonstrar os dados e diagramação de cada visão.

#'''Visão ''Faturamento sintético'':''' A visão de faturamento sintética consiste em exibir de forma mais sintética os dados dos pedidos agrupados e totalizados por filial com o total geral ao fim do relatório.
#'''Visão ''Faturamento analítico'':''' A visão de faturamento analítica tem o objetivo de detalhar cada pedido exibindo para os mesmos dados de cabeçalho e detalhamento dos itens. Cada pedido terá seu total bruto e líquido e ao final do relatório haverá um total geral.
#'''Visão ''Somatório de vendas'':''' A visão de somatória de vendas tem como objetivo detalhar e totalizar vendas por forma de pagamento, exibindo o cliente e o vendedor de cada pedido. Ao final do relatório é exibido o total geral, a quantidade de pedidos e a totalização das vendas por convênio/plano.
#'''Visão ''Vendas por hora'':''' A visão de vendas por hora tem como objetivo exibir, no período filtrado, a quantidade e o valor total dos pedidos agrupados por dia e hora. Ao final do resumo de cada dia será exibido o total do dia, o total das devoluções do dia, o saldo final do dia e também o total de pedidos daquele dia.
#'''Visão ''Vendas por operador'':''' A visão de vendas por operador consiste em exibir os itens vendidos pelos operadores detalhando por item a quantidade, preço médio de venda e total da venda. O relatório totalizará os dados por operador e também exibirá um total geral. Esta visão somente estará disponível caso na filtragem o campo '''Operador''' esteja habilitado.
#'''Visão ''Resumo diário'':''' A visão de resumo diário tem como objetivo totalizar as vendas por dia de acordo com período filtrado. Ao final será exibido um total geral.
#'''Visão ''Vendas por grupo'':''' A visão de vendas por grupo tem como objetivo agrupar e totalizar vendas por grupo e subgrupo, exibindo para cada grupo a quantidade vendida e a venda, em valor e em percentual. Ao final de cada agrupamento será apresentado um totalizador e ao final do relatório será apresentado um totalizador geral.
<gallery>
File:RelFatPedVisaoFaturamento.png|Visão '''''Faturamento sintético'''''
File:RelFatPedVisaoFaturamentoAnalitico.png|Visão '''Faturamento analítico'''
File:RelFatPedVisaoOperador.png|Visão '''''Vendas por operador'''
File:RelFatPedVisaoSomatoria.png|Visão '''''Somatório de vendas'''
File:RelFatPedVisaoVendasHora.jpg|Visão '''''Vendas por hora'''
File:RelFatPedVisaoResumoDiario.jpg|Visão '''''Resumo diário'''''
File:RelFatPedVisaoVendasGrupo.jpg|Visão '''''Vendas por grupo'''
</gallery>


O combobox que permite ao usuário selecionar o tipo de visão para impressão somente será habilitado após os resultados
da consulta serem listados no grid.


Quando a impressão dos dados resultar em mais de 1 página, independente da visão escolhida, os títulos/cabeçalhos das colunas deverão ser replicados em cada página gerada.

=== Telefonia ===
Para o módulo de telefonia as visões de ''Faturamento'' analítica e sintética terão diagramações diferenciadas (conforme respectivos layouts mais abaixo) onde:
*'''Faturamento sintético''' -> Equivalente ao ''antigo relatório de somatório de vendas resumido''.
*'''Faturamento analítico''' -> Equivalente ao ''antigo relatório de somatório de vendas detalhado''.


Os pedidos ou itens devolvidos deverão ser destacados na cor vermelha em ambas as visões citadas acima.

<gallery>
File:RelFatPedVisaoFaturamentoSinteticoTelefonia.png|Visão '''''Faturamento sintético Telefonia'''''
File:RelFatPedVisaoFaturamentoAnaliticoTelefonia.png|Visão '''''Faturamento analítico Telefonia'''''
</gallery>

Ainda, exclusivamente para o módulo de telefonia, em todas as visões de impressão disponíveis deverão ser adicionadas ao final do relatório páginas com totalizadores exclusivos do segmento de telefonia conforme segue abaixo:
*'''Total de vendas:''' Exibirá informações sobre os totais vendidos com os seguintes dados:
*#'''QUANTIDADE DE PEDIDOS:''' Quantidade de pedidos encontrados/considerados com base nos filtros informados.
*#'''TOTAL DE VENDAS:''' Somatória do valor total de cada venda considerada na filtragem dos dados. Lembrando que este é o total líquido, já considerando descontos, acréscimos, devoluções e etc.
*#'''DESCONTOS DA OPERADORA:''' Somatória dos valores de descontos de operadora informados nos itens dos pedidos considerados na filtragem.
*#'''DESCONTOS ITENS/GLOBAL:''' Somatória dos valores de descontos informados nos itens e/ou na finalização dos pedidos considerados na filtragem.
*#'''TOTAL DE TROCAS:''' Somatória das formas de pagamento do tipo ''troca'' existentes nos pedidos considerados na filtragem.
*#'''TOTAL DE DEVOLUÇÕES:''' Somatória dos pedidos e/ou itens que constam em notas fiscais de devolução.
*#'''CRÉD. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de créditos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''DÉB. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de débitos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''TOTAL GERAL:''' Exibe o total geral do período filtrado considerando os totalizadores acima na seguinte formula: '''''total de vendas + créditos avulsos no caixa - débitos avulsos no caixa - total de devoluções'''''.
*'''Lançamentos avulsos no caixa:''' Exibirá informações detalhadas sobre lançamentos avulsos de caixa realizados no período da filtragem nas seguintes colunas:
*#'''CONTA CAIXA:''' Conta onde o lançamento foi realizado.
*#'''DÉBITO/CRÉDITO:''' Informa se o lançamento foi de DÉBITO ou CRÉDITO.
*#'''SUBCAIXA:''' Informa o subcaixa utilizado no movimento de caixa.
*#'''DATA:''' Data em que o movimento de caixa foi realizado.
*#'''VALOR:''' Valor do movimento de caixa.
*'''Totais por forma de pagamento:''' Com base nos pedidos encontrados na consulta, exibira o total geral por forma de pagamento, ou seja:
*#'''DINHEIRO
*#'''CARTÃO:''' Este totalizador será dividido em '''mestre''', '''detalhe''' e '''sub-detalhe''' onde:
*#*'''Mestre:''' Exibe o total geral de '''todas''' as administradoras de cartão utilizadas.
*#*'''Detalhe:''' Exibe o total de cada administradora de cartão utilizada nos pedidos listados.
*#*'''Sub-detalhe:''' Exibe, para cada administradora listada no detalhe, o total por plano de financeira.
*#'''CHEQUE'''
*#'''RECEBER'''
*#'''CRÉDITO APROVEITADO'''
*#'''CRÉDITO GERADO:''' Este totalizador considera créditos gerados nos pedidos e também na devolução dos mesmos.
*#'''CONVÊNIO'''
*#'''DEPÓSITO'''
*#'''TROCA'''
*'''Vendas por grupo/subgrupo:''' Exibirá o total de vendas divido por grupo e subgrupo, sendo que os subgrupos ficarão agrupados dentro de seu respectivo grupo.
*'''Totais por serviço:''' Todos os serviços utilizados nos pedidos considerados na consulta serão agrupados e totalizados. Na listagem dos serviços o sistema fará o seguinte agrupamento:
*#'''Serviços da operadora:''' Serviços oficiais da operadora.
*#'''Serviços do lojista:''' Serviços cadastrados pelo próprio lojista.
*'''Unidades vendidas:''' Todos os produtos utilizados nos pedidos considerados na consulta serão agrupados e totalizados e listados nesta seção.
*'''Totais por plano/operação:''' Todos os planos e operações utilizados nos itens das vendas consideradas na consulta serão agrupados, totalizados e listados nas seguintes colunas:
*#'''PLANO'''
*#'''OPERAÇÃO'''
*#'''QTDE:''' Quantidade de ocorrências deste plano + operação dentre os pedidos listados na consulta.
*#'''VALOR'''

== RN04 - Graficos ==
Serão elegíveis para geração de gráficos as seguintes visões:
*Somatório de vendas
*Vendas por hora
*Resumo diário

Quando usuário acionar o botão que gera gráficos, o sistema deverá gerar uma mesma janela (pop-up) os gráficos citados acima permitindo que o usuário alterne entre os mesmos. Os gráficos deverão seguir os modelos sugeridos abaixo:
<gallery>
File:GraficoSomatoria.jpg|'''''Somatória de vendas'''''
File:GraficoVendasHora.jpg|'''''Vendas por hora'''''
File:GraficoResumoDiario.jpg|'''''Resumo diário'''''
</gallery>

== RN05 - Devoluções/Trocas ==
'''Devoluções''' deverão ser automaticamente deduzidas caso existam dentre os dados filtrados. No grid, estas deverão ser exibidas, na data em que foram realizadas, com a linha na cor vermelha e com valores negativos.

Pedidos que possuírem a forma de pagamento '''troca''' serão exibidos no grid na cor vermelha e com os valores normais do pedido.

Na visão '''Faturamento sintético''' a exibição de trocas e devoluções será semelhante à do grid, mostrando uma linha na cor vermelha com a devolução tendo valores negativos.

Na visão '''Faturamento analítico''' as devoluções e trocas deverão ser exibidas em forma de pedido com seus dados na cor vermelha logo abaixo de seu pedido de origem. No canto superior direito do pedido deverá haver um campo informando que o mesmo trata-se de uma devolução.

Na visão '''Vendas por operador''' as devoluções e trocas não serão exibidas. As vendas que possuem devolução simplesmente não serão consideradas (no caso de devolução total).

Na visão '''Somatório de vendas''' o valor das devoluções e trocas serão exibidos na respectiva coluna.

Nas visões '''Vendas por hora''', '''Resumo diário''' e '''Vendas por grupo''' trocas e devoluções não serão exibidas, mas seus valores serão deduzidos.

UC00089 - Consulta de faturamento por pedido

2015-04-20T14:22:00Z

Daniel: /* Fluxos alternativos */

= Módulos/Sistemas =
*Resulth WEB Start
*Resulth WEB Business
*Resulth WEB ERP
*Resulth WEB Telefonia

= Objetivo =
*Consultar/exibir de forma sintética e analítica dados referentes ao faturamento.

= Atores =
*Usuário

= Pré-requisitos =
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta de faturamento por pedido'''. Este nome será utilizado para criar a página no Wiki
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =
Consultar vendas exibindo resultados com base nos diversos filtros disponíveis possibilitando ao usuário imprimi-los em diferentes visões/formatos e também gerar gráficos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina ''Menu > Consultas > Faturamento > Faturamento por pedido.''.
*Sistema exibe a tela inicial da rotina com a aba de filtragem aberta posicionando o foco no primeiro campo (filiais).

'''Fluxo 2:''' Usuário informa os filtros desejados e aciona o botão <Consultar>.
*Sistema verifica se existem movimentos pertinentes aos filtros utilizados.
*Se forem encontrados registros de vendas, sistema os exibe no grid.
*Se nenhum movimento for encontrado, sistema exibe informa ao usuário que de acordo com os filtros utilizados nenhum dado foi encontrado.

'''Fluxo 3:''' Com os resultados da consulta listados no grid, usuário clica sobre os ícones PDV, DAV, ECF ou NF.
*Sistema exibe o registro de venda referente ao ícone acionado.

'''Fluxo 4:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário seleciona no combobox o tipo de visão da consulta que deseja imprimir e em seguida aciona o botão <Imprimir> escolhendo o formato desejado.
*Sistema procede conforme regra de negócio [[#RN03 - Tipos/Visões de impressão da consulta | RN03]].

'''Fluxo 5:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário aciona o botão <Gerar gráfico>.
*Sistema procede conforme regra de negócio [[#RN04 - Graficos | RN04]].

== Fluxos alternativos ==
'''Fluxo 1:''' Ao acessar a rotina em questão usuário clica diretamente no botão [Consultar].
*Uma vez que por padrão a filial logada é selecionada e o período é preenchido com o mês corrente (com base na data de login), sistema filtra as vendas com base nestes dados e lista os resultados no grid caso existam.

'''Fluxo 2:''' Usuário acessa a rotina em questão e informa no filtro '''Operação''' uma determinada operação de saída.
*Sistema faz a consulta de todos os pedidos cuja operação corresponde a que foi informada no filtro, independente se o parâmetro '''Considerar em vendas''' está marcado '''ou não''' em seu cadastro.

'''Fluxo 3:''' Utilizando o módulo de '''telefonia''' o usuário acessa a rotina em questão, faz a filtragem dos dados optando por imprimi-los em seguida.
*Na filtragem, sistema procede conforme [[#RN01 - Filtragem dos dados | RN01]].
*Na impressão dos dados, sistema procede conforme [[#Telefonia | RN03]].

'''Fluxo 4:''' Tendo seu PAF configurado para emitir NFC-e e com NFC-e´s já emitidas por venda direta ou por importação de pedidos o usuário acessa a rotina em questão e informa filtros que listem no grid pedidos do tipo 56.
*O sistema irá listar pedidos de NFC-e exatamente da mesma forma como lista pedidos de cupons fiscais.
*Quando o ícone da coluna ECF for acionado em pedidos de NFC-e, o sistema irá apresentar em uma nova aba do navegador a DANFE da NFC-e, conforme item 3 da regra de negócio [[#RN01 - Filtragem dos dados | RN01]].

== Fluxos de exceções ==
'''Fluxo 1:''' Sem filtrar nenhum dado usuário fecha a aba de consulta e tenta clicar sobre os botões que geram gráfico e impressão.
*Enquanto o grid que exibe os resultados da consulta estiver vazio, sistema mantem os botões que geram gráfico e impressão desabilitados.
*Caso usuário posicione o mouse sobre estes botões, o seguinte ''hint'' será exibido: ''Este botão ficará ativo somente quando houver registros listados no grid.''

= Regras de negócio =
== RN01 - Filtragem dos dados ==
A filtragem dos dados será dividida em dois níveis. O primeiro nível, que será de preenchimento obrigatório, apresentará filtros essenciais para a busca dos dados. O segundo nível, que será opcional, apresentará filtros adicionais que permitirá uma melhor filtragem, organização e exibição dos dados.

Para os filtros de segundo nível o sistema deverá exibir apenas o nome da categoria dos mesmos. Quando usuário clicar sobe o nome de um determinado filtro, então o sistema renderizará os campos pertinentes ao mesmo. Após preencher os campos o usuário poderá oculta-los clicando novamente sobre o nome do filtro.

Uma vez que a rotina em questão atende a vários módulos serão destacados mais abaixo os filtros que são exclusivos de um determinado módulo. Os demais filtros que não estão destacados serão accessíveis em todos os módulos.


É importante ressaltar que um filtro '''não deverá anular o outro'''.

Primeiro nível:
#'''Filiais:''' Com a filial logada marcada como padrão e exibindo as demais filiais cujo usuário logado possui acesso conforme [[Padrões de desenvolvimento]].
#'''Período:''' Campo onde deverá ser informado um período de emissão ou de faturamento dependendo do tipo de período que o usuário optar. O usuário poderá informar também, mais de um período para filtrar as movimentações adicionando vários intervalos na lista do filtro. Por exemplo: ''O usuário pode filtrar as vendas realizadas em "01/12/2012 a 31/12/2012" e também as vendas realizadas em "01/12/2013 a 31/12/2013", com o intuito de comparar um período com o outro.''
#'''Usuário:''' Campo onde poderá ser selecionado um usuário dentre os cadastrados e ativos no sistema para filtrar somente vendas realizadas pelo mesmo.

Segundo nível:
#'''Dados do pedido'''
#*'''Somente faturados?''' Neste campo o usuário poderá optar por visualizar todos os pedidos (desmarcado) ou somente pedidos faturados (marcado).
#*'''Tipo de pedido:''' Neste filtro o usuário poderá filtrar suas vendas por tipo de pedido, selecionando os desejados. As opções serão:
#** '''51 - NF de saída''' para notas fiscais de saída.
#**'''55 - PDV''' para pedidos realizados no ponto de venda.
#**'''56 - CUPOM''' para cupons fiscais ou NFC-e´s realizadas no módulo ECF.
#*'''Tabela de preço:''' No caso de pedidos do tipo 55 (PDV) será possível filtra-los através da tabela de preço utilizada (seja no cabeçalho ou por item). Neste campo só poderão ser exibidas tabelas de preço que em seu cadastro estejam configuradas para ser utilizadas com as filiais selecionadas no filtro '''Filiais'''. Este filtro só poderá ser utilizado caso no filtro '''Tipo de pedido''' esteja selecionado o tipo ''55''.
#*'''Vendedor:''' Neste campo poderão ser filtradas vendas de um determinado vendedor apenas.
#*'''Data de entrega:''' Neste campo as vendas poderão ser filtradas por data de entrega (caso possuam), seja a data por pedido ou por item.
#*'''Hora:''' Neste campo o usuário poderá filtrar pedidos realizados em uma determinada faixa de horário.
#*'''Operador de caixa:''' Neste campo o usuário poderá filtrar vendas realizadas por um determinado operador de caixa. Este filtro só vai aparecer caso o usuário tenha fechamento de caixa, configurado no PDV, aba "Faturamento".
#*'''Operação:''' Este filtro permitirá ao usuário selecionar uma '''operação de saída''' específica para a filtragem dos pedidos. É importante ressaltar que, quando utilizado o filtro em questão, serão listados na consulta '''todos''' os pedidos emitidos com a operação selecionada '''independente''' se o parâmetro '''Considerar em vendas''' está ativado '''ou não''' em seu cadastro. À direita do filtro deverá ser exibido o texto: ''Lista pedidos cuja operação '''não''' considera em vendas''.
#*'''Faturamento:''' Campo onde o usuário poderá filtrar pedidos do tipo 51 e 55 pela forma em que foram faturados com as seguintes opções:
#**'''Todos:''' Opção padrão que '''não''' filtra pedidos por uma determinada forma de pagamento, neste caso todas as formas de pagamento serão consideradas.
#**'''Dinheiro:''' Traz pedidos que contenham em seu faturamento a forma de pagamento '''Dinheiro'''.
#**'''Cartão:''' Com esta opção selecionada o sistema considerará pedidos que contenham em seu faturamento a forma de pagamento '''Cartão'''. Caso esta opção seja selecionada serão exibidos à direita do campo '''Faturamento''' outros dois ''comboboxes'' conforme segue abaixo:
#**#'''Cartão:''' Campo onde serão listadas as administradoras de cartão cadastradas e ativas no sistema.
#**#'''Plano:''' Habilitado somente após o cartão ser selecionado, este campo listará os planos de financeira ativos e vinculados ao cartão em questão.
#**'''Cheque:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Cheque'''.
#**'''Receber:''' Com esta opção selecionada o sistema considerará todos pedidos que contenham em seu faturamento a forma de pagamento '''Receber'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o ''combobox'' '''Prazo''', que listará as formas de pagamento cadastradas caso usuário deseje filtrar pedidos cujo receber foi gerar com uma delas. Parcelas avulsas '''não''' serão consideradas no ''combobox'' '''Prazo''', e se o mesmo for deixado em branco na filtragem de pedidos cujo faturamento contem a forma de pagamento '''Receber''' serão considerados todos os prazos e também as parcelas avulsas.
#**'''Crédito:''' Traz todos os pedidos que contenham em seu faturamento a forma de pagamento '''Crédito'''.
#**'''Convênio:''' Com esta opção selecionada o sistema considerará todos os pedidos que contenham em seu faturamento a forma de pagamento '''Convênio'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o combobox '''Bandeira''', que listará todos os convênios cadastrados e ativos caso usuário deseje filtrar pedidos cujo faturamento utilizou convênio de uma bandeira específica. Se o ''combobox'' '''Bandeira''' for deixado em branco, na filtragem de pedidos cujo faturamento contém convênio serão consideradas todas as bandeiras.
#**'''Depósito:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Depósito'''.
#'''Dados do cliente'''
#*'''Cliente:''' Neste campo o usuário poderá filtrar vendas realizadas para um determinado cliente.
#*'''Segmento:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de um determinado segmento.
#*'''Classificação:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de uma determinada classificação.
#*'''Rota:''' Neste campo o usuário poderá filtrar vendas para todos clientes de uma determinada rota.
#*'''Região (Estado e cidade):''' Nestes campos pedidos poderão ser filtrados por região, onde de acordo com os dados informados, serão considerados o estado e a cidade dos clientes dos pedidos.
#'''Dados do item'''
#*'''Item:''' Neste campo o usuário poderá informar um determinado item (produto ou serviço) cujas vendas deseja visualizar. Ou seja, se informado, só listar as vendas que tiveram este item informado (mesmo que tenha outros).
#*'''Telefonia:''' Conjunto de filtros que estarão dentro do agrupamento '''Dados do item''', mas que serão visíveis somente quando o módulo utilizado for de telefonia.
#**Tabela de preço
#**Tipo de preço
#**Promoção

== RN02 - Grid da consulta ==
O grid deverá exibir dados que sejam coerentes com os filtros utilizados nas seguintes colunas:
#'''PDV:''' Caso registro listado no grid possua um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''DAV:''' Caso registro listado seja um DAV, será exibido um ícone (D) que quando acionado exibirá na tela a visualização do mesmo. Ao lado do ícone será exibido o número do DAV.
#'''ECF:''' Caso registro listado possua um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso registro listado possua nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.
#'''FILIAL:''' Filial em que a venda foi realizada (apenas código).
#'''TOTAL DA VENDA:''' Exibe o valor total do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''DATA DA VENDA:''' Mostra a data de faturamento do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''CLIENTE:''' Coluna onde será exibido o código+nome do cliente da venda.
#'''VENDEDOR:''' Código+nome do vendedor do pedido.
#'''TABELA DE PREÇO:''' Tabela de preço utilizada na venda (do cabeçalho).

Na 1ª à 4ª coluna do grid, a venda cujo tipo de operação possuir marcado o parâmetro '''Considerar em vendas'''
deverá ter seu número exibido em '''negrito'''.

Na parte superior do grid, na linha acima aos títulos das colunas deverão estar disponíveis as seguintes configurações:
#'''Tipo de visão ao imprimir:''' Determina a formatação e diagramação dos dados do relatório ao imprimir com as seguintes variações:
#*Faturamento analítico
#*Faturamento sintético
#*Somatório de vendas
#*Vendas por hora
#*Vendas por operador
#*Resumo diário
#*Vendas por grupo
#'''Gerar gráfico:''' Botão que quando acionado gera um gráfico com os registros filtrados.
#'''Imprimir:''' Botão que gera impressão dos registros filtrados.

== RN03 - Tipos/Visões de impressão da consulta ==
A consulta em questão possibilitará ao usuário gerar diferentes visões/impressões para os dados filtrados, com diferentes informações e formatações conforme descrito abaixo.


É importante ressaltar que todos os relatórios deverão ser implementados seguindo os padrões do sistema.
Os layouts/modelos deste documento tem como objetivo demonstrar os dados e diagramação de cada visão.

#'''Visão ''Faturamento sintético'':''' A visão de faturamento sintética consiste em exibir de forma mais sintética os dados dos pedidos agrupados e totalizados por filial com o total geral ao fim do relatório.
#'''Visão ''Faturamento analítico'':''' A visão de faturamento analítica tem o objetivo de detalhar cada pedido exibindo para os mesmos dados de cabeçalho e detalhamento dos itens. Cada pedido terá seu total bruto e líquido e ao final do relatório haverá um total geral.
#'''Visão ''Somatório de vendas'':''' A visão de somatória de vendas tem como objetivo detalhar e totalizar vendas por forma de pagamento, exibindo o cliente e o vendedor de cada pedido. Ao final do relatório é exibido o total geral, a quantidade de pedidos e a totalização das vendas por convênio/plano.
#'''Visão ''Vendas por hora'':''' A visão de vendas por hora tem como objetivo exibir, no período filtrado, a quantidade e o valor total dos pedidos agrupados por dia e hora. Ao final do resumo de cada dia será exibido o total do dia, o total das devoluções do dia, o saldo final do dia e também o total de pedidos daquele dia.
#'''Visão ''Vendas por operador'':''' A visão de vendas por operador consiste em exibir os itens vendidos pelos operadores detalhando por item a quantidade, preço médio de venda e total da venda. O relatório totalizará os dados por operador e também exibirá um total geral. Esta visão somente estará disponível caso na filtragem o campo '''Operador''' esteja habilitado.
#'''Visão ''Resumo diário'':''' A visão de resumo diário tem como objetivo totalizar as vendas por dia de acordo com período filtrado. Ao final será exibido um total geral.
#'''Visão ''Vendas por grupo'':''' A visão de vendas por grupo tem como objetivo agrupar e totalizar vendas por grupo e subgrupo, exibindo para cada grupo a quantidade vendida e a venda, em valor e em percentual. Ao final de cada agrupamento será apresentado um totalizador e ao final do relatório será apresentado um totalizador geral.
<gallery>
File:RelFatPedVisaoFaturamento.png|Visão '''''Faturamento sintético'''''
File:RelFatPedVisaoFaturamentoAnalitico.png|Visão '''Faturamento analítico'''
File:RelFatPedVisaoOperador.png|Visão '''''Vendas por operador'''
File:RelFatPedVisaoSomatoria.png|Visão '''''Somatório de vendas'''
File:RelFatPedVisaoVendasHora.jpg|Visão '''''Vendas por hora'''
File:RelFatPedVisaoResumoDiario.jpg|Visão '''''Resumo diário'''''
File:RelFatPedVisaoVendasGrupo.jpg|Visão '''''Vendas por grupo'''
</gallery>


O combobox que permite ao usuário selecionar o tipo de visão para impressão somente será habilitado após os resultados
da consulta serem listados no grid.


Quando a impressão dos dados resultar em mais de 1 página, independente da visão escolhida, os títulos/cabeçalhos das colunas deverão ser replicados em cada página gerada.

=== Telefonia ===
Para o módulo de telefonia as visões de ''Faturamento'' analítica e sintética terão diagramações diferenciadas (conforme respectivos layouts mais abaixo) onde:
*'''Faturamento sintético''' -> Equivalente ao ''antigo relatório de somatório de vendas resumido''.
*'''Faturamento analítico''' -> Equivalente ao ''antigo relatório de somatório de vendas detalhado''.


Os pedidos ou itens devolvidos deverão ser destacados na cor vermelha em ambas as visões citadas acima.

<gallery>
File:RelFatPedVisaoFaturamentoSinteticoTelefonia.png|Visão '''''Faturamento sintético Telefonia'''''
File:RelFatPedVisaoFaturamentoAnaliticoTelefonia.png|Visão '''''Faturamento analítico Telefonia'''''
</gallery>

Ainda, exclusivamente para o módulo de telefonia, em todas as visões de impressão disponíveis deverão ser adicionadas ao final do relatório páginas com totalizadores exclusivos do segmento de telefonia conforme segue abaixo:
*'''Total de vendas:''' Exibirá informações sobre os totais vendidos com os seguintes dados:
*#'''QUANTIDADE DE PEDIDOS:''' Quantidade de pedidos encontrados/considerados com base nos filtros informados.
*#'''TOTAL DE VENDAS:''' Somatória do valor total de cada venda considerada na filtragem dos dados. Lembrando que este é o total líquido, já considerando descontos, acréscimos, devoluções e etc.
*#'''DESCONTOS DA OPERADORA:''' Somatória dos valores de descontos de operadora informados nos itens dos pedidos considerados na filtragem.
*#'''DESCONTOS ITENS/GLOBAL:''' Somatória dos valores de descontos informados nos itens e/ou na finalização dos pedidos considerados na filtragem.
*#'''TOTAL DE TROCAS:''' Somatória das formas de pagamento do tipo ''troca'' existentes nos pedidos considerados na filtragem.
*#'''TOTAL DE DEVOLUÇÕES:''' Somatória dos pedidos e/ou itens que constam em notas fiscais de devolução.
*#'''CRÉD. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de créditos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''DÉB. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de débitos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''TOTAL GERAL:''' Exibe o total geral do período filtrado considerando os totalizadores acima na seguinte formula: '''''total de vendas + créditos avulsos no caixa - débitos avulsos no caixa - total de devoluções'''''.
*'''Lançamentos avulsos no caixa:''' Exibirá informações detalhadas sobre lançamentos avulsos de caixa realizados no período da filtragem nas seguintes colunas:
*#'''CONTA CAIXA:''' Conta onde o lançamento foi realizado.
*#'''DÉBITO/CRÉDITO:''' Informa se o lançamento foi de DÉBITO ou CRÉDITO.
*#'''SUBCAIXA:''' Informa o subcaixa utilizado no movimento de caixa.
*#'''DATA:''' Data em que o movimento de caixa foi realizado.
*#'''VALOR:''' Valor do movimento de caixa.
*'''Totais por forma de pagamento:''' Com base nos pedidos encontrados na consulta, exibira o total geral por forma de pagamento, ou seja:
*#'''DINHEIRO
*#'''CARTÃO:''' Este totalizador será dividido em '''mestre''', '''detalhe''' e '''sub-detalhe''' onde:
*#*'''Mestre:''' Exibe o total geral de '''todas''' as administradoras de cartão utilizadas.
*#*'''Detalhe:''' Exibe o total de cada administradora de cartão utilizada nos pedidos listados.
*#*'''Sub-detalhe:''' Exibe, para cada administradora listada no detalhe, o total por plano de financeira.
*#'''CHEQUE'''
*#'''RECEBER'''
*#'''CRÉDITO APROVEITADO'''
*#'''CRÉDITO GERADO:''' Este totalizador considera créditos gerados nos pedidos e também na devolução dos mesmos.
*#'''CONVÊNIO'''
*#'''DEPÓSITO'''
*#'''TROCA'''
*'''Vendas por grupo/subgrupo:''' Exibirá o total de vendas divido por grupo e subgrupo, sendo que os subgrupos ficarão agrupados dentro de seu respectivo grupo.
*'''Totais por serviço:''' Todos os serviços utilizados nos pedidos considerados na consulta serão agrupados e totalizados. Na listagem dos serviços o sistema fará o seguinte agrupamento:
*#'''Serviços da operadora:''' Serviços oficiais da operadora.
*#'''Serviços do lojista:''' Serviços cadastrados pelo próprio lojista.
*'''Unidades vendidas:''' Todos os produtos utilizados nos pedidos considerados na consulta serão agrupados e totalizados e listados nesta seção.
*'''Totais por plano/operação:''' Todos os planos e operações utilizados nos itens das vendas consideradas na consulta serão agrupados, totalizados e listados nas seguintes colunas:
*#'''PLANO'''
*#'''OPERAÇÃO'''
*#'''QTDE:''' Quantidade de ocorrências deste plano + operação dentre os pedidos listados na consulta.
*#'''VALOR'''

== RN04 - Graficos ==
Serão elegíveis para geração de gráficos as seguintes visões:
*Somatório de vendas
*Vendas por hora
*Resumo diário

Quando usuário acionar o botão que gera gráficos, o sistema deverá gerar uma mesma janela (pop-up) os gráficos citados acima permitindo que o usuário alterne entre os mesmos. Os gráficos deverão seguir os modelos sugeridos abaixo:
<gallery>
File:GraficoSomatoria.jpg|'''''Somatória de vendas'''''
File:GraficoVendasHora.jpg|'''''Vendas por hora'''''
File:GraficoResumoDiario.jpg|'''''Resumo diário'''''
</gallery>

== RN05 - Devoluções/Trocas ==
'''Devoluções''' deverão ser automaticamente deduzidas caso existam dentre os dados filtrados. No grid, estas deverão ser exibidas, na data em que foram realizadas, com a linha na cor vermelha e com valores negativos.

Pedidos que possuírem a forma de pagamento '''troca''' serão exibidos no grid na cor vermelha e com os valores normais do pedido.

Na visão '''Faturamento sintético''' a exibição de trocas e devoluções será semelhante à do grid, mostrando uma linha na cor vermelha com a devolução tendo valores negativos.

Na visão '''Faturamento analítico''' as devoluções e trocas deverão ser exibidas em forma de pedido com seus dados na cor vermelha logo abaixo de seu pedido de origem. No canto superior direito do pedido deverá haver um campo informando que o mesmo trata-se de uma devolução.

Na visão '''Vendas por operador''' as devoluções e trocas não serão exibidas. As vendas que possuem devolução simplesmente não serão consideradas (no caso de devolução total).

Na visão '''Somatório de vendas''' o valor das devoluções e trocas serão exibidos na respectiva coluna.

Nas visões '''Vendas por hora''', '''Resumo diário''' e '''Vendas por grupo''' trocas e devoluções não serão exibidas, mas seus valores serão deduzidos.

UC00089 - Consulta de faturamento por pedido

2015-04-20T14:16:34Z

Daniel: /* RN01 - Filtragem dos dados */

= Módulos/Sistemas =
*Resulth WEB Start
*Resulth WEB Business
*Resulth WEB ERP
*Resulth WEB Telefonia

= Objetivo =
*Consultar/exibir de forma sintética e analítica dados referentes ao faturamento.

= Atores =
*Usuário

= Pré-requisitos =
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta de faturamento por pedido'''. Este nome será utilizado para criar a página no Wiki
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =
Consultar vendas exibindo resultados com base nos diversos filtros disponíveis possibilitando ao usuário imprimi-los em diferentes visões/formatos e também gerar gráficos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina ''Menu > Consultas > Faturamento > Faturamento por pedido.''.
*Sistema exibe a tela inicial da rotina com a aba de filtragem aberta posicionando o foco no primeiro campo (filiais).

'''Fluxo 2:''' Usuário informa os filtros desejados e aciona o botão <Consultar>.
*Sistema verifica se existem movimentos pertinentes aos filtros utilizados.
*Se forem encontrados registros de vendas, sistema os exibe no grid.
*Se nenhum movimento for encontrado, sistema exibe informa ao usuário que de acordo com os filtros utilizados nenhum dado foi encontrado.

'''Fluxo 3:''' Com os resultados da consulta listados no grid, usuário clica sobre os ícones PDV, DAV, ECF ou NF.
*Sistema exibe o registro de venda referente ao ícone acionado.

'''Fluxo 4:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário seleciona no combobox o tipo de visão da consulta que deseja imprimir e em seguida aciona o botão <Imprimir> escolhendo o formato desejado.
*Sistema procede conforme regra de negócio [[#RN03 - Tipos/Visões de impressão da consulta | RN03]].

'''Fluxo 5:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário aciona o botão <Gerar gráfico>.
*Sistema procede conforme regra de negócio [[#RN04 - Graficos | RN04]].

== Fluxos alternativos ==
'''Fluxo 1:''' Ao acessar a rotina em questão usuário clica diretamente no botão [Consultar].
*Uma vez que por padrão a filial logada é selecionada e o período é preenchido com o mês corrente (com base na data de login), sistema filtra as vendas com base nestes dados e lista os resultados no grid caso existam.

'''Fluxo 2:''' Usuário acessa a rotina em questão e informa no filtro '''Operação''' uma determinada operação de saída.
*Sistema faz a consulta de todos os pedidos cuja operação corresponde a que foi informada no filtro, independente se o parâmetro '''Considerar em vendas''' está marcado '''ou não''' em seu cadastro.

'''Fluxo 3:''' Utilizando o módulo de '''telefonia''' o usuário acessa a rotina em questão, faz a filtragem dos dados optando por imprimi-los em seguida.
*Na filtragem, sistema procede conforme [[#RN01 - Filtragem dos dados | RN01]].
*Na impressão dos dados, sistema procede conforme [[#Telefonia | RN03]].

== Fluxos de exceções ==
'''Fluxo 1:''' Sem filtrar nenhum dado usuário fecha a aba de consulta e tenta clicar sobre os botões que geram gráfico e impressão.
*Enquanto o grid que exibe os resultados da consulta estiver vazio, sistema mantem os botões que geram gráfico e impressão desabilitados.
*Caso usuário posicione o mouse sobre estes botões, o seguinte ''hint'' será exibido: ''Este botão ficará ativo somente quando houver registros listados no grid.''

= Regras de negócio =
== RN01 - Filtragem dos dados ==
A filtragem dos dados será dividida em dois níveis. O primeiro nível, que será de preenchimento obrigatório, apresentará filtros essenciais para a busca dos dados. O segundo nível, que será opcional, apresentará filtros adicionais que permitirá uma melhor filtragem, organização e exibição dos dados.

Para os filtros de segundo nível o sistema deverá exibir apenas o nome da categoria dos mesmos. Quando usuário clicar sobe o nome de um determinado filtro, então o sistema renderizará os campos pertinentes ao mesmo. Após preencher os campos o usuário poderá oculta-los clicando novamente sobre o nome do filtro.

Uma vez que a rotina em questão atende a vários módulos serão destacados mais abaixo os filtros que são exclusivos de um determinado módulo. Os demais filtros que não estão destacados serão accessíveis em todos os módulos.


É importante ressaltar que um filtro '''não deverá anular o outro'''.

Primeiro nível:
#'''Filiais:''' Com a filial logada marcada como padrão e exibindo as demais filiais cujo usuário logado possui acesso conforme [[Padrões de desenvolvimento]].
#'''Período:''' Campo onde deverá ser informado um período de emissão ou de faturamento dependendo do tipo de período que o usuário optar. O usuário poderá informar também, mais de um período para filtrar as movimentações adicionando vários intervalos na lista do filtro. Por exemplo: ''O usuário pode filtrar as vendas realizadas em "01/12/2012 a 31/12/2012" e também as vendas realizadas em "01/12/2013 a 31/12/2013", com o intuito de comparar um período com o outro.''
#'''Usuário:''' Campo onde poderá ser selecionado um usuário dentre os cadastrados e ativos no sistema para filtrar somente vendas realizadas pelo mesmo.

Segundo nível:
#'''Dados do pedido'''
#*'''Somente faturados?''' Neste campo o usuário poderá optar por visualizar todos os pedidos (desmarcado) ou somente pedidos faturados (marcado).
#*'''Tipo de pedido:''' Neste filtro o usuário poderá filtrar suas vendas por tipo de pedido, selecionando os desejados. As opções serão:
#** '''51 - NF de saída''' para notas fiscais de saída.
#**'''55 - PDV''' para pedidos realizados no ponto de venda.
#**'''56 - CUPOM''' para cupons fiscais ou NFC-e´s realizadas no módulo ECF.
#*'''Tabela de preço:''' No caso de pedidos do tipo 55 (PDV) será possível filtra-los através da tabela de preço utilizada (seja no cabeçalho ou por item). Neste campo só poderão ser exibidas tabelas de preço que em seu cadastro estejam configuradas para ser utilizadas com as filiais selecionadas no filtro '''Filiais'''. Este filtro só poderá ser utilizado caso no filtro '''Tipo de pedido''' esteja selecionado o tipo ''55''.
#*'''Vendedor:''' Neste campo poderão ser filtradas vendas de um determinado vendedor apenas.
#*'''Data de entrega:''' Neste campo as vendas poderão ser filtradas por data de entrega (caso possuam), seja a data por pedido ou por item.
#*'''Hora:''' Neste campo o usuário poderá filtrar pedidos realizados em uma determinada faixa de horário.
#*'''Operador de caixa:''' Neste campo o usuário poderá filtrar vendas realizadas por um determinado operador de caixa. Este filtro só vai aparecer caso o usuário tenha fechamento de caixa, configurado no PDV, aba "Faturamento".
#*'''Operação:''' Este filtro permitirá ao usuário selecionar uma '''operação de saída''' específica para a filtragem dos pedidos. É importante ressaltar que, quando utilizado o filtro em questão, serão listados na consulta '''todos''' os pedidos emitidos com a operação selecionada '''independente''' se o parâmetro '''Considerar em vendas''' está ativado '''ou não''' em seu cadastro. À direita do filtro deverá ser exibido o texto: ''Lista pedidos cuja operação '''não''' considera em vendas''.
#*'''Faturamento:''' Campo onde o usuário poderá filtrar pedidos do tipo 51 e 55 pela forma em que foram faturados com as seguintes opções:
#**'''Todos:''' Opção padrão que '''não''' filtra pedidos por uma determinada forma de pagamento, neste caso todas as formas de pagamento serão consideradas.
#**'''Dinheiro:''' Traz pedidos que contenham em seu faturamento a forma de pagamento '''Dinheiro'''.
#**'''Cartão:''' Com esta opção selecionada o sistema considerará pedidos que contenham em seu faturamento a forma de pagamento '''Cartão'''. Caso esta opção seja selecionada serão exibidos à direita do campo '''Faturamento''' outros dois ''comboboxes'' conforme segue abaixo:
#**#'''Cartão:''' Campo onde serão listadas as administradoras de cartão cadastradas e ativas no sistema.
#**#'''Plano:''' Habilitado somente após o cartão ser selecionado, este campo listará os planos de financeira ativos e vinculados ao cartão em questão.
#**'''Cheque:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Cheque'''.
#**'''Receber:''' Com esta opção selecionada o sistema considerará todos pedidos que contenham em seu faturamento a forma de pagamento '''Receber'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o ''combobox'' '''Prazo''', que listará as formas de pagamento cadastradas caso usuário deseje filtrar pedidos cujo receber foi gerar com uma delas. Parcelas avulsas '''não''' serão consideradas no ''combobox'' '''Prazo''', e se o mesmo for deixado em branco na filtragem de pedidos cujo faturamento contem a forma de pagamento '''Receber''' serão considerados todos os prazos e também as parcelas avulsas.
#**'''Crédito:''' Traz todos os pedidos que contenham em seu faturamento a forma de pagamento '''Crédito'''.
#**'''Convênio:''' Com esta opção selecionada o sistema considerará todos os pedidos que contenham em seu faturamento a forma de pagamento '''Convênio'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o combobox '''Bandeira''', que listará todos os convênios cadastrados e ativos caso usuário deseje filtrar pedidos cujo faturamento utilizou convênio de uma bandeira específica. Se o ''combobox'' '''Bandeira''' for deixado em branco, na filtragem de pedidos cujo faturamento contém convênio serão consideradas todas as bandeiras.
#**'''Depósito:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Depósito'''.
#'''Dados do cliente'''
#*'''Cliente:''' Neste campo o usuário poderá filtrar vendas realizadas para um determinado cliente.
#*'''Segmento:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de um determinado segmento.
#*'''Classificação:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de uma determinada classificação.
#*'''Rota:''' Neste campo o usuário poderá filtrar vendas para todos clientes de uma determinada rota.
#*'''Região (Estado e cidade):''' Nestes campos pedidos poderão ser filtrados por região, onde de acordo com os dados informados, serão considerados o estado e a cidade dos clientes dos pedidos.
#'''Dados do item'''
#*'''Item:''' Neste campo o usuário poderá informar um determinado item (produto ou serviço) cujas vendas deseja visualizar. Ou seja, se informado, só listar as vendas que tiveram este item informado (mesmo que tenha outros).
#*'''Telefonia:''' Conjunto de filtros que estarão dentro do agrupamento '''Dados do item''', mas que serão visíveis somente quando o módulo utilizado for de telefonia.
#**Tabela de preço
#**Tipo de preço
#**Promoção

== RN02 - Grid da consulta ==
O grid deverá exibir dados que sejam coerentes com os filtros utilizados nas seguintes colunas:
#'''PDV:''' Caso registro listado no grid possua um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''DAV:''' Caso registro listado seja um DAV, será exibido um ícone (D) que quando acionado exibirá na tela a visualização do mesmo. Ao lado do ícone será exibido o número do DAV.
#'''ECF:''' Caso registro listado possua um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso registro listado possua nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.
#'''FILIAL:''' Filial em que a venda foi realizada (apenas código).
#'''TOTAL DA VENDA:''' Exibe o valor total do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''DATA DA VENDA:''' Mostra a data de faturamento do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''CLIENTE:''' Coluna onde será exibido o código+nome do cliente da venda.
#'''VENDEDOR:''' Código+nome do vendedor do pedido.
#'''TABELA DE PREÇO:''' Tabela de preço utilizada na venda (do cabeçalho).

Na 1ª à 4ª coluna do grid, a venda cujo tipo de operação possuir marcado o parâmetro '''Considerar em vendas'''
deverá ter seu número exibido em '''negrito'''.

Na parte superior do grid, na linha acima aos títulos das colunas deverão estar disponíveis as seguintes configurações:
#'''Tipo de visão ao imprimir:''' Determina a formatação e diagramação dos dados do relatório ao imprimir com as seguintes variações:
#*Faturamento analítico
#*Faturamento sintético
#*Somatório de vendas
#*Vendas por hora
#*Vendas por operador
#*Resumo diário
#*Vendas por grupo
#'''Gerar gráfico:''' Botão que quando acionado gera um gráfico com os registros filtrados.
#'''Imprimir:''' Botão que gera impressão dos registros filtrados.

== RN03 - Tipos/Visões de impressão da consulta ==
A consulta em questão possibilitará ao usuário gerar diferentes visões/impressões para os dados filtrados, com diferentes informações e formatações conforme descrito abaixo.


É importante ressaltar que todos os relatórios deverão ser implementados seguindo os padrões do sistema.
Os layouts/modelos deste documento tem como objetivo demonstrar os dados e diagramação de cada visão.

#'''Visão ''Faturamento sintético'':''' A visão de faturamento sintética consiste em exibir de forma mais sintética os dados dos pedidos agrupados e totalizados por filial com o total geral ao fim do relatório.
#'''Visão ''Faturamento analítico'':''' A visão de faturamento analítica tem o objetivo de detalhar cada pedido exibindo para os mesmos dados de cabeçalho e detalhamento dos itens. Cada pedido terá seu total bruto e líquido e ao final do relatório haverá um total geral.
#'''Visão ''Somatório de vendas'':''' A visão de somatória de vendas tem como objetivo detalhar e totalizar vendas por forma de pagamento, exibindo o cliente e o vendedor de cada pedido. Ao final do relatório é exibido o total geral, a quantidade de pedidos e a totalização das vendas por convênio/plano.
#'''Visão ''Vendas por hora'':''' A visão de vendas por hora tem como objetivo exibir, no período filtrado, a quantidade e o valor total dos pedidos agrupados por dia e hora. Ao final do resumo de cada dia será exibido o total do dia, o total das devoluções do dia, o saldo final do dia e também o total de pedidos daquele dia.
#'''Visão ''Vendas por operador'':''' A visão de vendas por operador consiste em exibir os itens vendidos pelos operadores detalhando por item a quantidade, preço médio de venda e total da venda. O relatório totalizará os dados por operador e também exibirá um total geral. Esta visão somente estará disponível caso na filtragem o campo '''Operador''' esteja habilitado.
#'''Visão ''Resumo diário'':''' A visão de resumo diário tem como objetivo totalizar as vendas por dia de acordo com período filtrado. Ao final será exibido um total geral.
#'''Visão ''Vendas por grupo'':''' A visão de vendas por grupo tem como objetivo agrupar e totalizar vendas por grupo e subgrupo, exibindo para cada grupo a quantidade vendida e a venda, em valor e em percentual. Ao final de cada agrupamento será apresentado um totalizador e ao final do relatório será apresentado um totalizador geral.
<gallery>
File:RelFatPedVisaoFaturamento.png|Visão '''''Faturamento sintético'''''
File:RelFatPedVisaoFaturamentoAnalitico.png|Visão '''Faturamento analítico'''
File:RelFatPedVisaoOperador.png|Visão '''''Vendas por operador'''
File:RelFatPedVisaoSomatoria.png|Visão '''''Somatório de vendas'''
File:RelFatPedVisaoVendasHora.jpg|Visão '''''Vendas por hora'''
File:RelFatPedVisaoResumoDiario.jpg|Visão '''''Resumo diário'''''
File:RelFatPedVisaoVendasGrupo.jpg|Visão '''''Vendas por grupo'''
</gallery>


O combobox que permite ao usuário selecionar o tipo de visão para impressão somente será habilitado após os resultados
da consulta serem listados no grid.


Quando a impressão dos dados resultar em mais de 1 página, independente da visão escolhida, os títulos/cabeçalhos das colunas deverão ser replicados em cada página gerada.

=== Telefonia ===
Para o módulo de telefonia as visões de ''Faturamento'' analítica e sintética terão diagramações diferenciadas (conforme respectivos layouts mais abaixo) onde:
*'''Faturamento sintético''' -> Equivalente ao ''antigo relatório de somatório de vendas resumido''.
*'''Faturamento analítico''' -> Equivalente ao ''antigo relatório de somatório de vendas detalhado''.


Os pedidos ou itens devolvidos deverão ser destacados na cor vermelha em ambas as visões citadas acima.

<gallery>
File:RelFatPedVisaoFaturamentoSinteticoTelefonia.png|Visão '''''Faturamento sintético Telefonia'''''
File:RelFatPedVisaoFaturamentoAnaliticoTelefonia.png|Visão '''''Faturamento analítico Telefonia'''''
</gallery>

Ainda, exclusivamente para o módulo de telefonia, em todas as visões de impressão disponíveis deverão ser adicionadas ao final do relatório páginas com totalizadores exclusivos do segmento de telefonia conforme segue abaixo:
*'''Total de vendas:''' Exibirá informações sobre os totais vendidos com os seguintes dados:
*#'''QUANTIDADE DE PEDIDOS:''' Quantidade de pedidos encontrados/considerados com base nos filtros informados.
*#'''TOTAL DE VENDAS:''' Somatória do valor total de cada venda considerada na filtragem dos dados. Lembrando que este é o total líquido, já considerando descontos, acréscimos, devoluções e etc.
*#'''DESCONTOS DA OPERADORA:''' Somatória dos valores de descontos de operadora informados nos itens dos pedidos considerados na filtragem.
*#'''DESCONTOS ITENS/GLOBAL:''' Somatória dos valores de descontos informados nos itens e/ou na finalização dos pedidos considerados na filtragem.
*#'''TOTAL DE TROCAS:''' Somatória das formas de pagamento do tipo ''troca'' existentes nos pedidos considerados na filtragem.
*#'''TOTAL DE DEVOLUÇÕES:''' Somatória dos pedidos e/ou itens que constam em notas fiscais de devolução.
*#'''CRÉD. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de créditos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''DÉB. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de débitos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''TOTAL GERAL:''' Exibe o total geral do período filtrado considerando os totalizadores acima na seguinte formula: '''''total de vendas + créditos avulsos no caixa - débitos avulsos no caixa - total de devoluções'''''.
*'''Lançamentos avulsos no caixa:''' Exibirá informações detalhadas sobre lançamentos avulsos de caixa realizados no período da filtragem nas seguintes colunas:
*#'''CONTA CAIXA:''' Conta onde o lançamento foi realizado.
*#'''DÉBITO/CRÉDITO:''' Informa se o lançamento foi de DÉBITO ou CRÉDITO.
*#'''SUBCAIXA:''' Informa o subcaixa utilizado no movimento de caixa.
*#'''DATA:''' Data em que o movimento de caixa foi realizado.
*#'''VALOR:''' Valor do movimento de caixa.
*'''Totais por forma de pagamento:''' Com base nos pedidos encontrados na consulta, exibira o total geral por forma de pagamento, ou seja:
*#'''DINHEIRO
*#'''CARTÃO:''' Este totalizador será dividido em '''mestre''', '''detalhe''' e '''sub-detalhe''' onde:
*#*'''Mestre:''' Exibe o total geral de '''todas''' as administradoras de cartão utilizadas.
*#*'''Detalhe:''' Exibe o total de cada administradora de cartão utilizada nos pedidos listados.
*#*'''Sub-detalhe:''' Exibe, para cada administradora listada no detalhe, o total por plano de financeira.
*#'''CHEQUE'''
*#'''RECEBER'''
*#'''CRÉDITO APROVEITADO'''
*#'''CRÉDITO GERADO:''' Este totalizador considera créditos gerados nos pedidos e também na devolução dos mesmos.
*#'''CONVÊNIO'''
*#'''DEPÓSITO'''
*#'''TROCA'''
*'''Vendas por grupo/subgrupo:''' Exibirá o total de vendas divido por grupo e subgrupo, sendo que os subgrupos ficarão agrupados dentro de seu respectivo grupo.
*'''Totais por serviço:''' Todos os serviços utilizados nos pedidos considerados na consulta serão agrupados e totalizados. Na listagem dos serviços o sistema fará o seguinte agrupamento:
*#'''Serviços da operadora:''' Serviços oficiais da operadora.
*#'''Serviços do lojista:''' Serviços cadastrados pelo próprio lojista.
*'''Unidades vendidas:''' Todos os produtos utilizados nos pedidos considerados na consulta serão agrupados e totalizados e listados nesta seção.
*'''Totais por plano/operação:''' Todos os planos e operações utilizados nos itens das vendas consideradas na consulta serão agrupados, totalizados e listados nas seguintes colunas:
*#'''PLANO'''
*#'''OPERAÇÃO'''
*#'''QTDE:''' Quantidade de ocorrências deste plano + operação dentre os pedidos listados na consulta.
*#'''VALOR'''

== RN04 - Graficos ==
Serão elegíveis para geração de gráficos as seguintes visões:
*Somatório de vendas
*Vendas por hora
*Resumo diário

Quando usuário acionar o botão que gera gráficos, o sistema deverá gerar uma mesma janela (pop-up) os gráficos citados acima permitindo que o usuário alterne entre os mesmos. Os gráficos deverão seguir os modelos sugeridos abaixo:
<gallery>
File:GraficoSomatoria.jpg|'''''Somatória de vendas'''''
File:GraficoVendasHora.jpg|'''''Vendas por hora'''''
File:GraficoResumoDiario.jpg|'''''Resumo diário'''''
</gallery>

== RN05 - Devoluções/Trocas ==
'''Devoluções''' deverão ser automaticamente deduzidas caso existam dentre os dados filtrados. No grid, estas deverão ser exibidas, na data em que foram realizadas, com a linha na cor vermelha e com valores negativos.

Pedidos que possuírem a forma de pagamento '''troca''' serão exibidos no grid na cor vermelha e com os valores normais do pedido.

Na visão '''Faturamento sintético''' a exibição de trocas e devoluções será semelhante à do grid, mostrando uma linha na cor vermelha com a devolução tendo valores negativos.

Na visão '''Faturamento analítico''' as devoluções e trocas deverão ser exibidas em forma de pedido com seus dados na cor vermelha logo abaixo de seu pedido de origem. No canto superior direito do pedido deverá haver um campo informando que o mesmo trata-se de uma devolução.

Na visão '''Vendas por operador''' as devoluções e trocas não serão exibidas. As vendas que possuem devolução simplesmente não serão consideradas (no caso de devolução total).

Na visão '''Somatório de vendas''' o valor das devoluções e trocas serão exibidos na respectiva coluna.

Nas visões '''Vendas por hora''', '''Resumo diário''' e '''Vendas por grupo''' trocas e devoluções não serão exibidas, mas seus valores serão deduzidos.

UC00089 - Consulta de faturamento por pedido

2015-04-20T14:14:21Z

Daniel: /* RN02 - Grid da consulta */

= Módulos/Sistemas =
*Resulth WEB Start
*Resulth WEB Business
*Resulth WEB ERP
*Resulth WEB Telefonia

= Objetivo =
*Consultar/exibir de forma sintética e analítica dados referentes ao faturamento.

= Atores =
*Usuário

= Pré-requisitos =
*No projeto da rotina, em ''confsrc > META-INF > messages > view.properties'' definir o nome como '''Consulta de faturamento por pedido'''. Este nome será utilizado para criar a página no Wiki
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =
Consultar vendas exibindo resultados com base nos diversos filtros disponíveis possibilitando ao usuário imprimi-los em diferentes visões/formatos e também gerar gráficos.

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:''' Usuário acessa a rotina ''Menu > Consultas > Faturamento > Faturamento por pedido.''.
*Sistema exibe a tela inicial da rotina com a aba de filtragem aberta posicionando o foco no primeiro campo (filiais).

'''Fluxo 2:''' Usuário informa os filtros desejados e aciona o botão <Consultar>.
*Sistema verifica se existem movimentos pertinentes aos filtros utilizados.
*Se forem encontrados registros de vendas, sistema os exibe no grid.
*Se nenhum movimento for encontrado, sistema exibe informa ao usuário que de acordo com os filtros utilizados nenhum dado foi encontrado.

'''Fluxo 3:''' Com os resultados da consulta listados no grid, usuário clica sobre os ícones PDV, DAV, ECF ou NF.
*Sistema exibe o registro de venda referente ao ícone acionado.

'''Fluxo 4:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário seleciona no combobox o tipo de visão da consulta que deseja imprimir e em seguida aciona o botão <Imprimir> escolhendo o formato desejado.
*Sistema procede conforme regra de negócio [[#RN03 - Tipos/Visões de impressão da consulta | RN03]].

'''Fluxo 5:''' Com os resultados da consulta listados no grid, na parte superior do grid usuário aciona o botão <Gerar gráfico>.
*Sistema procede conforme regra de negócio [[#RN04 - Graficos | RN04]].

== Fluxos alternativos ==
'''Fluxo 1:''' Ao acessar a rotina em questão usuário clica diretamente no botão [Consultar].
*Uma vez que por padrão a filial logada é selecionada e o período é preenchido com o mês corrente (com base na data de login), sistema filtra as vendas com base nestes dados e lista os resultados no grid caso existam.

'''Fluxo 2:''' Usuário acessa a rotina em questão e informa no filtro '''Operação''' uma determinada operação de saída.
*Sistema faz a consulta de todos os pedidos cuja operação corresponde a que foi informada no filtro, independente se o parâmetro '''Considerar em vendas''' está marcado '''ou não''' em seu cadastro.

'''Fluxo 3:''' Utilizando o módulo de '''telefonia''' o usuário acessa a rotina em questão, faz a filtragem dos dados optando por imprimi-los em seguida.
*Na filtragem, sistema procede conforme [[#RN01 - Filtragem dos dados | RN01]].
*Na impressão dos dados, sistema procede conforme [[#Telefonia | RN03]].

== Fluxos de exceções ==
'''Fluxo 1:''' Sem filtrar nenhum dado usuário fecha a aba de consulta e tenta clicar sobre os botões que geram gráfico e impressão.
*Enquanto o grid que exibe os resultados da consulta estiver vazio, sistema mantem os botões que geram gráfico e impressão desabilitados.
*Caso usuário posicione o mouse sobre estes botões, o seguinte ''hint'' será exibido: ''Este botão ficará ativo somente quando houver registros listados no grid.''

= Regras de negócio =
== RN01 - Filtragem dos dados ==
A filtragem dos dados será dividida em dois níveis. O primeiro nível, que será de preenchimento obrigatório, apresentará filtros essenciais para a busca dos dados. O segundo nível, que será opcional, apresentará filtros adicionais que permitirá uma melhor filtragem, organização e exibição dos dados.

Para os filtros de segundo nível o sistema deverá exibir apenas o nome da categoria dos mesmos. Quando usuário clicar sobe o nome de um determinado filtro, então o sistema renderizará os campos pertinentes ao mesmo. Após preencher os campos o usuário poderá oculta-los clicando novamente sobre o nome do filtro.

Uma vez que a rotina em questão atende a vários módulos serão destacados mais abaixo os filtros que são exclusivos de um determinado módulo. Os demais filtros que não estão destacados serão accessíveis em todos os módulos.


É importante ressaltar que um filtro '''não deverá anular o outro'''.

Primeiro nível:
#'''Filiais:''' Com a filial logada marcada como padrão e exibindo as demais filiais cujo usuário logado possui acesso conforme [[Padrões de desenvolvimento]].
#'''Período:''' Campo onde deverá ser informado um período de emissão ou de faturamento dependendo do tipo de período que o usuário optar. O usuário poderá informar também, mais de um período para filtrar as movimentações adicionando vários intervalos na lista do filtro. Por exemplo: ''O usuário pode filtrar as vendas realizadas em "01/12/2012 a 31/12/2012" e também as vendas realizadas em "01/12/2013 a 31/12/2013", com o intuito de comparar um período com o outro.''
#'''Usuário:''' Campo onde poderá ser selecionado um usuário dentre os cadastrados e ativos no sistema para filtrar somente vendas realizadas pelo mesmo.

Segundo nível:
#'''Dados do pedido'''
#*'''Somente faturados?''' Neste campo o usuário poderá optar por visualizar todos os pedidos (desmarcado) ou somente pedidos faturados (marcado).
#*'''Tipo de pedido:''' Neste filtro o usuário poderá filtrar suas vendas por tipo de pedido, selecionando os desejados. As opções serão '''51 - NF de saída''', '''55 - PDV''' e '''56 - CUPOM'''.
#*'''Tabela de preço:''' No caso de pedidos do tipo 55 (PDV) será possível filtra-los através da tabela de preço utilizada (seja no cabeçalho ou por item). Neste campo só poderão ser exibidas tabelas de preço que em seu cadastro estejam configuradas para ser utilizadas com as filiais selecionadas no filtro '''Filiais'''. Este filtro só poderá ser utilizado caso no filtro '''Tipo de pedido''' esteja selecionado o tipo ''55''.
#*'''Vendedor:''' Neste campo poderão ser filtradas vendas de um determinado vendedor apenas.
#*'''Data de entrega:''' Neste campo as vendas poderão ser filtradas por data de entrega (caso possuam), seja a data por pedido ou por item.
#*'''Hora:''' Neste campo o usuário poderá filtrar pedidos realizados em uma determinada faixa de horário.
#*'''Operador de caixa:''' Neste campo o usuário poderá filtrar vendas realizadas por um determinado operador de caixa. Este filtro só vai aparecer caso o usuário tenha fechamento de caixa, configurado no PDV, aba "Faturamento".
#*'''Operação:''' Este filtro permitirá ao usuário selecionar uma '''operação de saída''' específica para a filtragem dos pedidos. É importante ressaltar que, quando utilizado o filtro em questão, serão listados na consulta '''todos''' os pedidos emitidos com a operação selecionada '''independente''' se o parâmetro '''Considerar em vendas''' está ativado '''ou não''' em seu cadastro. À direita do filtro deverá ser exibido o texto: ''Lista pedidos cuja operação '''não''' considera em vendas''.
#*'''Faturamento:''' Campo onde o usuário poderá filtrar pedidos do tipo 51 e 55 pela forma em que foram faturados com as seguintes opções:
#**'''Todos:''' Opção padrão que '''não''' filtra pedidos por uma determinada forma de pagamento, neste caso todas as formas de pagamento serão consideradas.
#**'''Dinheiro:''' Traz pedidos que contenham em seu faturamento a forma de pagamento '''Dinheiro'''.
#**'''Cartão:''' Com esta opção selecionada o sistema considerará pedidos que contenham em seu faturamento a forma de pagamento '''Cartão'''. Caso esta opção seja selecionada serão exibidos à direita do campo '''Faturamento''' outros dois ''comboboxes'' conforme segue abaixo:
#**#'''Cartão:''' Campo onde serão listadas as administradoras de cartão cadastradas e ativas no sistema.
#**#'''Plano:''' Habilitado somente após o cartão ser selecionado, este campo listará os planos de financeira ativos e vinculados ao cartão em questão.
#**'''Cheque:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Cheque'''.
#**'''Receber:''' Com esta opção selecionada o sistema considerará todos pedidos que contenham em seu faturamento a forma de pagamento '''Receber'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o ''combobox'' '''Prazo''', que listará as formas de pagamento cadastradas caso usuário deseje filtrar pedidos cujo receber foi gerar com uma delas. Parcelas avulsas '''não''' serão consideradas no ''combobox'' '''Prazo''', e se o mesmo for deixado em branco na filtragem de pedidos cujo faturamento contem a forma de pagamento '''Receber''' serão considerados todos os prazos e também as parcelas avulsas.
#**'''Crédito:''' Traz todos os pedidos que contenham em seu faturamento a forma de pagamento '''Crédito'''.
#**'''Convênio:''' Com esta opção selecionada o sistema considerará todos os pedidos que contenham em seu faturamento a forma de pagamento '''Convênio'''. Caso esta opção seja selecionada será exibido logo à direita do campo '''Faturamento''' o combobox '''Bandeira''', que listará todos os convênios cadastrados e ativos caso usuário deseje filtrar pedidos cujo faturamento utilizou convênio de uma bandeira específica. Se o ''combobox'' '''Bandeira''' for deixado em branco, na filtragem de pedidos cujo faturamento contém convênio serão consideradas todas as bandeiras.
#**'''Depósito:''' Traz todos pedidos que contenham em seu faturamento a forma de pagamento '''Depósito'''.
#'''Dados do cliente'''
#*'''Cliente:''' Neste campo o usuário poderá filtrar vendas realizadas para um determinado cliente.
#*'''Segmento:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de um determinado segmento.
#*'''Classificação:''' Neste campo o usuário poderá filtrar vendas realizadas para todos clientes de uma determinada classificação.
#*'''Rota:''' Neste campo o usuário poderá filtrar vendas para todos clientes de uma determinada rota.
#*'''Região (Estado e cidade):''' Nestes campos pedidos poderão ser filtrados por região, onde de acordo com os dados informados, serão considerados o estado e a cidade dos clientes dos pedidos.
#'''Dados do item'''
#*'''Item:''' Neste campo o usuário poderá informar um determinado item (produto ou serviço) cujas vendas deseja visualizar. Ou seja, se informado, só listar as vendas que tiveram este item informado (mesmo que tenha outros).
#*'''Telefonia:''' Conjunto de filtros que estarão dentro do agrupamento '''Dados do item''', mas que serão visíveis somente quando o módulo utilizado for de telefonia.
#**Tabela de preço
#**Tipo de preço
#**Promoção

== RN02 - Grid da consulta ==
O grid deverá exibir dados que sejam coerentes com os filtros utilizados nas seguintes colunas:
#'''PDV:''' Caso registro listado no grid possua um pedido do tipo '''55 - PDV''', será exibido um ícone (P) que quando acionado exibirá na tela a visualização do pedido em questão. Logo ao lado do ícone, será exibido também o número do PDV.
#'''DAV:''' Caso registro listado seja um DAV, será exibido um ícone (D) que quando acionado exibirá na tela a visualização do mesmo. Ao lado do ícone será exibido o número do DAV.
#'''ECF:''' Caso registro listado possua um cupom fiscal ou uma NFC-e, será exibido um ícone (|||) que quando acionado irá proceder da seguinte maneira:
#*Se o pedido listado no grid for referente a um cupom fiscal, quando o ícone em questão for acionado será exibido ao usuário o ''preview'' do cupom fiscal.
#*Se pedido listado no grid for referente a uma NFC-e, quando o ícone for acionado será aberta para o usuário uma nova aba em seu navegador com o link de acesso à DANFE da NFC-e fornecido pelo módulo ECF na sincronização.
#'''NF:''' Caso registro listado possua nota fiscal, será exibido um ícone (F) que quando acionado exibirá na tela a DANFE da nota em questão. Ao lado do ícone será exibido o número da nota. Este ícone só será visível no grid para registros cuja nota fiscal possua o status '''100 - Autorizado o uso da NF-e'''.
#'''FILIAL:''' Filial em que a venda foi realizada (apenas código).
#'''TOTAL DA VENDA:''' Exibe o valor total do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''DATA DA VENDA:''' Mostra a data de faturamento do último movimento de venda cuja operação possui marcado em seu cadastro o parâmetro '''Considerar em vendas'''.
#'''CLIENTE:''' Coluna onde será exibido o código+nome do cliente da venda.
#'''VENDEDOR:''' Código+nome do vendedor do pedido.
#'''TABELA DE PREÇO:''' Tabela de preço utilizada na venda (do cabeçalho).

Na 1ª à 4ª coluna do grid, a venda cujo tipo de operação possuir marcado o parâmetro '''Considerar em vendas'''
deverá ter seu número exibido em '''negrito'''.

Na parte superior do grid, na linha acima aos títulos das colunas deverão estar disponíveis as seguintes configurações:
#'''Tipo de visão ao imprimir:''' Determina a formatação e diagramação dos dados do relatório ao imprimir com as seguintes variações:
#*Faturamento analítico
#*Faturamento sintético
#*Somatório de vendas
#*Vendas por hora
#*Vendas por operador
#*Resumo diário
#*Vendas por grupo
#'''Gerar gráfico:''' Botão que quando acionado gera um gráfico com os registros filtrados.
#'''Imprimir:''' Botão que gera impressão dos registros filtrados.

== RN03 - Tipos/Visões de impressão da consulta ==
A consulta em questão possibilitará ao usuário gerar diferentes visões/impressões para os dados filtrados, com diferentes informações e formatações conforme descrito abaixo.


É importante ressaltar que todos os relatórios deverão ser implementados seguindo os padrões do sistema.
Os layouts/modelos deste documento tem como objetivo demonstrar os dados e diagramação de cada visão.

#'''Visão ''Faturamento sintético'':''' A visão de faturamento sintética consiste em exibir de forma mais sintética os dados dos pedidos agrupados e totalizados por filial com o total geral ao fim do relatório.
#'''Visão ''Faturamento analítico'':''' A visão de faturamento analítica tem o objetivo de detalhar cada pedido exibindo para os mesmos dados de cabeçalho e detalhamento dos itens. Cada pedido terá seu total bruto e líquido e ao final do relatório haverá um total geral.
#'''Visão ''Somatório de vendas'':''' A visão de somatória de vendas tem como objetivo detalhar e totalizar vendas por forma de pagamento, exibindo o cliente e o vendedor de cada pedido. Ao final do relatório é exibido o total geral, a quantidade de pedidos e a totalização das vendas por convênio/plano.
#'''Visão ''Vendas por hora'':''' A visão de vendas por hora tem como objetivo exibir, no período filtrado, a quantidade e o valor total dos pedidos agrupados por dia e hora. Ao final do resumo de cada dia será exibido o total do dia, o total das devoluções do dia, o saldo final do dia e também o total de pedidos daquele dia.
#'''Visão ''Vendas por operador'':''' A visão de vendas por operador consiste em exibir os itens vendidos pelos operadores detalhando por item a quantidade, preço médio de venda e total da venda. O relatório totalizará os dados por operador e também exibirá um total geral. Esta visão somente estará disponível caso na filtragem o campo '''Operador''' esteja habilitado.
#'''Visão ''Resumo diário'':''' A visão de resumo diário tem como objetivo totalizar as vendas por dia de acordo com período filtrado. Ao final será exibido um total geral.
#'''Visão ''Vendas por grupo'':''' A visão de vendas por grupo tem como objetivo agrupar e totalizar vendas por grupo e subgrupo, exibindo para cada grupo a quantidade vendida e a venda, em valor e em percentual. Ao final de cada agrupamento será apresentado um totalizador e ao final do relatório será apresentado um totalizador geral.
<gallery>
File:RelFatPedVisaoFaturamento.png|Visão '''''Faturamento sintético'''''
File:RelFatPedVisaoFaturamentoAnalitico.png|Visão '''Faturamento analítico'''
File:RelFatPedVisaoOperador.png|Visão '''''Vendas por operador'''
File:RelFatPedVisaoSomatoria.png|Visão '''''Somatório de vendas'''
File:RelFatPedVisaoVendasHora.jpg|Visão '''''Vendas por hora'''
File:RelFatPedVisaoResumoDiario.jpg|Visão '''''Resumo diário'''''
File:RelFatPedVisaoVendasGrupo.jpg|Visão '''''Vendas por grupo'''
</gallery>


O combobox que permite ao usuário selecionar o tipo de visão para impressão somente será habilitado após os resultados
da consulta serem listados no grid.


Quando a impressão dos dados resultar em mais de 1 página, independente da visão escolhida, os títulos/cabeçalhos das colunas deverão ser replicados em cada página gerada.

=== Telefonia ===
Para o módulo de telefonia as visões de ''Faturamento'' analítica e sintética terão diagramações diferenciadas (conforme respectivos layouts mais abaixo) onde:
*'''Faturamento sintético''' -> Equivalente ao ''antigo relatório de somatório de vendas resumido''.
*'''Faturamento analítico''' -> Equivalente ao ''antigo relatório de somatório de vendas detalhado''.


Os pedidos ou itens devolvidos deverão ser destacados na cor vermelha em ambas as visões citadas acima.

<gallery>
File:RelFatPedVisaoFaturamentoSinteticoTelefonia.png|Visão '''''Faturamento sintético Telefonia'''''
File:RelFatPedVisaoFaturamentoAnaliticoTelefonia.png|Visão '''''Faturamento analítico Telefonia'''''
</gallery>

Ainda, exclusivamente para o módulo de telefonia, em todas as visões de impressão disponíveis deverão ser adicionadas ao final do relatório páginas com totalizadores exclusivos do segmento de telefonia conforme segue abaixo:
*'''Total de vendas:''' Exibirá informações sobre os totais vendidos com os seguintes dados:
*#'''QUANTIDADE DE PEDIDOS:''' Quantidade de pedidos encontrados/considerados com base nos filtros informados.
*#'''TOTAL DE VENDAS:''' Somatória do valor total de cada venda considerada na filtragem dos dados. Lembrando que este é o total líquido, já considerando descontos, acréscimos, devoluções e etc.
*#'''DESCONTOS DA OPERADORA:''' Somatória dos valores de descontos de operadora informados nos itens dos pedidos considerados na filtragem.
*#'''DESCONTOS ITENS/GLOBAL:''' Somatória dos valores de descontos informados nos itens e/ou na finalização dos pedidos considerados na filtragem.
*#'''TOTAL DE TROCAS:''' Somatória das formas de pagamento do tipo ''troca'' existentes nos pedidos considerados na filtragem.
*#'''TOTAL DE DEVOLUÇÕES:''' Somatória dos pedidos e/ou itens que constam em notas fiscais de devolução.
*#'''CRÉD. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de créditos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''DÉB. AVULSO NO CAIXA:''' Somatória de todos os lançamentos de débitos avulsos no caixa realizados no período da filtragem, independente do subcaixa ou da conta.
*#'''TOTAL GERAL:''' Exibe o total geral do período filtrado considerando os totalizadores acima na seguinte formula: '''''total de vendas + créditos avulsos no caixa - débitos avulsos no caixa - total de devoluções'''''.
*'''Lançamentos avulsos no caixa:''' Exibirá informações detalhadas sobre lançamentos avulsos de caixa realizados no período da filtragem nas seguintes colunas:
*#'''CONTA CAIXA:''' Conta onde o lançamento foi realizado.
*#'''DÉBITO/CRÉDITO:''' Informa se o lançamento foi de DÉBITO ou CRÉDITO.
*#'''SUBCAIXA:''' Informa o subcaixa utilizado no movimento de caixa.
*#'''DATA:''' Data em que o movimento de caixa foi realizado.
*#'''VALOR:''' Valor do movimento de caixa.
*'''Totais por forma de pagamento:''' Com base nos pedidos encontrados na consulta, exibira o total geral por forma de pagamento, ou seja:
*#'''DINHEIRO
*#'''CARTÃO:''' Este totalizador será dividido em '''mestre''', '''detalhe''' e '''sub-detalhe''' onde:
*#*'''Mestre:''' Exibe o total geral de '''todas''' as administradoras de cartão utilizadas.
*#*'''Detalhe:''' Exibe o total de cada administradora de cartão utilizada nos pedidos listados.
*#*'''Sub-detalhe:''' Exibe, para cada administradora listada no detalhe, o total por plano de financeira.
*#'''CHEQUE'''
*#'''RECEBER'''
*#'''CRÉDITO APROVEITADO'''
*#'''CRÉDITO GERADO:''' Este totalizador considera créditos gerados nos pedidos e também na devolução dos mesmos.
*#'''CONVÊNIO'''
*#'''DEPÓSITO'''
*#'''TROCA'''
*'''Vendas por grupo/subgrupo:''' Exibirá o total de vendas divido por grupo e subgrupo, sendo que os subgrupos ficarão agrupados dentro de seu respectivo grupo.
*'''Totais por serviço:''' Todos os serviços utilizados nos pedidos considerados na consulta serão agrupados e totalizados. Na listagem dos serviços o sistema fará o seguinte agrupamento:
*#'''Serviços da operadora:''' Serviços oficiais da operadora.
*#'''Serviços do lojista:''' Serviços cadastrados pelo próprio lojista.
*'''Unidades vendidas:''' Todos os produtos utilizados nos pedidos considerados na consulta serão agrupados e totalizados e listados nesta seção.
*'''Totais por plano/operação:''' Todos os planos e operações utilizados nos itens das vendas consideradas na consulta serão agrupados, totalizados e listados nas seguintes colunas:
*#'''PLANO'''
*#'''OPERAÇÃO'''
*#'''QTDE:''' Quantidade de ocorrências deste plano + operação dentre os pedidos listados na consulta.
*#'''VALOR'''

== RN04 - Graficos ==
Serão elegíveis para geração de gráficos as seguintes visões:
*Somatório de vendas
*Vendas por hora
*Resumo diário

Quando usuário acionar o botão que gera gráficos, o sistema deverá gerar uma mesma janela (pop-up) os gráficos citados acima permitindo que o usuário alterne entre os mesmos. Os gráficos deverão seguir os modelos sugeridos abaixo:
<gallery>
File:GraficoSomatoria.jpg|'''''Somatória de vendas'''''
File:GraficoVendasHora.jpg|'''''Vendas por hora'''''
File:GraficoResumoDiario.jpg|'''''Resumo diário'''''
</gallery>

== RN05 - Devoluções/Trocas ==
'''Devoluções''' deverão ser automaticamente deduzidas caso existam dentre os dados filtrados. No grid, estas deverão ser exibidas, na data em que foram realizadas, com a linha na cor vermelha e com valores negativos.

Pedidos que possuírem a forma de pagamento '''troca''' serão exibidos no grid na cor vermelha e com os valores normais do pedido.

Na visão '''Faturamento sintético''' a exibição de trocas e devoluções será semelhante à do grid, mostrando uma linha na cor vermelha com a devolução tendo valores negativos.

Na visão '''Faturamento analítico''' as devoluções e trocas deverão ser exibidas em forma de pedido com seus dados na cor vermelha logo abaixo de seu pedido de origem. No canto superior direito do pedido deverá haver um campo informando que o mesmo trata-se de uma devolução.

Na visão '''Vendas por operador''' as devoluções e trocas não serão exibidas. As vendas que possuem devolução simplesmente não serão consideradas (no caso de devolução total).

Na visão '''Somatório de vendas''' o valor das devoluções e trocas serão exibidos na respectiva coluna.

Nas visões '''Vendas por hora''', '''Resumo diário''' e '''Vendas por grupo''' trocas e devoluções não serão exibidas, mas seus valores serão deduzidos.

UC00099 - Integração Java/ECF

2015-04-20T13:56:39Z

Daniel: /* Fluxos de exceção */

= Objetivo =

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =

= Diagrama de classes =
[[File:ECF.png|400px]]

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:'''

== Fluxos alternativos ==
'''Fluxo 1:''' Com os [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros de ECF da filial logada]] configurados como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', o usuário faz um pedido no Resulth WEB que contem produtos e serviços e em seguida tenta importa-lo no ECF.
*O ECF importará o pedido normalmente, mas '''considerará somente os produtos''' do mesmo. Enquanto '''OPERAÇÃO DO PAF = NFC-e''' os '''serviços serão desprezados''' na importação de pedidos.

'''Fluxo 2:''' Usuário acessa no Resulth WEB o cadastro de operações de saída e entra em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando '''somente''' o estado do parâmetro '''Gera contabilidade''' e acionando o botão '''[Salvar]''' em seguida.
*Desde que tenha sido alterado '''somente''' o estado do parâmetro '''Gera contabilidade''' na aba '''Movimentos''', o sistema irá atualizar o cadastro da operação em questão.

== Fluxos de exceção ==
'''Fluxo 1:''' Usuário inicializa o módulo ECF, sendo que ele possui em uma determinada filial dois ou mais ECF´s cujas configurações estão diferentes uma da outra.
*Se nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] as configurações de todos os ECF´s/PDV´s não forem '''exatamente iguais para a filial logada''', será emitida ao usuário a seguinte mensagem de alerta: ''Para a filial XXX - XXXXXX existem um ou mais ECF´s cujas configurações diferem dos demais. É altamente recomendado que todos os ECF´s utilizem a mesma configuração.'' Onde X corresponde ao código e nome da filial.
*A mensagem será apenas um alerta e não impedirá o usuário de prosseguir com seu fluxo.

'''Fluxo 2:''' No Resulth WEB o usuário acessa o cadastro de operação de saída entrando em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando configurações que sejam '''diferentes''' do parâmetro '''Gera contabilidade''' acionando o botão '''[Salvar]''' em seguida.
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido alterar as configurações desta operação, pois suas configurações são definidas por padrão no sistema e a mesma é utilizada na sincronização de dados com o módulo ECF.''

'''Fluxo 3:''' No Resulth WEB o usuário acessa o cadastro de operação de saída e tenta excluir uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]].
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido excluir esta operação, pois a mesma é utilizada na sincronização de dados com o módulo ECF.''

= Regras de negócio =
== RN01 - Operações ==
=== VENDA DIRETA NO ECF ===
Operação padrão do sistema para vendas realizadas diretamente no ECF que serão sincronizadas/enviadas para o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Sim''
#Considera em comissão = ''Sim''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Sim'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA NO ECF IMPORTANDO PDV ===
Operação padrão do sistema para vendas no ECF através da importação de PDV ('''não será utilizada na importação de DAV''') que serão sincronizadas com o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA DIRETA NO ECF OU IMPORTAÇÃO DE PEDIDO PARA EMISSÃO DE NFC-e ===
Tanto vendas diretas no ECF quanto importação de PDV´s que resultem na emissão de NFC-e, na sincronização com o Resulth WEB será gerado um documento fiscal de saída e para este deverá ser utilizada uma operação com as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Não'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera SPED Contribuições = '''Sim'''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''


Para pedidos do tipo OS não será necessário ter uma operação padrão definida uma vez que as movimentações de estoque e geração do financeiro '''já foram realizados'''.
Em outras palavras, o cupom gerado para um pedido de OS '''não''' movimentará estoque nem gerará financeiro.


Pedidos do tipo DAV não podem movimentar estoque e nem gerar financeiro. Sendo assim, quando importados no ECF, as movimentações serão geradas quando o cupom for
sincronizado com o Resulth WEB a exemplo de como ocorre com a venda direta no ECF.


Operações padrão para integração com o ECF '''não''' podem ser alteradas ou excluídas pelo usuário.

== RN02 - Sincronização ==
=== PDV´s importados para o ECF ===
Ao importar PDV´s para o ECF as seguintes regras devem ser observadas:
#'''PDV´s que já movimentaram estoque:''' Estes pedidos serão listados no ECF junto com os demais pedidos que ainda não movimentaram estoque, porém não poderão ser importados para emissão do cupom. Caso usuário informe diretamente o código ou selecione na filtragem um PDV que já movimentou estoque, o ECF abortará a importação do mesmo e emitirá ao usuário a seguinte mensagem de alerta: ''A emissão de cupom fiscal a partir da importação de um PDV é configurada por padrão para movimentar estoque e portanto o pedido selecionado não poderá ser importado, uma vez que ele já movimentou estoque de seus itens.''
#'''Formas de pagamento:''' As formas de pagamento utilizadas no encerramento do cupom deverão ser compatíveis com as formas de pagamento do PDV importado. Para isto, quando um PDV for importado para o ECF, o sistema (ECF) deverá '''desabilitar''' todas as formas de pagamento e preencher automaticamente os valores de cada uma conforme as formas de pagamento utilizadas no PDV.
#*Se o ECF estiver configurado para '''não''' importar serviço e um determinado PDV '''conter''' serviço(s), para esta importação em específico as regras acima deverão ser desconsideradas.
#*Caso no PDV tenha sido utilizada a forma de pagamento ''financeira'', ao preencher automaticamente as formas de pagamento no encerramento do cupom o sistema considerará o total financiado como '''dinheiro'''.

Os cupons dos PDV´s importados para o ECF serão enviados para o Resulth WEB, e neste ponto será gerado o movimento de estoque dos itens de cada cupom utilizando a operação '''VENDA NO ECF IMPORTANDO PDV''' conforme regra de negócio [[#RN01 - Operações | RN01]].

=== Vendas diretas e DAV´s importados ===
Os cupons dos DAV´s importados e das vendas feitas diretamente no ECF serão enviados para o Resulth WEB, e neste ponto serão gerados os movimentos de estoque dos itens e também o financeiro de acordo com as formas de pagamento informadas em cada cupom utilizando a operação '''VENDA DIRETA NO ECF''' conforme regra de negócio [[#RN01 - Operações | RN01]].

Antes de gerar o financeiro para os cupons sincronizados, o sistema deverá verificar nos parâmetros do PDV:
#'''Gerar movimento de caixa para as vendas?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa informado para centralizar vendas do PDV (logo à direita do parâmetro em questão) serão gerados movimentos de caixa para cada cupom com o subcaixa informado.
#'''Utiliza fechamento de caixa?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa do operador que emitiu os cupons serão gerados movimentos de caixa.
#Independente se '''Gerar movimento de caixa para as vendas? = Sim''' ou '''Utiliza fechamento de caixa? = Sim''', ao gerar movimento de caixa será considerado:
#*Se a opção '''Para todas as vendas''' estiver marcada como '''Sim''', na conta caixa informada logo à sua direita será gerado o movimento de caixa com o valor total de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons.
#*Caso uma ou mais formas de pagamento esteja(m) marcada(s) como '''Sim''', na(s) conta(s) caixa informada(s) será(ão) gerado(s) movimento(s) de caixa com o(s) valor(es) da(s) respectiva(s) forma(s) de pagamento de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons. Se houver em um determinado cupom um forma de pagamento que está marcada nos parâmetros do PDV como '''Não''' e que não possui uma conta caixa informada, '''não será gerado movimento de caixa''' com o valor da mesma.

=== NFC-e ===
A sincronização entenderá que os procedimentos de NFC-e deverão ser realizados quando nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada, para o número de um determinado PDV/ECF, estiverem marcados os parâmetros '''OPERAÇÃO DO PAF = NFC-e''' e '''AMBIENTE NFC-e = Produção'''.

Uma vez que o sistema identificou que ao invés de cupom fiscal será sincronizada a NFC-e, o procedimento será o seguinte:
#Quando o ECF consumir o ''webservice'' de sincronização ao invés de popular o objeto '''DadosCupomDelphi''' com os dados do cupom a partir das tabelas VENDPDV e ENCERRA, ele deverá popular o objeto '''DadosNFCeDelphi''' com os dados do pedido da NFC-e (tabelas PEDIDOC e PEDIDOI), com os dados fiscais da mesma (tabelas NFSAIDI e NFSAIDC) e também com os dados eletrônicos complementares (tabela COMPLNFCE).
#Com o objeto '''DadosNFCeDelphi''' populado, será utilizada a classe '''MontaCupomFiscalImportacaoServiceImpl''' para preparar um objeto do tipo '''CupomFiscal''' e persisti-lo no banco de dados '''gravando no Resulth WEB o pedido da NFC-e exatamente na mesma estrutura onde é gravado o cupom fiscal'''.
#*O pedido da NFC-e deverá ser gravado no Resulth WEB com o mesmo código gerado pelo Delphi na tabela PEDIDOC.
#*Para NFC-e no atributo '''tipoCupom''' da classe '''CupomFiscal''' deverá ser informada a opção '''NFC-E'''. Este atributo foi criado para diferenciar o pedido da NFC-e do pedido do Cupom Fiscal e deverá ser criado com o valor padrão '''CUPOM_FISCAL''' para registros já existentes no banco de dados dos clientes.
#Em seguida deverá ser gerado um documento fiscal de saída para o pedido da NFC-e que fora gravado. Para isto poderá ser utilizada a classe '''PedidoNotaServiceImpl'''.
#Para preencher o documento fiscal o Resulth WEB '''não calculará nenhum imposto'''. Estes serão preenchidos a partir do XML da NFC-e que será sincronizado também. ''Para isto pode ser reaproveitado um recurso existente na importação de XML da nota de entrada, que preenche um objeto a partir de um arquivo XML que tenha a mesma estrutura da NF-e''.

== RN03 - Integração com controle de caixa/checkouts ==
Para vendas serem consideradas pelo controle de caixa, independente de sua origem, deverão ser observados:
*Caso de uso [[UC00066 - Abertura de caixa]].
*Caso de uso [[UC00067 - Controle de caixa]].
*Regra de negócio RN03 do caso de uso [[UC00064 - Parâmetros do PDV#Movimentação de caixa | UC00064 - Parâmetros do PDV]].
*Caso de uso [[UC00072 - Ponto de venda]].

=== Importação de PDV e OS para o ECF ===
Pedidos do tipo '''55''' e '''65''' importados para o ECF serão considerados pela rotina de controle de caixa '''descartando''' a existência do cupom fiscal uma vez que a geração do financeiro só pode ser realizada pelo PDV. Em outras palavras, OS´s e PDV´s serão considerados pelo controle de caixa normalmente (se o PDV for configurado para tal) independente deles terem sido importados para o ECF ou não.


Se o PDV gera financeiro, movimento no subcaixa do operador que possui caixa aberto será gerado pelo Resulth WEB.

=== Importação de DAV e venda direta no ECF ===
Partindo do pré-suposto que o DAV '''não''' movimenta estoque nem gera financeiro, após importado para o ECF o mesmo será tratado como uma venda direta ao sincronizar seu cupom com o Resulth WEB. Para vendas diretas no ECF o movimento de estoque e a geração do financeiro serão realizados quando os respectivos cupons forem sincronizados com o Resulth WEB.

Antes de cada venda direta ou a importação de um DAV, o sistema (ECF) deverá:
#'''Verificar se o retaguarda (Resulth WEB) utiliza fechamento de caixa:''' Na aba ''Faturamento'' dos parâmetros do PDV deverá ser verificado o estado do parâmetro '''Utiliza fechamento de caixa?'''. Se o parâmetro em questão estiver como '''Não''', os demais passos deverão ser ignorados e a venda direta ou importação do DAV procederá normalmente. Se o parâmetro estiver como '''Sim''', executar os próximos passos.
#'''Verificar se o caixa do operador foi/está aberto:''' Para que um determinado operador consiga vender ou importar DAV no ECF é necessário que seu caixa esteja aberto no retaguarda (Resulth WEB). Caso o caixa do operador não esteja aberto o sistema (ECF) deverá abortar a venda ou importação do DAV e emitir ao usuário uma mensagem de alerta com a não conformidade.
#*Caso '''não exista''' no retaguarda caixa aberto para o usuário/operador logado no ECF, exibir a mensagem: ''O sistema de retaguarda (Resulth WEB) está configurado para utilizar fechamento de caixa e não ha caixa aberto para o operador logado. Faça a abertura do caixa do operador em questão e tente novamente.''
#*Caso o caixa do usuário/operador já tenha sido '''fechado''', exibir a mensagem: ''O caixa do operador logado já foi fechado e portanto o mesmo não poderá realizar vendas.''

== RN04 - NFC-e ==
Em resumo a NFC-e será tratada/sincronizada como um cupom fiscal no Resulth WEB, ou seja, os dados de um pedido de NFC-e serão visualizados e considerados da mesma maneira que um pedido de cupom fiscal. O que irá diferenciar um pedido de cupom fiscal de um pedido de NFC-e no Resulth WEB será a existência de um documento fiscal (a NFC-e propriamente dita), que será criado para todas as NFC-e´s sincronizadas para o Resulth WEB e considerado também em rotinas fiscais como SPED e livros de saída.


No Resulth WEB o documento fiscal da NFC-e será contabilizado '''somente em rotinas/relatórios fiscais''', ou seja, '''não será possível visualizar ou manipular a NFC-e'''
'''em qualquer outra rotina do sistema'''. Para isto o usuário deverá utilizar os recursos do módulo ECF.


Todas as regras e validações já existentes para cupom fiscal '''deverão ser mantidas para NFC-e''', seja na venda direta ou na importação de pedido.

=== Visualização/Impressão do CUPOM/DANFE ===
Conforme citado acima, quaisquer operações pertinentes a NFC-e deverão ser realizadas no módulo ECF, inclusive a visualização ou impressão da DANFE. Em função disso nas rotinas do Resulth WEB onde hoje é gerado um ''preview'' do cupom fiscal, para NFC-e o procedimento será o seguinte:
#Na emissão de NFC-e, o módulo ECF deverá gravar em seu banco de dados o link para consulta da DANFE da NFC-e já com o respectivo HASH do QRCode. Note que o link de consulta da DANFE poderá variar de acordo com a UF onde a NFC-e foi emitida.
#Quando a NFC-e for sincronizada para o Resulth WEB, o ''webservice'' deverá transportar o link de acesso à DANFE para o atributo '''linkAcessoDANFE''' da classe '''DadosNFCeDelphi'''.
#Ao gravar o pedido da NFC-e no banco de dados do Resulth WEB o link de acesso à DANFE da NFC-e deverá ser gravado no atributo '''linkAcessoDanfeNFCe''' da classe '''CupomFiscal'''.
#Nas consultas do Resulth WEB onde hoje é exibido o ''preview'' do cupom, para NFC-e, quando usuário clicar no ícone será aberta uma nova aba no navegador com o link de consulta da DANFE.

==== Validações e regras de sincronização ====
#Somente serão sincronizadas para o Resulth WEB NFC-e´s cujo status junto a SEFAZ é '''Autorizada''' ou '''Cancelada'''.
#*A sincronização de NFC-e´s de status '''Cancelada''' deverá '''excluir completamente''' tanto o pedido quanto o documento fiscal de saída gerados no Resulth WEB desfazendo as respectivas movimentações financeiras e de estoque.
#Caso nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada o ECF esteja configurado como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', para pedidos realizados no Resulth WEB que contenham produtos e serviços importados para o ECF, '''serão considerados somente produtos'''.

==== DadosNFCeDelphi ====
{|class="wikitable"
|'''Atributo da classe DadosNFCeDelphi''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO ||
|-
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-style="background-color:#DCDCDC"
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-
| dataSaida || NFSAIDC || DATASAIDA ||
|-style="background-color:#DCDCDC"
| horaSaida || NFSAIDC || HORASAIDA ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| numeroNFCe || COMPLNFCE || NUMNFCE ||
|-
| numeroPedidoNFCe || PEDIDOC || CODPEDIDO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| status || COMPLNFCE || STATUS ||
|-style="background-color:#DCDCDC"
| tipoAmbiente || COMPLNFCE || TIPOAMBIENTE ||
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| xmlNFCe || -- || -- || Utilizar informação que vem no ''webservice''.
|}

=== Equivalência dos dados de documento fiscal ===
==== Cabeçalho da NFC-e ====
{|class="wikitable"
|'''Atributo da classe DocumentoSaida extends DocumentoFiscal''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| filial || NFSAIDC || CODEMPRESA || Código da filial do ECF correspondente a uma filial do Resulth WEB
|-
| pessoa || NFSAIDC || CODCLIENTE ||
|-style="background-color:#DCDCDC"
| numero || NFSAIDC || NUMNF ||
|-
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| modeloNotaFiscal || -- || -- || Utilizar modelo 65, ou seja, '''''NFC-e - Nota Fiscal Eletrônica ao Consumidor Final'''''
|-style="background-color:#DCDCDC"
| especieNotaFiscal || -- || -- || Utilizar o modelo '''NFC-e, //Nota Fiscal Eletrônica ao Consumidor Final'''
|-
| observacaoLivrosFiscais || NFSAIDC || OBSLIVROFISCAL ||
|-style="background-color:#DCDCDC"
| pagamento || -- || -- || Será gerado se no encerramento da NFC-e foi gerado contas a receber ou parcelas avulsas.
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| observacao || NFSAIDC || OBSERVACAO ||
|-
| numDocOrig || -- || -- || Armazena os documentos a receber gerados caso existam.
|-style="background-color:#DCDCDC"
| transportador || NFSAIDC || CODTRANSPT ||
|-
| notaFiscalEletronica || -- || -- ||
|-style="background-color:#DCDCDC"
| portalFiscalPrefeitura || -- || -- ||
|-
| pagamentosRetencoes || -- || -- ||
|-style="background-color:#DCDCDC"
| operacao || -- || -- ||
|-
| itens || NFSAIDI || -- || Ver tabela '''Itens da NFC-e'''.
|-style="background-color:#DCDCDC"
| dataSaida || NFSAIDC || DATASAIDA ||
|-
| horaSaida || NFSAIDC || HORASAIDA ||
|-style="background-color:#DCDCDC"
| cancelada || NFSAIDC || CANCELADO ||
|-
| notaManual || -- || -- ||
|-style="background-color:#DCDCDC"
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-
| pedidos || -- || -- || Utilizar o '''''CupomFiscal -> DoctoPedidoDevolucao''''' gerado na sincronização do pedido NFC-e para o Resulth WEB.
|-style="background-color:#DCDCDC"
| encerramento || -- || -- || Não gerar. O encerramento ficará na '''''CupomFiscal -> DoctoPedidoDevolucao'''''.
|-
| notasRetencaoPisCofinsCsll || -- || -- ||
|-style="background-color:#DCDCDC"
| pisCofinsCsllRetidoFonte || -- || -- ||
|-
| idNotaAdevolver || -- || -- ||
|}

==== Itens da NFC-e ====
{|class="wikitable"
|'''Atributo da classe ItemNota''' || '''TABELA BD ECF/Tag XML NFCe''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| nota|| -- || -- || Utilizar objeto gerado para o cabeçalho da NFC-e.
|-
| item || NFSAIDI || CODPROD ||
|-style="background-color:#DCDCDC"
| grade || NFSAIDI || CODGRADE || Irrelevante, pois o ''webservice'' de sincronização irá devolver o ID do RrelacionamentoGrade.
|-
| sequencia || -- || -- || Gerado automaticamente para notas digitadas.
|-style="background-color:#DCDCDC"
| cfop || <prod> || CFOP ||
|-
| quantidade || <prod> || qCom ||
|-style="background-color:#DCDCDC"
| quantidadeConvertida || -- || -- ||
|-
| unidade || <prod> || uCom ||
|-style="background-color:#DCDCDC"
| preco || <prod> || vUnCom ||
|-
| precoConvertido || -- || -- ||
|-style="background-color:#DCDCDC"
| iss || <ISSQN> ||
*vBC (Valor da Base de Cálculo do ISSQN)
*vAliq (Alíquota do ISSQN)
*vISSQN (Valor do ISSQN)
|| Inicialmente, a NFC-e (no ECF) '''não irá conter serviços'''.
|-
| ipi || <IPI> ||
*vBC (Valor da BC do IPI)
*pIPI (Alíquota do IPI)
*vIPI (Valor do IPI)
||
|-style="background-color:#DCDCDC"
| icm || <ICMSXX> ||
*vBC (Valor da BC do ICMS)
*pICMS (Alíquota do imposto)
*vICMS (Valor do ICMS)
|| Lembrando que o ''XX'' ao fim do nome da ''Tag'' do XML refere-se aos dois últimos dígitos do CST correspondente. Exemplo: ''<ICMS10> está para CST´s terminados em 10''; ''<ICMS20> está para CST´s terminados em 20''.
|-
| st || <ICMSXX> ||
*vBCST (Valor da BC do ICMS ST)
*pICMSST (Alíquota do imposto do ICMS ST)
*vICMSST (Valor do ICMS ST)
|| Lembrando que o ''XX'' ao fim do nome da ''Tag'' do XML refere-se aos dois últimos dígitos do CST correspondente. Exemplo: ''<ICMS10> está para CST´s terminados em 10''; ''<ICMS20> está para CST´s terminados em 20''.
|-style="background-color:#DCDCDC"
| stForaNF || -- || -- ||
|-
| pis || <PIS> ||
*vBC (Valor da Base de Cálculo do PIS)
*pPIS (Alíquota do PIS (em percentual)
*vPIS (Valor do PIS)
||
|-style="background-color:#DCDCDC"
| cofins || <COFINS> ||
*vBC (Valor da Base de Cálculo da COFINS)
*pCOFINS (Alíquota da COFINS (em percentual))
*vCOFINS (Valor da COFINS)
||
|-
| aproveitamentoCredito || -- || -- ||
|-style="background-color:#DCDCDC"
| descontoItem || <prod> || vDesc ||
|-
| totalItem || NFSAIDI || QUANTIDADE * PRECOUNIT ||
|-style="background-color:#DCDCDC"
| totalRateado || NFSAIDI || TOTALRATEADO ||
|-
| cst || NFSAIDI || CODTRIBUT ||
|-style="background-color:#DCDCDC"
| csosn || <ICMSSNXXX> ||
*CSOSN
|| Lembrando que o ''XXX'' ao fim do nome da ''Tag'' do XML refere-se aos três últimos dígitos do CSOSN correspondente. Exemplo: ''<ICMSSN101> está para CSOSN´s terminados em 101''; ''<ICMSSN102> está para CSOSN´s terminados em 102''.
|-
| rateio || -- || -- ||
|-style="background-color:#DCDCDC"
| seriaisDigitados || CONTSER || ||
|-
| lotesDigitados || -- || -- ||
|-style="background-color:#DCDCDC"
| itensNotaEntradaSerial || -- || -- ||
|-
| itensNotaEntradaLote || -- || -- ||
|-style="background-color:#DCDCDC"
| complemento || -- || -- ||
|-
| original || -- || -- ||
|-style="background-color:#DCDCDC"
| itemBonificado || -- || -- ||
|}

==== Dados eletrônicos da NFC-e ====
{|class="wikitable"
|'''Atributo da classe NotaFiscalEletronica''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| tipoNotaEletronica || -- || -- || Utilizar a opção '''NFC-e'''.
|-
| ambiente || -- || -- || Uma vez que serão sincronizadas somente NFC-e´s emitidas em ambiente de produção, utilizar a opção '''PRODUÇÃO'''.
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO || '''Alterar o tamanho deste campo''' no banco do Resulth WEB de 44 para 50.
|-
| codigoStatus || COMPLNFCE || STATUSPROC || Se neste campo estiver vazio ou nulo, utilizar a informação do campo '''STATUS''' da mesma tabela.
|-style="background-color:#DCDCDC"
| status || -- || -- || A descrição referente ao stauts informado no campo '''codigoStatus''' deverá ser passada para o ''webservice'' de sincronização em tempo de execução, uma vez que estas informações não ficam salvas no banco de dados, mas dentro do próprio código fonte do Delphi na ''unit'' '''GerarXMLNFe'''. Atenção para qual status será preenchido, levando em consideração que temos ''Status da ComplNFe'' e ''CÓDIGO RESULTADO DO PROCESSAMENTO DA SOLICITACAO (retorno SEFAZ)''
|-
| recibo || COMPLNFCE || RECEBIMENTOXML ||
|-style="background-color:#DCDCDC"
| dataHoraRecibo || COMPLNFCE || DATAHORAPROTOCOLO ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| statusInterno || -- || -- ||
|-
| enviouCartaCorrecao || -- || -- || Utilizar padrão '''''false'''''.
|-style="background-color:#DCDCDC"
| imprimiuDanfe || COMPLNFCE || IMPDANFE || S = true; N = false.
|-
| enviouEmail || -- || -- ||
|-style="background-color:#DCDCDC"
| falhaComunicacao || -- || -- ||
|-
| statusDisponibilizacao || -- || -- ||
|-style="background-color:#DCDCDC"
| nfse || -- || -- ||
|-
| xmlNFCe || -- || -- || Popular este objeto a partir das informações do atributo '''xmlNFCe''' da classe '''DadosNFCeDelphi'''.
|-style="background-color:#DCDCDC"
| xmlNFe || -- || -- ||
|-
| xmlNFSe || -- || -- ||
|-style="background-color:#DCDCDC"
| cartaCorrecao ||| -- || -- ||
|}

UC00099 - Integração Java/ECF

2015-04-20T13:56:29Z

Daniel: /* Fluxos de exceção */

= Objetivo =

= Atores =
*Usuário

= Pré-requisitos =
*Considerar documento [[Padrões de desenvolvimento]].

= Resultado esperado =

= Diagrama de classes =
[[File:ECF.png|400px]]

= Fluxo de eventos =
== Fluxos principais ==
'''Fluxo 1:'''

== Fluxos alternativos ==
'''Fluxo 1:''' Com os [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros de ECF da filial logada]] configurados como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', o usuário faz um pedido no Resulth WEB que contem produtos e serviços e em seguida tenta importa-lo no ECF.
*O ECF importará o pedido normalmente, mas '''considerará somente os produtos''' do mesmo. Enquanto '''OPERAÇÃO DO PAF = NFC-e''' os '''serviços serão desprezados''' na importação de pedidos.

'''Fluxo 2:''' Usuário acessa no Resulth WEB o cadastro de operações de saída e entra em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando '''somente''' o estado do parâmetro '''Gera contabilidade''' e acionando o botão '''[Salvar]''' em seguida.
*Desde que tenha sido alterado '''somente''' o estado do parâmetro '''Gera contabilidade''' na aba '''Movimentos''', o sistema irá atualizar o cadastro da operação em questão.

== Fluxos de exceção ==
'''Fluxo 1:''' Usuário inicializa o módulo ECF, sendo que ele possui em uma determinada filial dois ou mais ECF´s cujas configurações estão diferentes uma da outra.
*Se nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] as configurações de todos os ECF´s/PDV´s não forem '''exatamente iguais para a filial logada''', será emitida ao usuário a seguinte mensagem de alerta: ''Para a filial XXX - XXXXXX existem um ou mais ECF´s cujas configurações diferem dos demais. É altamente recomendado que todos os ECF´s utilizem a mesma configuração.'' Onde X corresponde ao código e nome da filial.
*A mensagem será apenas um alerta e não impedirá o usuário de prosseguir com seu fluxo.

'''Fluxo 2:''' No Resulth WEB o usuário acessa o cadastro de operação de saída entrando em modo de alteração em uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]] alterando configurações que sejam '''diferentes''' do parâmetro '''Gera contabilidade''' acionando o botão '''[Salvar]''' em seguida.
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido alterar as configurações desta operação, pois suas configurações são definidas por padrão no sistema e a mesma é utilizada na sincronização de dados com o módulo ECF.''

'''Fluxo 3:''' No Resulth WEB o usuário acessa o cadastro de operação de saída e tenta excluir uma das operações listadas na regra de negócio [[#RN01 - Operações | RN01]].
*Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: ''Não é permitido excluir esta operação, pois a mesma é utilizada na sincronização de dados com o módulo ECF.''

= Regras de negócio =
== RN01 - Operações ==
=== VENDA DIRETA NO ECF ===
Operação padrão do sistema para vendas realizadas diretamente no ECF que serão sincronizadas/enviadas para o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Sim''
#Considera em comissão = ''Sim''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Sim'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA NO ECF IMPORTANDO PDV ===
Operação padrão do sistema para vendas no ECF através da importação de PDV ('''não será utilizada na importação de DAV''') que serão sincronizadas com o Resulth WEB. Esta operação terá as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Sim'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''

=== VENDA DIRETA NO ECF OU IMPORTAÇÃO DE PEDIDO PARA EMISSÃO DE NFC-e ===
Tanto vendas diretas no ECF quanto importação de PDV´s que resultem na emissão de NFC-e, na sincronização com o Resulth WEB será gerado um documento fiscal de saída e para este deverá ser utilizada uma operação com as seguintes características:
#Ativa = ''Sim''
#Considera em vendas = ''Não''
#Considera em comissão = ''Não''
#Devolução de compras = ''Não''
#Gera contabilidade = ''Opcional''
#'''Gera estoque''' = '''''Não'''''
#'''Gera financeiro''' = '''''Não'''''
#Saída corresponde a uma NF feita manualmente = ''Não''
#Nota fiscal de ajuste = ''Não utiliza''
#Gera SPED Contribuições = '''Sim'''
#Gera livros fiscais = ''Sim''
#Permite bonificação = ''Não''
#Calcula ICMS = ''Sim''
#Calcula PIS = ''Sim''
#Calcula COFINS = ''Sim''
#Destacar/Informar ST manualmente = ''Não''
#Calcula IPI/Destacar = ''Não''


Para pedidos do tipo OS não será necessário ter uma operação padrão definida uma vez que as movimentações de estoque e geração do financeiro '''já foram realizados'''.
Em outras palavras, o cupom gerado para um pedido de OS '''não''' movimentará estoque nem gerará financeiro.


Pedidos do tipo DAV não podem movimentar estoque e nem gerar financeiro. Sendo assim, quando importados no ECF, as movimentações serão geradas quando o cupom for
sincronizado com o Resulth WEB a exemplo de como ocorre com a venda direta no ECF.


Operações padrão para integração com o ECF '''não''' podem ser alteradas ou excluídas pelo usuário.

== RN02 - Sincronização ==
=== PDV´s importados para o ECF ===
Ao importar PDV´s para o ECF as seguintes regras devem ser observadas:
#'''PDV´s que já movimentaram estoque:''' Estes pedidos serão listados no ECF junto com os demais pedidos que ainda não movimentaram estoque, porém não poderão ser importados para emissão do cupom. Caso usuário informe diretamente o código ou selecione na filtragem um PDV que já movimentou estoque, o ECF abortará a importação do mesmo e emitirá ao usuário a seguinte mensagem de alerta: ''A emissão de cupom fiscal a partir da importação de um PDV é configurada por padrão para movimentar estoque e portanto o pedido selecionado não poderá ser importado, uma vez que ele já movimentou estoque de seus itens.''
#'''Formas de pagamento:''' As formas de pagamento utilizadas no encerramento do cupom deverão ser compatíveis com as formas de pagamento do PDV importado. Para isto, quando um PDV for importado para o ECF, o sistema (ECF) deverá '''desabilitar''' todas as formas de pagamento e preencher automaticamente os valores de cada uma conforme as formas de pagamento utilizadas no PDV.
#*Se o ECF estiver configurado para '''não''' importar serviço e um determinado PDV '''conter''' serviço(s), para esta importação em específico as regras acima deverão ser desconsideradas.
#*Caso no PDV tenha sido utilizada a forma de pagamento ''financeira'', ao preencher automaticamente as formas de pagamento no encerramento do cupom o sistema considerará o total financiado como '''dinheiro'''.

Os cupons dos PDV´s importados para o ECF serão enviados para o Resulth WEB, e neste ponto será gerado o movimento de estoque dos itens de cada cupom utilizando a operação '''VENDA NO ECF IMPORTANDO PDV''' conforme regra de negócio [[#RN01 - Operações | RN01]].

=== Vendas diretas e DAV´s importados ===
Os cupons dos DAV´s importados e das vendas feitas diretamente no ECF serão enviados para o Resulth WEB, e neste ponto serão gerados os movimentos de estoque dos itens e também o financeiro de acordo com as formas de pagamento informadas em cada cupom utilizando a operação '''VENDA DIRETA NO ECF''' conforme regra de negócio [[#RN01 - Operações | RN01]].

Antes de gerar o financeiro para os cupons sincronizados, o sistema deverá verificar nos parâmetros do PDV:
#'''Gerar movimento de caixa para as vendas?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa informado para centralizar vendas do PDV (logo à direita do parâmetro em questão) serão gerados movimentos de caixa para cada cupom com o subcaixa informado.
#'''Utiliza fechamento de caixa?''' Se este parâmetro estiver marcado como '''Sim''', com o subcaixa do operador que emitiu os cupons serão gerados movimentos de caixa.
#Independente se '''Gerar movimento de caixa para as vendas? = Sim''' ou '''Utiliza fechamento de caixa? = Sim''', ao gerar movimento de caixa será considerado:
#*Se a opção '''Para todas as vendas''' estiver marcada como '''Sim''', na conta caixa informada logo à sua direita será gerado o movimento de caixa com o valor total de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons.
#*Caso uma ou mais formas de pagamento esteja(m) marcada(s) como '''Sim''', na(s) conta(s) caixa informada(s) será(ão) gerado(s) movimento(s) de caixa com o(s) valor(es) da(s) respectiva(s) forma(s) de pagamento de cada cupom utilizando o subcaixa que centraliza as vendas do PDV ou o subcaixa do operador que emitiu os cupons. Se houver em um determinado cupom um forma de pagamento que está marcada nos parâmetros do PDV como '''Não''' e que não possui uma conta caixa informada, '''não será gerado movimento de caixa''' com o valor da mesma.

=== NFC-e ===
A sincronização entenderá que os procedimentos de NFC-e deverão ser realizados quando nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada, para o número de um determinado PDV/ECF, estiverem marcados os parâmetros '''OPERAÇÃO DO PAF = NFC-e''' e '''AMBIENTE NFC-e = Produção'''.

Uma vez que o sistema identificou que ao invés de cupom fiscal será sincronizada a NFC-e, o procedimento será o seguinte:
#Quando o ECF consumir o ''webservice'' de sincronização ao invés de popular o objeto '''DadosCupomDelphi''' com os dados do cupom a partir das tabelas VENDPDV e ENCERRA, ele deverá popular o objeto '''DadosNFCeDelphi''' com os dados do pedido da NFC-e (tabelas PEDIDOC e PEDIDOI), com os dados fiscais da mesma (tabelas NFSAIDI e NFSAIDC) e também com os dados eletrônicos complementares (tabela COMPLNFCE).
#Com o objeto '''DadosNFCeDelphi''' populado, será utilizada a classe '''MontaCupomFiscalImportacaoServiceImpl''' para preparar um objeto do tipo '''CupomFiscal''' e persisti-lo no banco de dados '''gravando no Resulth WEB o pedido da NFC-e exatamente na mesma estrutura onde é gravado o cupom fiscal'''.
#*O pedido da NFC-e deverá ser gravado no Resulth WEB com o mesmo código gerado pelo Delphi na tabela PEDIDOC.
#*Para NFC-e no atributo '''tipoCupom''' da classe '''CupomFiscal''' deverá ser informada a opção '''NFC-E'''. Este atributo foi criado para diferenciar o pedido da NFC-e do pedido do Cupom Fiscal e deverá ser criado com o valor padrão '''CUPOM_FISCAL''' para registros já existentes no banco de dados dos clientes.
#Em seguida deverá ser gerado um documento fiscal de saída para o pedido da NFC-e que fora gravado. Para isto poderá ser utilizada a classe '''PedidoNotaServiceImpl'''.
#Para preencher o documento fiscal o Resulth WEB '''não calculará nenhum imposto'''. Estes serão preenchidos a partir do XML da NFC-e que será sincronizado também. ''Para isto pode ser reaproveitado um recurso existente na importação de XML da nota de entrada, que preenche um objeto a partir de um arquivo XML que tenha a mesma estrutura da NF-e''.

== RN03 - Integração com controle de caixa/checkouts ==
Para vendas serem consideradas pelo controle de caixa, independente de sua origem, deverão ser observados:
*Caso de uso [[UC00066 - Abertura de caixa]].
*Caso de uso [[UC00067 - Controle de caixa]].
*Regra de negócio RN03 do caso de uso [[UC00064 - Parâmetros do PDV#Movimentação de caixa | UC00064 - Parâmetros do PDV]].
*Caso de uso [[UC00072 - Ponto de venda]].

=== Importação de PDV e OS para o ECF ===
Pedidos do tipo '''55''' e '''65''' importados para o ECF serão considerados pela rotina de controle de caixa '''descartando''' a existência do cupom fiscal uma vez que a geração do financeiro só pode ser realizada pelo PDV. Em outras palavras, OS´s e PDV´s serão considerados pelo controle de caixa normalmente (se o PDV for configurado para tal) independente deles terem sido importados para o ECF ou não.


Se o PDV gera financeiro, movimento no subcaixa do operador que possui caixa aberto será gerado pelo Resulth WEB.

=== Importação de DAV e venda direta no ECF ===
Partindo do pré-suposto que o DAV '''não''' movimenta estoque nem gera financeiro, após importado para o ECF o mesmo será tratado como uma venda direta ao sincronizar seu cupom com o Resulth WEB. Para vendas diretas no ECF o movimento de estoque e a geração do financeiro serão realizados quando os respectivos cupons forem sincronizados com o Resulth WEB.

Antes de cada venda direta ou a importação de um DAV, o sistema (ECF) deverá:
#'''Verificar se o retaguarda (Resulth WEB) utiliza fechamento de caixa:''' Na aba ''Faturamento'' dos parâmetros do PDV deverá ser verificado o estado do parâmetro '''Utiliza fechamento de caixa?'''. Se o parâmetro em questão estiver como '''Não''', os demais passos deverão ser ignorados e a venda direta ou importação do DAV procederá normalmente. Se o parâmetro estiver como '''Sim''', executar os próximos passos.
#'''Verificar se o caixa do operador foi/está aberto:''' Para que um determinado operador consiga vender ou importar DAV no ECF é necessário que seu caixa esteja aberto no retaguarda (Resulth WEB). Caso o caixa do operador não esteja aberto o sistema (ECF) deverá abortar a venda ou importação do DAV e emitir ao usuário uma mensagem de alerta com a não conformidade.
#*Caso '''não exista''' no retaguarda caixa aberto para o usuário/operador logado no ECF, exibir a mensagem: ''O sistema de retaguarda (Resulth WEB) está configurado para utilizar fechamento de caixa e não ha caixa aberto para o operador logado. Faça a abertura do caixa do operador em questão e tente novamente.''
#*Caso o caixa do usuário/operador já tenha sido '''fechado''', exibir a mensagem: ''O caixa do operador logado já foi fechado e portanto o mesmo não poderá realizar vendas.''

== RN04 - NFC-e ==
Em resumo a NFC-e será tratada/sincronizada como um cupom fiscal no Resulth WEB, ou seja, os dados de um pedido de NFC-e serão visualizados e considerados da mesma maneira que um pedido de cupom fiscal. O que irá diferenciar um pedido de cupom fiscal de um pedido de NFC-e no Resulth WEB será a existência de um documento fiscal (a NFC-e propriamente dita), que será criado para todas as NFC-e´s sincronizadas para o Resulth WEB e considerado também em rotinas fiscais como SPED e livros de saída.


No Resulth WEB o documento fiscal da NFC-e será contabilizado '''somente em rotinas/relatórios fiscais''', ou seja, '''não será possível visualizar ou manipular a NFC-e'''
'''em qualquer outra rotina do sistema'''. Para isto o usuário deverá utilizar os recursos do módulo ECF.


Todas as regras e validações já existentes para cupom fiscal '''deverão ser mantidas para NFC-e''', seja na venda direta ou na importação de pedido.

=== Visualização/Impressão do CUPOM/DANFE ===
Conforme citado acima, quaisquer operações pertinentes a NFC-e deverão ser realizadas no módulo ECF, inclusive a visualização ou impressão da DANFE. Em função disso nas rotinas do Resulth WEB onde hoje é gerado um ''preview'' do cupom fiscal, para NFC-e o procedimento será o seguinte:
#Na emissão de NFC-e, o módulo ECF deverá gravar em seu banco de dados o link para consulta da DANFE da NFC-e já com o respectivo HASH do QRCode. Note que o link de consulta da DANFE poderá variar de acordo com a UF onde a NFC-e foi emitida.
#Quando a NFC-e for sincronizada para o Resulth WEB, o ''webservice'' deverá transportar o link de acesso à DANFE para o atributo '''linkAcessoDANFE''' da classe '''DadosNFCeDelphi'''.
#Ao gravar o pedido da NFC-e no banco de dados do Resulth WEB o link de acesso à DANFE da NFC-e deverá ser gravado no atributo '''linkAcessoDanfeNFCe''' da classe '''CupomFiscal'''.
#Nas consultas do Resulth WEB onde hoje é exibido o ''preview'' do cupom, para NFC-e, quando usuário clicar no ícone será aberta uma nova aba no navegador com o link de consulta da DANFE.

==== Validações e regras de sincronização ====
#Somente serão sincronizadas para o Resulth WEB NFC-e´s cujo status junto a SEFAZ é '''Autorizada''' ou '''Cancelada'''.
#*A sincronização de NFC-e´s de status '''Cancelada''' deverá '''excluir completamente''' tanto o pedido quanto o documento fiscal de saída gerados no Resulth WEB desfazendo as respectivas movimentações financeiras e de estoque.
#Caso nos [[UC00112 - Parâmetros por filial#RN06 - Integração ECF | parâmetros da filial]] logada o ECF esteja configurado como '''IMPORTA SERVIÇO = Sim''' e '''OPERAÇÃO DO PAF = NFC-e''', para pedidos realizados no Resulth WEB que contenham produtos e serviços importados para o ECF, '''serão considerados somente produtos'''.

==== DadosNFCeDelphi ====
{|class="wikitable"
|'''Atributo da classe DadosNFCeDelphi''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO ||
|-
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-style="background-color:#DCDCDC"
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-
| dataSaida || NFSAIDC || DATASAIDA ||
|-style="background-color:#DCDCDC"
| horaSaida || NFSAIDC || HORASAIDA ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| numeroNFCe || COMPLNFCE || NUMNFCE ||
|-
| numeroPedidoNFCe || PEDIDOC || CODPEDIDO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| status || COMPLNFCE || STATUS ||
|-style="background-color:#DCDCDC"
| tipoAmbiente || COMPLNFCE || TIPOAMBIENTE ||
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| xmlNFCe || -- || -- || Utilizar informação que vem no ''webservice''.
|}

=== Equivalência dos dados de documento fiscal ===
==== Cabeçalho da NFC-e ====
{|class="wikitable"
|'''Atributo da classe DocumentoSaida extends DocumentoFiscal''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| filial || NFSAIDC || CODEMPRESA || Código da filial do ECF correspondente a uma filial do Resulth WEB
|-
| pessoa || NFSAIDC || CODCLIENTE ||
|-style="background-color:#DCDCDC"
| numero || NFSAIDC || NUMNF ||
|-
| dataEmissao || NFSAIDC || DT_EMISSAO ||
|-style="background-color:#DCDCDC"
| serie || COMPLNFCE || SERIE ||
|-
| modeloNotaFiscal || -- || -- || Utilizar modelo 65, ou seja, '''''NFC-e - Nota Fiscal Eletrônica ao Consumidor Final'''''
|-style="background-color:#DCDCDC"
| especieNotaFiscal || -- || -- || Utilizar o modelo '''NFC-e, //Nota Fiscal Eletrônica ao Consumidor Final'''
|-
| observacaoLivrosFiscais || NFSAIDC || OBSLIVROFISCAL ||
|-style="background-color:#DCDCDC"
| pagamento || -- || -- || Será gerado se no encerramento da NFC-e foi gerado contas a receber ou parcelas avulsas.
|-
| valorNF || NFSAIDC || TOTALNF ||
|-style="background-color:#DCDCDC"
| observacao || NFSAIDC || OBSERVACAO ||
|-
| numDocOrig || -- || -- || Armazena os documentos a receber gerados caso existam.
|-style="background-color:#DCDCDC"
| transportador || NFSAIDC || CODTRANSPT ||
|-
| notaFiscalEletronica || -- || -- ||
|-style="background-color:#DCDCDC"
| portalFiscalPrefeitura || -- || -- ||
|-
| pagamentosRetencoes || -- || -- ||
|-style="background-color:#DCDCDC"
| operacao || -- || -- ||
|-
| itens || NFSAIDI || -- || Ver tabela '''Itens da NFC-e'''.
|-style="background-color:#DCDCDC"
| dataSaida || NFSAIDC || DATASAIDA ||
|-
| horaSaida || NFSAIDC || HORASAIDA ||
|-style="background-color:#DCDCDC"
| cancelada || NFSAIDC || CANCELADO ||
|-
| notaManual || -- || -- ||
|-style="background-color:#DCDCDC"
| dadoAdicionalNF || NFSAIDC || DADOSADIC ||
|-
| pedidos || -- || -- || Utilizar o '''''CupomFiscal -> DoctoPedidoDevolucao''''' gerado na sincronização do pedido NFC-e para o Resulth WEB.
|-style="background-color:#DCDCDC"
| encerramento || -- || -- || Não gerar. O encerramento ficará na '''''CupomFiscal -> DoctoPedidoDevolucao'''''.
|-
| notasRetencaoPisCofinsCsll || -- || -- ||
|-style="background-color:#DCDCDC"
| pisCofinsCsllRetidoFonte || -- || -- ||
|-
| idNotaAdevolver || -- || -- ||
|}

==== Itens da NFC-e ====
{|class="wikitable"
|'''Atributo da classe ItemNota''' || '''TABELA BD ECF/Tag XML NFCe''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| nota|| -- || -- || Utilizar objeto gerado para o cabeçalho da NFC-e.
|-
| item || NFSAIDI || CODPROD ||
|-style="background-color:#DCDCDC"
| grade || NFSAIDI || CODGRADE || Irrelevante, pois o ''webservice'' de sincronização irá devolver o ID do RrelacionamentoGrade.
|-
| sequencia || -- || -- || Gerado automaticamente para notas digitadas.
|-style="background-color:#DCDCDC"
| cfop || <prod> || CFOP ||
|-
| quantidade || <prod> || qCom ||
|-style="background-color:#DCDCDC"
| quantidadeConvertida || -- || -- ||
|-
| unidade || <prod> || uCom ||
|-style="background-color:#DCDCDC"
| preco || <prod> || vUnCom ||
|-
| precoConvertido || -- || -- ||
|-style="background-color:#DCDCDC"
| iss || <ISSQN> ||
*vBC (Valor da Base de Cálculo do ISSQN)
*vAliq (Alíquota do ISSQN)
*vISSQN (Valor do ISSQN)
|| Inicialmente, a NFC-e (no ECF) '''não irá conter serviços'''.
|-
| ipi || <IPI> ||
*vBC (Valor da BC do IPI)
*pIPI (Alíquota do IPI)
*vIPI (Valor do IPI)
||
|-style="background-color:#DCDCDC"
| icm || <ICMSXX> ||
*vBC (Valor da BC do ICMS)
*pICMS (Alíquota do imposto)
*vICMS (Valor do ICMS)
|| Lembrando que o ''XX'' ao fim do nome da ''Tag'' do XML refere-se aos dois últimos dígitos do CST correspondente. Exemplo: ''<ICMS10> está para CST´s terminados em 10''; ''<ICMS20> está para CST´s terminados em 20''.
|-
| st || <ICMSXX> ||
*vBCST (Valor da BC do ICMS ST)
*pICMSST (Alíquota do imposto do ICMS ST)
*vICMSST (Valor do ICMS ST)
|| Lembrando que o ''XX'' ao fim do nome da ''Tag'' do XML refere-se aos dois últimos dígitos do CST correspondente. Exemplo: ''<ICMS10> está para CST´s terminados em 10''; ''<ICMS20> está para CST´s terminados em 20''.
|-style="background-color:#DCDCDC"
| stForaNF || -- || -- ||
|-
| pis || <PIS> ||
*vBC (Valor da Base de Cálculo do PIS)
*pPIS (Alíquota do PIS (em percentual)
*vPIS (Valor do PIS)
||
|-style="background-color:#DCDCDC"
| cofins || <COFINS> ||
*vBC (Valor da Base de Cálculo da COFINS)
*pCOFINS (Alíquota da COFINS (em percentual))
*vCOFINS (Valor da COFINS)
||
|-
| aproveitamentoCredito || -- || -- ||
|-style="background-color:#DCDCDC"
| descontoItem || <prod> || vDesc ||
|-
| totalItem || NFSAIDI || QUANTIDADE * PRECOUNIT ||
|-style="background-color:#DCDCDC"
| totalRateado || NFSAIDI || TOTALRATEADO ||
|-
| cst || NFSAIDI || CODTRIBUT ||
|-style="background-color:#DCDCDC"
| csosn || <ICMSSNXXX> ||
*CSOSN
|| Lembrando que o ''XXX'' ao fim do nome da ''Tag'' do XML refere-se aos três últimos dígitos do CSOSN correspondente. Exemplo: ''<ICMSSN101> está para CSOSN´s terminados em 101''; ''<ICMSSN102> está para CSOSN´s terminados em 102''.
|-
| rateio || -- || -- ||
|-style="background-color:#DCDCDC"
| seriaisDigitados || CONTSER || ||
|-
| lotesDigitados || -- || -- ||
|-style="background-color:#DCDCDC"
| itensNotaEntradaSerial || -- || -- ||
|-
| itensNotaEntradaLote || -- || -- ||
|-style="background-color:#DCDCDC"
| complemento || -- || -- ||
|-
| original || -- || -- ||
|-style="background-color:#DCDCDC"
| itemBonificado || -- || -- ||
|}

==== Dados eletrônicos da NFC-e ====
{|class="wikitable"
|'''Atributo da classe NotaFiscalEletronica''' || '''TABELA BD ECF''' || '''CAMPO''' || '''OBSERVAÇÃO'''
|-style="background-color:#DCDCDC"
| tipoNotaEletronica || -- || -- || Utilizar a opção '''NFC-e'''.
|-
| ambiente || -- || -- || Uma vez que serão sincronizadas somente NFC-e´s emitidas em ambiente de produção, utilizar a opção '''PRODUÇÃO'''.
|-style="background-color:#DCDCDC"
| chaveAcesso || COMPLNFCE || CHAVEACESSO || '''Alterar o tamanho deste campo''' no banco do Resulth WEB de 44 para 50.
|-
| codigoStatus || COMPLNFCE || STATUSPROC || Se neste campo estiver vazio ou nulo, utilizar a informação do campo '''STATUS''' da mesma tabela.
|-style="background-color:#DCDCDC"
| status || -- || -- || A descrição referente ao stauts informado no campo '''codigoStatus''' deverá ser passada para o ''webservice'' de sincronização em tempo de execução, uma vez que estas informações não ficam salvas no banco de dados, mas dentro do próprio código fonte do Delphi na ''unit'' '''GerarXMLNFe'''. Atenção para qual status será preenchido, levando em consideração que temos ''Status da ComplNFe'' e ''CÓDIGO RESULTADO DO PROCESSAMENTO DA SOLICITACAO (retorno SEFAZ)''
|-
| recibo || COMPLNFCE || RECEBIMENTOXML ||
|-style="background-color:#DCDCDC"
| dataHoraRecibo || COMPLNFCE || DATAHORAPROTOCOLO ||
|-
| motivoCancelamento || COMPLNFCE || MOTIVOCANC ||
|-style="background-color:#DCDCDC"
| statusInterno || -- || -- ||
|-
| enviouCartaCorrecao || -- || -- || Utilizar padrão '''''false'''''.
|-style="background-color:#DCDCDC"
| imprimiuDanfe || COMPLNFCE || IMPDANFE || S = true; N = false.
|-
| enviouEmail || -- || -- ||
|-style="background-color:#DCDCDC"
| falhaComunicacao || -- || -- ||
|-
| statusDisponibilizacao || -- || -- ||
|-style="background-color:#DCDCDC"
| nfse || -- || -- ||
|-
| xmlNFCe || -- || -- || Popular este objeto a partir das informações do atributo '''xmlNFCe''' da classe '''DadosNFCeDelphi'''.
|-style="background-color:#DCDCDC"
| xmlNFe || -- || -- ||
|-
| xmlNFSe || -- || -- ||
|-style="background-color:#DCDCDC"
| cartaCorrecao ||| -- || -- ||
|}