Consulta de Lançamentos Fiscais
Consulta de Lançamentos Fiscais
A rotina Consulta de lançamentos fiscais pertence ao menu Escrita Fiscal do ERP Atak, dentro do grupo Escrita x Contabilidade.
1. Visão Geral da Rotina
A rotina Consulta de lançamentos fiscais pertence ao menu Escrita Fiscal do ERP Atak, dentro do grupo Escrita x Contabilidade. Ela é uma rotina de consulta pura sobre o livro fiscal de entradas e saídas: o usuário informa um período, escolhe um tributo, aplica filtros complementares e recebe, em grade, a relação detalhada dos itens dos documentos fiscais escriturados, acompanhada do valor do tributo escolhido em cada item. Apesar de estar posicionada no mesmo grupo de menu das rotinas de contabilização, a Consulta de lançamentos fiscais não executa contabilização alguma, não cria fechamento, não carimba documentos e não grava nenhum registro no banco de dados.
O propósito da rotina é dar ao usuário da escrita fiscal uma visão analítica e filtrável do que foi escriturado no livro de entradas e saídas, no nível mais baixo de detalhe disponível: uma linha por item e subitem de cada documento fiscal. Essa granularidade permite conferir, item a item, qual CFOP foi aplicado, qual a situação tributária registrada, qual o perfil tributário do produto, qual a quantidade e a unidade movimentadas, qual o valor do item e qual o valor do tributo selecionado. É a ferramenta usada para auditar a escrituração antes de fechar um período, para conferir os valores que alimentarão a contabilização dos documentos e dos tributos, para investigar divergências de apuração e para extrair bases analíticas completas em planilha.
A rotina se organiza em uma única janela, chamada Consulta de lançamentos fiscais, dividida em duas abas: a aba Pesquisa, onde o usuário monta os critérios, e a aba Lançamentos Fiscais, onde o sistema apresenta o resultado em grade paginada. A barra de comandos da janela traz as duas ações principais da rotina — Buscar lançamentos e Exportar Excel — além do acesso ao vídeo da rotina e do comando de fechamento da aba. O resultado da pesquisa pode ser consultado na tela, refinado por uma caixa de pesquisa local na grade, ou exportado integralmente para planilha, com um conjunto de colunas muito mais amplo do que o exibido na tela.
—
2. Vídeo Tutorial
▶ Tutorial em vídeo: ainda não disponível para esta rotina.
—
3. Pré-requisitos e Contexto de Acesso
3.1 Localização no menu
O usuário acessa a rotina pelo menu Escrita Fiscal, grupo Escrita x Contabilidade, item Consulta de lançamentos fiscais. O sistema abre a janela Consulta de lançamentos fiscais já posicionada na aba Pesquisa, com a barra de comandos identificada como “Escrita fiscal -> Consulta de lançamentos fiscais”.
3.2 Perfil de usuário e permissões
A rotina é destinada ao usuário da área fiscal e contábil que precisa conferir ou extrair a escrituração do livro de entradas e saídas: analista fiscal, escriturário fiscal, contador e auditor interno.
A ação de listagem dos lançamentos na grade não exige permissão de recurso específica. Qualquer usuário autenticado que tenha acesso ao item de menu consegue executar a pesquisa e visualizar o resultado na aba Lançamentos Fiscais.
A ação Exportar Excel é protegida por permissão própria, concedida separadamente no cadastro de permissões do usuário. Sem essa permissão, o usuário consulta os lançamentos na tela, mas o sistema não libera a geração do arquivo de planilha.
A consulta não aplica restrição por filial do usuário. O filtro de filial da aba Pesquisa delimita o resultado apenas quando o usuário efetivamente seleciona filiais; deixando o filtro vazio, o sistema considera todas as filiais existentes na base.
3.3 Cadastros e escrituração prévios
A rotina lê exclusivamente dados já existentes, portanto depende de etapas anteriores de escrituração e de cadastro:
- O livro fiscal de entradas e saídas precisa estar escriturado no período consultado. O sistema lê os documentos gravados na tabela TBLIVROREGES, os itens gravados em TBLIVROREGESITEM e os tributos de cada item gravados em TBLIVROREGESITEMTRB.
- O cadastro de filiais precisa estar preenchido, pois alimenta o seletor Filial da aba Pesquisa e fornece a descrição da filial do documento.
- O cadastro de tributos precisa estar preenchido, pois alimenta o seletor Tributo, que é obrigatório para executar a pesquisa.
- O cadastro de CFOP precisa estar preenchido, pois alimenta o seletor CFOP e porque o CFOP do item é um dos critérios de filtragem.
- O cadastro de situações tributárias precisa estar preenchido por tributo, pois alimenta o seletor Situação tributária conforme o tributo escolhido.
- O cadastro de produtos e de referências de produto precisa estar preenchido, pois alimenta o localizador Produto, fornece a descrição do item apresentada na grade e carrega o perfil tributário usado no filtro correspondente.
- O cadastro de perfis tributários do item precisa estar preenchido, pois alimenta o seletor Perfil Tributário.
- O lote de escrita do documento precisa existir, pois a consulta vincula cada documento ao seu lote de escrita por filial e código de lote, e é dessa origem que vem a indicação de entrada ou saída.
A rotina não depende de fechamento contábil, de parametrização de fato contábil fiscal, de plano de contas configurado nem de período de apuração fechado. Ela funciona com o livro fiscal escriturado, independentemente de o período já ter sido contabilizado.
—
4. Processo de Criação / Emissão — Passo a Passo
A rotina não cria registros. O processo descrito abaixo é o fluxo completo de execução de uma consulta, desde a abertura da janela até a extração do resultado em planilha.
Passo 1: abrir a rotina O usuário acessa o menu Escrita Fiscal, abre o grupo Escrita x Contabilidade e seleciona Consulta de lançamentos fiscais. O sistema abre a janela Consulta de lançamentos fiscais com as abas Pesquisa e Lançamentos Fiscais, posicionando o foco na aba Pesquisa e exibindo a barra de comandos com as ações disponíveis.
Passo 2: delimitar o período de registro O usuário preenche o campo Data Inicial e o campo Data Final da aba Pesquisa. Os dois campos são obrigatórios. Eles delimitam a data de registro do documento no livro fiscal, com limites inclusivos nas duas pontas: o sistema traz os documentos cuja data de registro está entre a data inicial e a data final, incluindo os documentos registrados exatamente nessas duas datas.
Passo 3: selecionar o tributo O usuário abre o seletor Tributo da aba Pesquisa e escolhe um dos tributos cadastrados. O campo é obrigatório e aceita apenas valores existentes na lista, não permitindo digitação livre. A escolha do tributo tem dois efeitos imediatos: define qual valor o sistema apresentará na coluna Valor Tributo da grade de resultados e define quais opções o sistema carregará no seletor Situação tributária.
Passo 4: habilitar e preencher a situação tributária Ao selecionar o tributo, o sistema avalia se ele é ICMS, IPI, PIS ou COFINS. Sendo um desses quatro, o sistema habilita o seletor Situação tributária e recarrega as opções correspondentes ao tributo escolhido. Para qualquer outro tributo, o seletor Situação tributária permanece desabilitado. Se o usuário trocar o tributo depois de já ter escolhido situações tributárias, o sistema recarrega a lista de situações de acordo com o novo tributo.
Passo 5: aplicar os filtros complementares O usuário pode restringir o resultado preenchendo os seletores opcionais da aba Pesquisa: Filial, para limitar o resultado a uma ou mais filiais; Perfil Tributário, para limitar a itens de determinado perfil tributário; CFOP, para limitar a determinados códigos fiscais de operação; Situação tributária, quando habilitada; e Produto, para limitar a produtos e referências específicos. Todos esses seletores aceitam múltipla seleção, e cada um deles, deixado em branco, significa ausência de restrição naquele critério.
Passo 6: executar a busca O usuário aciona o botão Buscar lançamentos da barra de comandos ou usa o atalho Ctrl+M. O sistema valida o preenchimento dos campos obrigatórios da aba Pesquisa. Havendo campo obrigatório não preenchido ou valor inválido, o sistema destaca visualmente o campo problemático na aba Pesquisa e interrompe a execução, sem chamar o servidor.
Passo 7: montagem dos critérios e chamada da consulta Com o formulário válido, o sistema monta o conjunto de parâmetros da pesquisa: filial, data inicial, data final, tributo, perfil tributário, CFOP, situação tributária e produto. Os seletores de múltipla escolha são transformados em uma lista única de valores separados por vírgula, e o localizador de produto em uma lista de pares de produto e referência separados por barra vertical. O sistema então solicita a primeira página do resultado ao servidor.
Passo 8: validação do servidor O servidor verifica a presença dos três critérios obrigatórios. Faltando a data inicial, a data final ou o tributo, o sistema interrompe a operação e devolve a mensagem “Consulta não realizada.”, com o motivo “Os campos obrigatórios não foram preenchidos.” e a orientação “Preencha os campos obrigatórios.”.
Passo 9: apresentação dos resultados Atendidos os critérios obrigatórios, o sistema executa a consulta sobre o livro fiscal, ativa automaticamente a aba Lançamentos Fiscais e apresenta a grade com os registros encontrados, paginada em 30 registros por página. Cada linha da grade corresponde a um item, ou subitem, de um documento fiscal escriturado. Quando nenhum registro atende aos critérios, o sistema apresenta a grade vazia.
Passo 10: refinar o resultado já carregado O usuário pode usar a caixa de pesquisa da grade Lançamentos Fiscais para refinar o conjunto de registros, informando uma data, um número ou um texto. O sistema aplica esse refinamento sobre o resultado da consulta, recalculando o total de registros e a paginação.
Passo 11: exportar para planilha Com os critérios definidos, o usuário aciona o botão Exportar Excel da barra de comandos ou usa o atalho Ctrl+H. O sistema exibe a máscara “Aguarde!” sobre a janela, executa a mesma consulta sem paginação, gera o arquivo de planilha com o conjunto completo de colunas de cabeçalho, de item e de tributos, e devolve o nome do arquivo gerado.
Passo 12: abrir o arquivo gerado Recebido o nome do arquivo, o sistema remove a máscara “Aguarde!” e abre o endereço do arquivo gerado na área de exportação, disponibilizando-o para download. O arquivo é nomeado a partir da base “ListaDeLancamento”.
—
5. Descrição de Cada Campo da Tela
5.1 Estrutura da janela
A janela Consulta de lançamentos fiscais é composta por duas abas e uma barra de comandos comum. A aba Pesquisa concentra todos os critérios de filtragem e é a aba ativa na abertura da rotina. A aba Lançamentos Fiscais concentra a grade de resultados e só recebe conteúdo depois que o usuário executa a busca; o sistema ativa essa aba automaticamente ao concluir a pesquisa. O usuário pode alternar livremente entre as duas abas para ajustar critérios e reexecutar a consulta quantas vezes quiser.
5.2 Aba Pesquisa — critérios obrigatórios
O campo Data Inicial da aba Pesquisa da Consulta de lançamentos fiscais é um campo de data, de preenchimento obrigatório. Ele estabelece o limite inferior do período consultado e incide sobre a data de registro do documento no livro fiscal, e não sobre a data de emissão nem sobre a data de entrada ou saída. O limite é inclusivo: documentos registrados exatamente na data informada entram no resultado. Sem esse campo preenchido, o sistema não executa a consulta.
O campo Data Final da aba Pesquisa é um campo de data, de preenchimento obrigatório. Ele estabelece o limite superior do período consultado, também sobre a data de registro do documento no livro fiscal, também com limite inclusivo. Em conjunto com o campo Data Inicial, delimita a janela de registro dos documentos trazidos pela consulta. Sem esse campo preenchido, o sistema não executa a consulta.
O campo Tributo da aba Pesquisa é um seletor de valor único, de preenchimento obrigatório, alimentado pelo cadastro de tributos. O campo exige seleção de um item da lista e não aceita texto digitado que não corresponda a um registro cadastrado. O tributo escolhido determina de qual registro de tributo do item o sistema extrai o valor exibido na coluna Valor Tributo da grade Lançamentos Fiscais. Ele também governa o comportamento do seletor Situação tributária da mesma aba, tanto na habilitação quanto no conteúdo da lista de opções, e define sobre qual campo de situação tributária do item o sistema aplica esse filtro. Sem esse campo preenchido, o sistema não executa a consulta.
5.3 Aba Pesquisa — filtros opcionais
O campo Filial da aba Pesquisa da Consulta de lançamentos fiscais é um seletor de múltipla seleção, opcional, alimentado pelo cadastro completo de filiais. Quando o usuário seleciona uma ou mais filiais, o sistema restringe o resultado aos documentos daquelas filiais. Quando o usuário deixa o campo vazio, o sistema considera todas as filiais da base, inclusive aquelas às quais o usuário não tem acesso em outras rotinas, pois a consulta não aplica filtro de permissão de filial. O valor da filial do documento aparece depois na coluna Filial e compõe a coluna Documento da grade Lançamentos Fiscais.
O campo Perfil Tributário da aba Pesquisa é um seletor de múltipla seleção, opcional, alimentado pelo cadastro de perfil tributário de item. O sistema aplica o filtro sobre a combinação do código de produto tributário com o código de referência tributária, ambos registrados na referência do produto. Selecionando um ou mais perfis, o usuário restringe o resultado aos itens cuja referência de produto aponta para esses perfis; deixando o campo vazio, não há restrição por perfil tributário.
O campo CFOP da aba Pesquisa é um seletor de múltipla seleção, opcional, alimentado pelo cadastro completo de CFOP. O sistema aplica o filtro sobre o CFOP registrado no item do livro fiscal, e não sobre um CFOP de cabeçalho. Selecionando um ou mais CFOPs, o usuário restringe o resultado aos itens escriturados com aqueles códigos; deixando o campo vazio, não há restrição por CFOP.
O campo Situação tributária da aba Pesquisa é um seletor de múltipla seleção, opcional e condicional. Ele permanece desabilitado enquanto o usuário não escolhe no campo Tributo um dos valores “ICMS”, “IPI”, “PIS” ou “COFINS”; para qualquer outro tributo, o campo continua desabilitado durante toda a pesquisa. Quando habilitado, o sistema carrega as opções de situação tributária correspondentes ao tributo selecionado, e recarrega essa lista sempre que o usuário troca o tributo. O campo do item sobre o qual o sistema aplica o filtro varia conforme o tributo: para “PIS”, o sistema compara com a situação tributária de PIS do item; para “COFINS”, com a situação tributária de COFINS do item; para “IPI”, com a situação tributária de IPI do item; e para qualquer outro tributo, inclusive “ICMS”, com a situação tributária geral do item.
O campo Produto da aba Pesquisa é um localizador de produtos com múltipla seleção, opcional. O usuário pesquisa e seleciona um ou mais produtos, e o sistema registra cada escolha na forma da combinação do código do produto com o código da referência. O filtro é aplicado sobre essa mesma combinação registrada na referência do produto do item do livro. Deixando o campo vazio, não há restrição por produto.
5.4 Barra de comandos
A barra de comandos da janela Consulta de lançamentos fiscais reúne as ações da rotina.
O botão Buscar lançamentos, com atalho Ctrl+M, dispara a validação do formulário da aba Pesquisa e, estando válido, executa a consulta, carrega a primeira página do resultado e ativa a aba Lançamentos Fiscais. Estando o formulário inválido, o sistema destaca os campos com problema e não executa a consulta.
O botão Exportar Excel, com atalho Ctrl+H, gera a planilha com o resultado completo da pesquisa, sem paginação. O sistema exibe a máscara “Aguarde!” enquanto processa e, ao receber o nome do arquivo gerado, abre o endereço do arquivo na área de exportação para download.
A barra traz ainda o comando de acesso ao vídeo da rotina e o comando de fechar a aba da Consulta de lançamentos fiscais.
5.5 Aba Lançamentos Fiscais — grade de resultados
A grade da aba Lançamentos Fiscais apresenta o resultado da consulta em páginas de 30 registros, com ajuste automático da largura das colunas ao espaço disponível. Cada linha corresponde a um item, ou subitem, de um documento fiscal escriturado no livro de entradas e saídas, dentro do período e dos filtros informados. A ordenação é fixa, feita pelo sistema por chave de fato do documento, número do item e número do subitem, de modo que os itens de um mesmo documento aparecem agrupados e em sequência.
A coluna Filial da grade Lançamentos Fiscais apresenta o código da filial em que o documento foi escriturado.
A coluna Documento da grade Lançamentos Fiscais apresenta o identificador completo do documento, composto pela concatenação do código da filial, do código do documento, da série e do número, separados por hífen. É a coluna usada para identificar univocamente o documento fiscal na relação.
A coluna Serie da grade Lançamentos Fiscais apresenta isoladamente a série do documento fiscal, permitindo ordenar e filtrar por série sem depender da coluna Documento.
A coluna Numero da grade Lançamentos Fiscais apresenta isoladamente o número do documento fiscal.
A coluna Modelo Fiscal da grade Lançamentos Fiscais apresenta o modelo do documento registrado no livro, que identifica o tipo de documento fiscal escriturado.
A coluna Data Registro da grade Lançamentos Fiscais apresenta a data de registro do documento no livro fiscal, formatada em dia, mês e ano abreviado. É sobre esse valor que incidem os campos Data Inicial e Data Final da aba Pesquisa.
A coluna Participante da grade Lançamentos Fiscais apresenta o código do cliente ou fornecedor vinculado ao documento no livro fiscal.
A coluna Nome participante da grade Lançamentos Fiscais apresenta o nome do emitente gravado no próprio documento do livro, e não o nome atual do cadastro geral.
A coluna Item da grade Lançamentos Fiscais apresenta a identificação do item, composta pela concatenação do código do produto com o código da referência.
A coluna Descrição do Item da grade Lançamentos Fiscais apresenta a descrição do produto conforme registrada no cadastro de produto do estoque.
A coluna Quantidade da grade Lançamentos Fiscais apresenta a quantidade movimentada no item do documento fiscal.
A coluna Unidade da grade Lançamentos Fiscais apresenta o código da unidade de medida do item do documento fiscal.
A coluna Valor Líquido da grade Lançamentos Fiscais apresenta o valor do item registrado no livro fiscal. Apesar do rótulo, o conteúdo da coluna é o valor do item, e não o valor contábil do item nem o valor líquido do documento.
A coluna Valor Tributo da grade Lançamentos Fiscais apresenta o valor do imposto escolhido no campo Tributo da aba Pesquisa, lido do registro de tributo daquele item. Quando o item não possui registro do tributo escolhido, ou quando o valor registrado é nulo, o sistema apresenta zero.
5.6 Caixa de pesquisa da grade e paginação
A grade Lançamentos Fiscais possui uma caixa de pesquisa que refina o conjunto de registros já apurado pela consulta, sem alterar os critérios da aba Pesquisa. O comportamento do refinamento depende do conteúdo digitado.
Quando o usuário digita um valor que o sistema reconhece como data no formato brasileiro, o sistema mantém apenas as linhas cuja data de registro é exatamente igual a essa data.
Quando o usuário digita um valor numérico inteiro, o sistema mantém as linhas em que o código da filial, a série ou o número do documento sejam iguais ao texto informado, ou em que o código do participante seja igual ao número informado, ou ainda em que a identificação do item contenha o texto informado.
Quando o usuário digita um texto que não é data nem número inteiro, o sistema mantém as linhas cujo nome do participante ou cuja descrição do produto contenham o texto informado.
Aplicado o refinamento, o sistema recalcula o número total de registros do resultado e refaz a paginação de 30 registros por página. A navegação entre páginas é feita sobre o conjunto de registros já apurado, de modo que a troca de página não reexecuta a consulta sobre o banco. A ordenação das colunas da grade também é resolvida localmente, sobre o conjunto carregado.
5.7 Conteúdo da exportação
A exportação da Consulta de lançamentos fiscais não se limita às quatorze colunas exibidas na grade. O sistema carrega, para cada linha do resultado, o conjunto completo de informações do cabeçalho do documento, do item e dos tributos — aproximadamente trezentas colunas, incluindo os blocos de ICMS, de ICMS por substituição tributária, de PIS, de COFINS, de IPI e do tributo selecionado pelo usuário. Esse conjunto ampliado existe exclusivamente para a exportação; a grade da aba Lançamentos Fiscais apresenta o subconjunto de quatorze colunas descrito acima.
—
6. Utilização e Consulta de Registros
6.1 Como o usuário localiza os lançamentos
A Consulta de lançamentos fiscais não possui uma listagem inicial de registros: a rotina abre vazia, na aba Pesquisa, e só exibe dados depois que o usuário monta os critérios e aciona Buscar lançamentos. Não existe, portanto, o conceito de “abrir um registro existente” nessa rotina. O que o usuário localiza são linhas de item de documento fiscal, sempre através da combinação de filtros da aba Pesquisa.
O caminho mínimo para obter resultado é informar Data Inicial, Data Final e Tributo. A partir desse recorte, o usuário vai estreitando o resultado com os demais filtros conforme a necessidade de conferência.
6.2 Filtros de busca disponíveis
A aba Pesquisa da Consulta de lançamentos fiscais oferece os seguintes critérios: o período de registro, pelos campos Data Inicial e Data Final; o tributo, pelo campo Tributo; as filiais, pelo campo Filial; os perfis tributários, pelo campo Perfil Tributário; os códigos fiscais de operação, pelo campo CFOP; as situações tributárias, pelo campo Situação tributária, condicionado ao tributo escolhido; e os produtos, pelo campo Produto.
Os filtros de múltipla seleção funcionam de forma cumulativa entre si e restritiva dentro de si: o sistema traz as linhas que atendem simultaneamente a todos os critérios preenchidos, considerando, dentro de cada critério, qualquer um dos valores selecionados.
Já dentro do resultado, a caixa de pesquisa da grade Lançamentos Fiscais funciona como um segundo nível de filtragem, local e imediato, sobre o conjunto já apurado, aceitando data, número ou texto conforme descrito na seção anterior.
6.3 Interpretação do resultado
Cada linha do resultado representa um item do documento no livro fiscal, desdobrado por subitem quando houver. Um documento com vários itens aparece em várias linhas, todas compartilhando as colunas de cabeçalho — Filial, Documento, Serie, Numero, Modelo Fiscal, Data Registro, Participante e Nome participante — e diferindo nas colunas de item e de tributo.
A coluna Valor Tributo apresenta o valor de um único tributo por consulta, aquele escolhido no campo Tributo. Para conferir outro tributo sobre o mesmo recorte, o usuário troca o valor do campo Tributo na aba Pesquisa e executa nova busca. A junção entre item e tributo é feita por documento, item, subitem e tributo, o que garante uma única linha por item para o tributo escolhido, sem duplicação.
6.4 Uso da rotina como ferramenta de conferência
Como a consulta lê diretamente o livro de entradas e saídas, ela reflete o que está escriturado no momento da pesquisa, independentemente de o período já ter sido contabilizado. Isso torna a rotina adequada tanto para a conferência prévia, antes de executar a contabilização de um período, quanto para a conferência posterior, para checar os valores que serviram de base aos lançamentos contábeis já gerados.
6.5 Exportação do resultado
A ação Exportar Excel da Consulta de lançamentos fiscais aplica exatamente os mesmos filtros da aba Pesquisa, mas executa a consulta sem paginação, de modo que o arquivo gerado contém todos os registros que atendem aos critérios, e não apenas a página exibida na tela. O sistema gera o arquivo sempre em formato de planilha sem formatação, mesmo quando a tela solicita o formato de planilha padrão, e o nomeia a partir da base “ListaDeLancamento”. Durante a geração, a janela fica coberta pela máscara “Aguarde!”, removida quando o sistema devolve o nome do arquivo e abre o endereço de download.
A validação dos critérios obrigatórios da exportação é feita pela própria tela, no mesmo momento em que valida o formulário da aba Pesquisa. Com o formulário inválido, o sistema destaca os campos e não executa a exportação.
—
7. Processo de Edição
A Consulta de lançamentos fiscais é uma rotina exclusivamente de leitura. Ela não cria, não altera e não exclui nenhum registro no sistema. Não existem campos editáveis na grade da aba Lançamentos Fiscais, não existe ação de salvar, não existe ação de excluir e não existe abertura de registro para edição a partir da grade.
A razão é a natureza da rotina: ela apenas projeta, em formato analítico, dados que foram gravados pela escrituração do livro fiscal de entradas e saídas. Qualquer correção de conteúdo — valor de item, CFOP, situação tributária, quantidade, unidade, participante, valor de tributo — é feita nas rotinas de escrituração do documento fiscal, e não aqui. Executada nova busca após a correção, a consulta já reflete o dado atualizado.
A única coisa que o usuário altera dentro da rotina são os próprios critérios de pesquisa da aba Pesquisa e o refinamento da caixa de pesquisa da grade Lançamentos Fiscais. Essas alterações não são persistidas: ao fechar a aba da Consulta de lançamentos fiscais e abri-la novamente, o sistema apresenta o formulário em branco.
Pela mesma razão, a rotina não mantém histórico nem log de alterações: como não há alteração de dados, não há o que registrar. As consultas executadas e as exportações geradas não ficam armazenadas como registros da rotina.
—
8. Estrutura Técnica e Comportamento do Sistema
8.1 Origem dos dados
A Consulta de lançamentos fiscais monta o resultado a partir do livro fiscal de entradas e saídas. O sistema parte do documento gravado em TBLIVROREGES, do qual extrai a filial, o código do documento, a série, o número, o modelo fiscal, a data de registro, o código do participante e o nome do emitente. A esse documento o sistema vincula a filial cadastrada, de forma opcional, para complementar a identificação.
Do documento, o sistema desce para os itens gravados em TBLIVROREGESITEM, vinculados pela chave de fato do documento. É do item que vêm o CFOP, o código do produto, o código da referência, a quantidade, a unidade, o valor do item e as situações tributárias geral, de PIS, de COFINS e de IPI.
Ao item o sistema vincula, de forma opcional, o cadastro de produto, de onde vem a descrição apresentada na coluna Descrição do Item, e o cadastro de referência do produto, de onde vêm o NCM, o perfil tributário — pela combinação de produto tributário e referência tributária — e o grupo contábil. O sistema vincula também o cadastro de produção e controle do produto por filial e referência, origem do tipo de item para fins de SPED, e o plano de contas associado à conta registrada no item.
O sistema vincula obrigatoriamente o lote de escrita do documento, por código de lote e filial, de onde obtém o indicador de entrada ou saída da operação.
Por fim, o sistema vincula os registros de tributo do item, gravados em TBLIVROREGESITEMTRB, pela chave de fato, número do item e número do subitem. Esse vínculo é feito seis vezes, de forma independente: uma para ICMS, uma para ICMS por substituição tributária, uma para PIS, uma para COFINS, uma para IPI e uma para o tributo selecionado pelo usuário no campo Tributo. É desse último vínculo que o sistema extrai o conteúdo da coluna Valor Tributo.
8.2 Exclusão de documentos e itens cancelados
O vínculo entre o documento e seus itens é feito de forma a descartar as linhas canceladas. O sistema avalia conjuntamente a situação do documento e a situação do item e elimina a linha quando qualquer uma das duas indica cancelamento. Com isso, nem documentos cancelados nem itens cancelados de documentos válidos aparecem no resultado da Consulta de lançamentos fiscais, tanto na grade quanto na exportação.
8.3 Janela de datas
O recorte temporal da consulta incide exclusivamente sobre a data de registro do documento no livro fiscal. O sistema compara essa data com os valores dos campos Data Inicial e Data Final da aba Pesquisa, com limites inclusivos nas duas pontas. A data de emissão do documento e a data de entrada ou saída não participam do recorte, ainda que estejam gravadas no livro.
8.4 Tratamento dos filtros de múltipla seleção
Os valores dos seletores de múltipla seleção chegam ao servidor como listas de texto. Filiais e CFOPs são transmitidos separados por vírgula; produtos são transmitidos separados por barra vertical, no formato de código de produto e código de referência. Antes de montar a consulta, o sistema higieniza os parâmetros de filial, tributo, perfil tributário, produto, situação tributária e CFOP, removendo a marca de valor nulo que a montagem da lista pode introduzir no início do texto. Em seguida, converte cada lista em uma restrição de conjunto aplicada ao campo correspondente.
8.5 Paginação, ordenação e filtragem
A consulta executa uma única leitura sobre a base e resolve as demais operações sobre o conjunto retornado. A ordenação por chave de fato, número do item e número do subitem é aplicada sobre esse conjunto. O refinamento da caixa de pesquisa da grade é aplicado em seguida, e só então o sistema calcula o número total de registros e extrai a página solicitada. Esse desenho explica por que a troca de página e a ordenação de colunas da grade Lançamentos Fiscais respondem sem reexecutar a consulta sobre o banco.
8.6 Comportamento da exportação
A exportação dos detalhes executa o mesmo caminho da listagem, com uma diferença: não recebe informação de paginação, de modo que o resultado completo é projetado para o arquivo. O conjunto de colunas projetado na exportação é o conjunto completo da consulta, com os dados de cabeçalho, de item e dos seis blocos de tributo. O sistema gera o arquivo em formato de planilha sem formatação, devolve o nome gerado à tela e a tela abre o endereço correspondente na área de exportação.
8.7 Integrações com outros módulos
A Consulta de lançamentos fiscais não gera lançamento contábil, não movimenta estoque, não emite documento fiscal e não altera a apuração de tributos. Sua integração com os demais módulos é de leitura: ela consome o que a escrituração fiscal gravou no livro de entradas e saídas, o que o cadastro de produtos e referências mantém sobre cada item, o que o cadastro de filiais define, o que o cadastro de CFOP e de situações tributárias disponibiliza como critérios, e o que o plano de contas associa ao item. Nenhum desses módulos é alterado pela execução da consulta.
8.8 Relação com a contabilização dos documentos fiscais
A consulta e as rotinas de contabilização leem a mesma base — o livro de entradas e saídas — mas com recortes diferentes. A consulta aplica o recorte informado pelo usuário na aba Pesquisa, sem considerar se o documento já foi contabilizado, e descarta documentos e itens cancelados. Esse comportamento é o que permite usar a rotina como conferência independente do estado de contabilização do período.
—
9. Regras de Negócio e Restrições
Regra 1 — Rotina exclusivamente de leitura: a Consulta de lançamentos fiscais executa somente consultas sobre o livro fiscal de entradas e saídas. O sistema não grava, não atualiza e não exclui nenhum registro durante a execução da rotina, e por isso não exige confirmação do usuário nem produz efeito sobre fechamentos, contabilizações ou apurações.
Regra 2 — Campos obrigatórios da pesquisa: o sistema exige o preenchimento de Data Inicial, Data Final e Tributo na aba Pesquisa para executar a consulta. Faltando qualquer um dos três, o sistema interrompe a operação e devolve a mensagem “Consulta não realizada.”, com o motivo “Os campos obrigatórios não foram preenchidos.” e a orientação “Preencha os campos obrigatórios.”. O usuário não obtém resultado algum enquanto não completar os três critérios.
Regra 3 — Validação na tela antes da chamada ao servidor: ao acionar Buscar lançamentos, o sistema valida o formulário da aba Pesquisa antes de chamar o servidor. Havendo campo obrigatório vazio ou valor inválido, o sistema destaca visualmente os campos com problema e não executa a consulta, evitando a ida ao servidor.
Regra 4 — Período incide sobre a data de registro: os campos Data Inicial e Data Final delimitam a data de registro do documento no livro fiscal, com limites inclusivos. O sistema não considera a data de emissão nem a data de entrada ou saída nesse recorte. Documentos emitidos em um mês e registrados em outro aparecem no período em que foram registrados.
Regra 5 — Tributo define a coluna de valor: o valor apresentado na coluna Valor Tributo da grade Lançamentos Fiscais é sempre o do tributo escolhido no campo Tributo da aba Pesquisa. Para comparar tributos diferentes sobre o mesmo recorte, o usuário executa uma consulta para cada tributo.
Regra 6 — Tributo sem valor registrado apresenta zero: quando o item não possui registro do tributo escolhido, ou quando o valor registrado é nulo, o sistema apresenta zero na coluna Valor Tributo, e não deixa a célula em branco nem suprime a linha do resultado. O item continua aparecendo com seus demais dados.
Regra 7 — Situação tributária condicionada ao tributo: o seletor Situação tributária da aba Pesquisa permanece desabilitado até que o usuário escolha no campo Tributo um dos valores “ICMS”, “IPI”, “PIS” ou “COFINS”. Para qualquer outro tributo, o filtro não fica disponível e o usuário não consegue restringir a consulta por situação tributária.
Regra 8 — Recarga das situações tributárias ao trocar o tributo: sempre que o usuário altera o valor do campo Tributo, o sistema recarrega as opções do seletor Situação tributária conforme o novo tributo. As opções exibidas correspondem sempre ao tributo atualmente selecionado.
Regra 9 — Campo de situação tributária aplicado conforme o tributo: o sistema aplica o filtro de Situação tributária sobre a situação tributária de PIS do item quando o tributo é “PIS”, sobre a de COFINS quando é “COFINS”, sobre a de IPI quando é “IPI”, e sobre a situação tributária geral do item em todos os demais casos, inclusive quando o tributo é “ICMS”.
Regra 10 — Filtro vazio significa ausência de restrição: cada um dos seletores opcionais — Filial, Perfil Tributário, CFOP, Situação tributária e Produto — deixado em branco não restringe o resultado naquele critério. O usuário amplia ou estreita o recorte apenas pelo preenchimento desses campos.
Regra 11 — Consulta não restringe filiais pelo usuário: a Consulta de lançamentos fiscais não aplica filtro de permissão de filial. Com o campo Filial vazio, o sistema devolve documentos de todas as filiais da base. A restrição a filiais específicas depende de o usuário selecioná-las no campo Filial da aba Pesquisa.
Regra 12 — Filtro de perfil tributário pela referência do produto: o filtro Perfil Tributário é aplicado sobre a combinação do código de produto tributário com o código de referência tributária registrados na referência do produto do item, e não sobre um campo do documento ou do cabeçalho.
Regra 13 — Filtro de CFOP no nível do item: o filtro CFOP é aplicado sobre o CFOP registrado em cada item do documento. Um documento com itens de CFOPs diferentes aparece parcialmente no resultado, trazendo apenas os itens cujo CFOP está entre os selecionados.
Regra 14 — Filtro de produto pela combinação de produto e referência: o filtro Produto é aplicado sobre a combinação do código do produto com o código da referência registrados na referência do produto do item. Selecionar um produto sem distinguir referência traz os itens daquela combinação exata selecionada no localizador.
Regra 15 — Documentos cancelados não entram no resultado: o sistema descarta as linhas cujo documento está com situação de cancelado, tanto na grade quanto na exportação. Documentos cancelados não aparecem na Consulta de lançamentos fiscais em nenhuma circunstância.
Regra 16 — Itens cancelados não entram no resultado: o sistema também descarta as linhas cujo item está com situação de cancelado, mesmo quando o documento permanece válido. Um documento válido com itens cancelados aparece no resultado apenas com os itens não cancelados.
Regra 17 — Uma linha por item e subitem: a consulta devolve uma linha por combinação de documento, item e subitem. Um documento com vários itens gera várias linhas, que repetem as informações de cabeçalho e diferem nas informações de item e de tributo. A soma de valores por documento, quando necessária, é feita pelo usuário sobre as linhas apresentadas.
Regra 18 — Uma única linha por tributo do item: o vínculo entre o item e o tributo selecionado é feito por chave de fato, número do item, número do subitem e código do tributo, o que impede que um mesmo item apareça duplicado por conta de múltiplas ocorrências do tributo escolhido.
Regra 19 — Valor do tributo sempre do tributo selecionado: mesmo que a consulta carregue internamente os blocos fixos de ICMS, ICMS por substituição tributária, PIS, COFINS e IPI, a coluna Valor Tributo da grade apresenta sempre o valor do tributo informado pelo usuário no campo Tributo, e não um desses blocos fixos.
Regra 20 — Conteúdo da coluna Valor Líquido: a coluna Valor Líquido da grade Lançamentos Fiscais apresenta o valor do item registrado no livro fiscal. Ela não apresenta o valor contábil do item nem o valor líquido do documento, de modo que a soma dessa coluna corresponde à soma dos valores de item do recorte consultado.
Regra 21 — Nome do participante vem do documento: a coluna Nome participante apresenta o nome do emitente gravado no próprio documento no momento da escrituração. Alterações posteriores no cadastro do participante não alteram o nome exibido nos documentos já escriturados.
Regra 22 — Ordenação fixa do resultado: o sistema ordena o resultado por chave de fato do documento, número do item e número do subitem. Essa ordenação é aplicada antes da paginação e mantém os itens de um mesmo documento agrupados e em sequência.
Regra 23 — Paginação de 30 registros: a grade Lançamentos Fiscais apresenta 30 registros por página. A navegação entre páginas opera sobre o conjunto já apurado pela consulta, sem nova leitura da base.
Regra 24 — Refinamento local por data: quando o usuário informa na caixa de pesquisa da grade Lançamentos Fiscais um valor reconhecido como data no formato brasileiro, o sistema mantém apenas as linhas cuja data de registro é exatamente igual a essa data.
Regra 25 — Refinamento local por número: quando o usuário informa na caixa de pesquisa da grade um valor numérico inteiro, o sistema mantém as linhas cujo código de filial, série ou número de documento sejam iguais ao texto informado, cujo código de participante seja igual ao número informado, ou cuja identificação do item contenha o texto informado.
Regra 26 — Refinamento local por texto: quando o usuário informa na caixa de pesquisa da grade um texto que não é data nem número inteiro, o sistema mantém as linhas cujo nome do participante ou cuja descrição do produto contenham o texto informado.
Regra 27 — Total de registros recalculado após o refinamento: o número total de registros exibido pela grade é apurado depois de aplicados os filtros da aba Pesquisa e o refinamento da caixa de pesquisa. A paginação é recalculada sobre esse total.
Regra 28 — Resultado vazio: quando nenhum registro atende aos critérios informados, o sistema devolve uma relação vazia e apresenta a grade Lançamentos Fiscais sem linhas, mantendo o usuário na rotina para ajustar os critérios da aba Pesquisa.
Regra 29 — Ativação automática da aba de resultado: concluída a busca, o sistema ativa automaticamente a aba Lançamentos Fiscais, levando o usuário diretamente ao resultado sem exigir troca manual de aba.
Regra 30 — Permissão específica para exportar: a ação Exportar Excel da Consulta de lançamentos fiscais é protegida por permissão própria de exportação de detalhes. Um usuário sem essa permissão executa a pesquisa e consulta a grade, mas não gera o arquivo de planilha.
Regra 31 — Listagem dos lançamentos sem exigência de permissão específica: a ação que alimenta a grade Lançamentos Fiscais não exige recurso de permissão específico. Qualquer usuário autenticado com acesso ao item de menu executa a consulta e visualiza os registros.
Regra 32 — Exportação sem paginação: a ação Exportar Excel gera o arquivo com todos os registros que atendem aos filtros da aba Pesquisa, e não apenas com a página exibida na grade. A quantidade de linhas do arquivo corresponde ao total apurado pela consulta.
Regra 33 — Exportação com o conjunto completo de colunas: o arquivo gerado pela ação Exportar Excel contém o conjunto completo de colunas de cabeçalho do documento, de item e dos blocos de ICMS, ICMS por substituição tributária, PIS, COFINS, IPI e do tributo selecionado, muito além das quatorze colunas exibidas na grade Lançamentos Fiscais.
Regra 34 — Formato fixo do arquivo exportado: o sistema gera o arquivo de exportação sempre em formato de planilha sem formatação, independentemente do formato indicado pela tela no momento da solicitação.
Regra 35 — Nome base do arquivo exportado: o sistema nomeia o arquivo gerado pela exportação a partir da base “ListaDeLancamento”, e devolve esse nome à tela, que abre o endereço do arquivo na área de exportação para download.
Regra 36 — Máscara de processamento durante a exportação: ao acionar Exportar Excel, o sistema cobre a janela Consulta de lançamentos fiscais com a máscara “Aguarde!” e a remove quando recebe o nome do arquivo gerado, ou quando o formulário da aba Pesquisa é considerado inválido.
Regra 37 — Critérios da exportação idênticos aos da pesquisa: a exportação usa exatamente os mesmos valores informados nos campos Filial, Data Inicial, Data Final, Tributo, Perfil Tributário, CFOP, Situação tributária e Produto da aba Pesquisa. O refinamento aplicado na caixa de pesquisa da grade não participa da montagem do arquivo.
Regra 38 — Atalhos de teclado das ações: o sistema oferece o atalho Ctrl+M para a ação Buscar lançamentos e o atalho Ctrl+H para a ação Exportar Excel, com o mesmo comportamento dos botões correspondentes da barra de comandos.
Regra 39 — Vínculo obrigatório com o lote de escrita: o sistema vincula obrigatoriamente cada documento ao seu lote de escrita, por código de lote e filial, de onde obtém o indicador de entrada ou saída. Documentos sem lote de escrita correspondente não compõem o resultado da consulta.
Regra 40 — Critérios não são persistidos entre sessões: os valores informados na aba Pesquisa e o refinamento da caixa de pesquisa da grade valem apenas enquanto a aba da Consulta de lançamentos fiscais permanece aberta. Ao fechar e reabrir a rotina, o sistema apresenta o formulário em branco e a grade vazia.