Cálculo de Faturamento

Versão 1

DESCRIÇÃO

A tela de "Cálculo de Faturamento" permite realizar o cálculo e geração de fatura para os livros de leitura que estiverem selecionados Marcação dos Livros para Faturamento, como já criticados.

O cálculo é processado de acordo com o filtro de usuário e os critérios de faturamentos selecionados.

FINALIDADE

A aplicação permite realizar o cálculo de faturamento de duas formas: em tempo real ou programado em segundo plano para uma etapa inteira. É possível efetuar o cálculo para uma única UC, para várias UCs pertencentes a um livro cadastrado ou para uma etapa inteira, conforme a necessidade.

Além disso, se o campo Parâmetro de Crítica Financeira estiver ativado, isso indica que a empresa adota regras de crítica financeira para as faturas.

PRINCIPAIS CAMINHOS

Login ou acesso ao sistema > Página Inicial > Workspace de Faturamento > Cálculo de Faturamento.

FUNCIONALIDADES

Ao acessar o item de menu Cálculo de Faturamento, o usuário será direcionado para a tela abaixo, onde estão disponíveis todas as funcionalidades relacionadas. Para facilitar o entendimento, a tela será detalhada em seções, com explicações específicas sobre cada uma das suas funções.

Estrutura da Tela

A tela é dividida em duas áreas principais:

• Filtro do Usuário: Nesta seção, você pode aplicar filtros para segmentar as informações de acordo com os parâmetros definidos para o usuário.

• Critérios para Faturamento: Nesta seção, você pode definir os critérios para realizar o cálculo e geração da fatura dos livros de leitura que já foram marcados e criticados. A seção permite realiza o cálculo seja por uma UC específica, por um livro, por uma etapa ou com a aplicação de parâmetros de crítica financeira.

Filtro do Usuário

O Filtro do Usuário é alimentado pela aplicação Usuários, na qual são cadastrados os parâmetros para definir o que cada usuário pode filtrar na seção Filtro do Usuário. O filtro padrão de usuário possui 5 campos, sendo eles: empresa, regional, distrital, seccional e localidade.

• Empresa: campo parametrizado com os dados da empresa 0001 – Sonda.
• Regional: Este campo permite filtrar as informações de acordo com a regional. Digite o nome da regional ou selecione uma opção na lista suspensa para facilitar a escolha.
• Distrital: Este campo permite especificar a distrital desejada para o filtro. Você pode digitar o nome da distrital ou escolher diretamente na lista exibida.
• Seccional: Utilize este campo para escolher a seccional. Basta digitar o nome da seccional para visualizar sugestões automáticas ou selecionar uma opção na lista.
• Localidade: Este campo permite filtrar as informações por localidade específica. Digite o nome da localidade no campo de busca para ver as sugestões ou selecione diretamente da lista.

O Filtro do Usuário fica oculto por padrão, sendo exibido apenas quando o usuário decide expandi-lo.

Ao clicar para abrir, todos os campos mencionados ficam visíveis, permitindo que o usuário aplique os filtros desejados. Para economizar espaço na tela, o filtro pode ser recolhido novamente, ficando oculto até que o usuário precise usá-lo.

Critérios para Faturamento

Esta seção permite que o usuário realize o cálculo de faturamento com base nos dados informados. Abaixo, descreveremos o funcionamento dos campos principais e o processo para calcular o faturamento de acordo com cada cenário/possibilidades.

A seção de critérios para o faturamento conta com os seguintes campos:

• Cliente: Ao informar uma UC válida, o nome do cliente será preenchido automaticamente.
• Livro: Informe um livro cadastrado.
• Etapa: Selecione a etapa desejada.
• Referência: Selecione a data de referência.
• Grupo de Consumo: Selecione o grupo de consumo, variando entre consumidor comum e grande consumidor.
• Lote: Selecione o lote caso necessário, o campo lote possibilita o ajuste das datas de apresentação, vencimento, reaviso e corte das faturas, assegurando que o cálculo do faturamento seja realizado com base no período correto, conforme o calendário da etapa selecionada.
• Parâmetro Crítica Financeira: Caso o campo esteja ativado, selecione o parâmetro de crítica financeira aplicável.

Cálculo por UC

• Para realizar o cálculo de faturamento para uma UC especifica individualmente, é necessário preencher os seguintes campos obrigatórios:
• UC: Informe o número da unidade consumidora.

• Assim que o número da UC for inserido, o sistema inicia o carregamento automático dos dados dessa unidade.

• O sistema verifica se a UC está em situação de espelho e se é apta para faturamento. Em seguida, válida a UC: caso seja inválida, um erro de "UC inválida" será exibido.

• Se a UC for válida, mas não estiver apta para faturamento, o sistema preencherá automaticamente apenas o nome do cliente. Se a UC for apta para faturamento, o sistema prosseguirá com o cálculo normalmente.
• Caso a UC Não Seja Encontrada em Espelho:

O sistema exibe um alerta informando que a UC não está em situação de espelho.

Ao fechar a mensagem de alerta, o sistema retorna para a tela de entrada, com os campos vazios permitindo a inserção de novos dados.

• Caso a UC Seja Apta e em Espelho:

Todos os outros campos relacionados, como Cliente, Livro, Referência, Grupo de Consumo e lote, são preenchidos automaticamente com os dados cadastrados para a UC.

Esses campos ficarão bloqueados para edição manual, garantindo que as informações reflitam fielmente o cadastro da unidade.

• Caso o campo de lote seja preenchido ele possibilita o ajuste das datas de apresentação, vencimento, reaviso e corte das faturas, assegurando que o cálculo do faturamento seja realizado com base no período correto, conforme o calendário da etapa selecionada.
• Parâmetro Crítica Financeira: Quando ativo, permite selecionar as opções de crítica financeira para o cálculo das faturas. Ao selecionar, é exibida uma janela com as opções disponíveis, como código, descrição, número de meses, percentual de tolerância financeira e valor fixo. Se optar por cancelar, a janela será fechada e o campo não será preenchido. Ao confirmar, o campo será automaticamente preenchido com o código e a descrição.

• Quando o campo Parâmetro Crítica Financeira estiver ativo, o seu preenchimento será obrigatório para o processamento dos cálculos, tanto em tempo real quanto em background.
• Quando o parâmetro Crítica Financeira estiver ativo, o preenchimento do campo Empresa, exibido no filtro do usuário, se tornará obrigatório para o processamento dos cálculos em tempo real, realizado por meio do botão "Salvar". Se o campo Empresa não for preenchido, ao clicar em "Salvar", será exibida a mensagem de erro "Campo obrigatório".
• O botão de “Programar” no cenário de cálculo por UC é desativado, impedindo a execução de uma programação em segundo plano.

• Após preencher a UC e o sistema encontrar os dados relacionados, clique no botão “Salvar”. Em seguida, será exibida uma caixa de diálogo de confirmação do cálculo do faturamento, com as opções "Cancelar" e "Confirmar":
• Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhum cálculo será realizado para essa UC.
• Confirmar: Se optar por "Confirmar", o sistema realizará o cálculo do faturamento.

• Após a confirmação, uma nova caixa de diálogo será exibida, informando: "Cálculo do faturamento realizado com sucesso". Com a conclusão do processamento, as faturas calculadas são atualizadas para a situação de faturadas e é exibido o total de faturas calculadas, faturas irregulares, faturas em situação CR e faturas não faturadas.

• Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de cálculo do faturamento, com os campos vazios, pronto para um novo cálculo, caso necessário.

Cálculo por Etapa

• O cálculo de faturamento por etapa permite processar as faturas de uma etapa inteira. Ao informar os dados, o sistema valida as informações fornecidas e, caso sejam válidas, inicia o processamento do cálculo.

• O código da etapa" refere-se a lotes específicos definidos dentro do calendário, cada um com uma data limite para o faturamento. Esse código permite realizar o processo de cálculo do faturamento de toda a etapa de forma organizada e automatizada, garantindo que o cálculo seja executado até a data limite estipulada para o lote.

• Para realizar o cálculo de faturamento para uma etapa inteira, é necessário preencher os seguintes campos obrigatórios:

  • Etapa: Selecione a etapa desejada para o cálculo.
  • Referência: Escolha a data de referência clicando no calendário. Esse campo define o período para o qual o faturamento será calculado, com um mês e ano específico.
  • Grupo de Consumo: Selecione o grupo de consumo correspondente à UC.

- Além disso, caso o Parâmetro de Crítica Financeira esteja ativado, também será necessário preenchê-lo para que o processo de cálculo seja concluído corretamente. Caso o campo não seja preenchido e o botão "Salvar" seja clicado, será exibida a mensagem de erro "Campo obrigatório".
- Quando o parâmetro Crítica Financeira estiver ativo, o preenchimento do campo Empresa, exibido no filtro do usuário, se tornará obrigatório para o processamento dos cálculos em tempo real, realizado por meio do botão "Salvar".

• O botão de “Programar” no cenário de cálculo por Etapa é habilitado, permitindo a execução de uma programação em segundo plano.

• Caso algum campo obrigatório não seja preenchido ao clicar em "Salvar", o sistema exibirá uma caixa de diálogo de alerta informando "Campos obrigatórios não preenchidos", com a lista dos campos que precisam ser preenchidos para o processamento ser concluído. Após clicar no botão “Fechar” na caixa de diálogo, os campos não preenchidos ficarão destacados em vermelho até que sejam corretamente preenchidos.

• Após preencher todos os campos obrigatórios e clicar em "Salvar", o sistema inicia o carregamento dos dados. Se ocorrer um erro durante o cálculo do faturamento, uma caixa de diálogo de erro será exibida com a mensagem "Erro ao realizar o cálculo do faturamento. Algum dos campos pode estar inválido".

• Ao fechar a caixa de diálogo, o sistema retornará à tela de cálculo sem concluir o processo de faturamento. Para corrigir e permitir a conclusão do cálculo, o usuário deverá revisar os campos e garantir que todos os dados estejam válidos.
• Após preencher os campos obrigatórios, clique no botão “Salvar”. Em seguida, será exibida uma caixa de diálogo de confirmação do cálculo do faturamento, com as opções "Cancelar" e "Confirmar":
• Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhum cálculo será realizado para essa UC.
• Confirmar: Se optar por "Confirmar", o sistema realizará o cálculo do faturamento.

• Após a confirmação, uma nova caixa de diálogo será exibida, informando: "Cálculo do faturamento realizado com sucesso". Com a conclusão do processamento, as faturas calculadas são atualizadas para a situação de faturadas e é exibido o total de faturas calculadas, faturas irregulares, faturas em situação CR e faturas não faturadas.

• Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de cálculo do faturamento, com os campos vazios, pronto para um novo cálculo, caso necessário.

Cálculo por Livro

• Código do livro, permite conjunto de UCs utilizado para realizar a medição.

• Para realizar o cálculo de faturamento para um livro inteiro, é necessário preencher os seguintes campos obrigatórios:

  • Livro: Selecione o livro cadastrado para que seja encontrado e apto para realizar o cálculo do faturamento.
  • Etapa: Selecione a etapa desejada para o cálculo.
  • Referência: Escolha a data de referência clicando no calendário. Esse campo define o período para o qual o faturamento será calculado, com um mês e ano específico.
  • Grupo de Consumo: Selecione o grupo de consumo correspondente à UC.

- Além disso, caso o Parâmetro de Crítica Financeira esteja ativado, também será necessário preenchê-lo para que o processo de cálculo seja concluído corretamente.
- Quando o parâmetro Crítica Financeira estiver ativo, o preenchimento do campo Empresa, exibido no filtro do usuário, se tornará obrigatório para o processamento dos cálculos em tempo real, realizado por meio do botão "Salvar".

• O botão de “Programar” no cenário de cálculo por livro é desativado, impedindo a execução de uma programação em segundo plano.

• Caso algum campo obrigatório não seja preenchido ao clicar em "Salvar", o sistema exibirá uma caixa de diálogo de alerta informando "Campos obrigatórios não preenchidos", com a lista dos campos que precisam ser preenchidos para o processamento ser concluído. Após clicar no botão “Fechar” na caixa de diálogo, os campos não preenchidos ficarão destacados em vermelho até que sejam corretamente preenchidos.
• Após preencher todos os campos obrigatórios e clicar em "Salvar", o sistema inicia o carregamento dos dados. Se ocorrer um erro durante o cálculo do faturamento, uma caixa de diálogo de erro será exibida com a mensagem "Erro ao realizar o cálculo do faturamento. Algum dos campos pode estar inválido". Ao fechar a caixa de diálogo, o sistema retornará à tela de cálculo sem concluir o processo de faturamento. Para corrigir e permitir a conclusão do cálculo, o usuário deverá revisar os campos e garantir que todos os dados estejam válidos.
• Após preencher os campos obrigatórios, clique no botão “Salvar”. Em seguida, será exibida uma caixa de diálogo de confirmação do cálculo do faturamento, com as opções "Cancelar" e "Confirmar":
• Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhum cálculo será realizado para essa UC.
• Confirmar: Se optar por "Confirmar", o sistema realizará o cálculo do faturamento.

• Após a confirmação, uma nova caixa de diálogo será exibida, informando: "Cálculo do faturamento realizado com sucesso". Com a conclusão do processamento, as faturas calculadas são atualizadas para a situação de faturadas e é exibido o total de faturas calculadas, faturas irregulares, faturas em situação CR e faturas não faturadas.

• Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de cálculo do faturamento, com os campos vazios, pronto para um novo cálculo, caso necessário.

ESPECIFICIDADES

Descreva os itens abaixo referente as validações.

FUNÇÃO	PARÂMETROS	STATUS/COMPORTAMENTO

PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES

• Navegação Tabela: Localizado no rodapé da tabela, o usuário pode selecionar o número de linhas a serem exibidas por página e navegar entre as páginas.
• Botão Programar: O botão "Programa" é responsável por iniciar o cálculo do faturamento em segundo plano. Ele fica ativo somente durante o cálculo por Etapa. Para utilizá-lo, é necessário informar os campos Etapa, Referência e Grupo de Consumo. Após preenchê-los, o cálculo será realizado em background. Quando a opção de cálculo for por Livro ou UC, o botão ficará desabilitado, permitindo o processamento apenas por Etapa.
• Botão Salvar: O botão “Salvar” é responsável por realizar o cálculo do faturamento em tempo real. Ao ser clicado, ele processa imediatamente os dados preenchidos e executa o cálculo de faturamento,
• Parâmetro de Crítica Financeira: O campo Parâmetro de Crítica Financeira: Quando ativado, indica que a empresa adota regras de crítica financeira para as faturas. Quando ativo é um campo de preenchimento obrigatório tanto para cálculo em tempo real quanto para programação em background.
• Info: Ao passar o mouse sobre o ícone ao lado do campo Lote, será exibida a seguinte explicação: Se houver atrasos ou alterações no calendário, utilize este campo para ajustar as datas e garantir que o cálculo do faturamento considere corretamente o período da etapa anterior, alinhando-o ao novo cronograma.

REQUISITOS DE USUÁRIOS

Principais ações que poderão ser executadas durante a geração do Cálculo do Faturamento. Principais ações que poderão ser executadas na tela de Empresa do sistema SOMUS.

USUÁRIO	RESPONSABILIDADES
Faturamento	Aplicar filtros para segmentar as informações de acordo com os parâmetros definidos para o usuário
	Realizar cálculo do faturamento por uma UC específica
	Realizar cálculo para UCs encontradas no espelho
	Realizar cálculo do faturamento por uma etapa inteira
	Realizar cálculo do faturamento para um livro inteiro cálculo com mais de uma UC.
	Realizar a programação em background por etapa e livro
	Poderá aplicar os parâmetros de crítica financeira
	Identificar o total de faturas calculadas, irregulares, com situação CR e não faturadas.
	Aplicar o dado no campo lote as faturas calculadas terão suas datas de apresentação, vencimento, reaviso e corte atualizadas com as respectivas datas no calendário, para a etapa selecionada.

RELATÓRIO DE INCIDÊNCIAS

Seção destinada a resolução de problemas e erros que podem ocorrer e como pode ser solucionado.

PROBLEMA	CAUSA	SOLUÇÃO

DOCUMENTOS RELACIONADOS

TÍTULO	LINK
Cáculo de Faturamento	-