Cadastro de Notas Explicativas Contábeis
Criado por Igor Ribeiro em 06 de novembro de 2025
Atualizado por Igor Ribeiro em 02 de setembro de 2026
Cadastro de Notas Explicativas Contábeis
Rotina do módulo Contabilidade que permite registrar textos explicativos vinculados a uma conta do Plano de Contas, uma filial e um ano — usados para documentar ou justificar informações contábeis exigidas em demonstrações financeiras ou em obrigações acessórias.
Visão Geral da Rotina
A rotina de Cadastro de Notas Explicativas Contábeis permite registrar textos explicativos vinculados a uma conta do Plano de Contas, uma filial e um ano — usados para documentar ou justificar informações contábeis exigidas em demonstrações financeiras ou em obrigações acessórias. Cada nota é organizada por mês (uma linha de texto por data de referência dentro do ano), permitindo que o usuário detalhe, mês a mês, as justificativas relacionadas àquela conta contábil.
Vídeo Tutorial
Pré-requisitos e Contexto de Acesso das Notas Explicativas Contábeis
Para acessar a tela de Notas Explicativas Contábeis, o usuário precisa ter o perfil vinculado à permissão de acesso à rotina “ListViewDeCadastroDeNotasExplicativas” (ID 3536). Para incluir, editar ou excluir notas, e para exportar a listagem, são necessárias permissões adicionais e específicas para cada ação:
CadastroNotaExplicativaContabil/Novo
Incluir notas.
CadastroNotaExplicativaContabil/Editar
Editar notas já existentes.
CadastroNotaExplicativaContabil/Excluir
Excluir notas.
CadastroNotaExplicativaContabil/Exportar
Exportar a listagem.
Processo de Criação — Passo a Passo
Selecionar a filial, a conta contábil e o ano
O usuário informa a filial, a conta contábil (Plano de Contas) e o ano de referência para os quais deseja lançar a nota explicativa. O sistema verifica se já existe alguma nota lançada para essa combinação: se ainda não houver nenhum lançamento, a criação é liberada; se já existir, o sistema sinaliza que já há registro para aquela combinação.
Sistema monta as linhas do período
Ao abrir a tela para essa combinação, o sistema gera automaticamente uma linha de referência para o último dia de cada mês do ano informado, apresentando-as em branco para o usuário preencher o texto correspondente.
Preenchimento dos textos mês a mês
O usuário digita o texto da nota explicativa em uma ou mais das linhas/meses apresentados. Não é necessário preencher todos os meses — apenas os que tiverem conteúdo a registrar.
Gravação
Ao salvar, o sistema grava apenas os itens (meses) que tiverem texto preenchido. Se nenhum item tiver texto, a gravação é bloqueada (ver Regras de Negócio, Regra 1).
Descrição de Cada Campo da Tela
Filial
Tipo: seleção (combo/autocomplete)
Obrigatoriedade: obrigatório
Descrição: filial à qual a nota explicativa pertence.
Comportamento: compõe, junto com a conta e o ano, o identificador único da nota explicativa (formato “CodigoDaFilial|CodigoReduzConta|Ano”).
Impacto: usado para localizar e agrupar as notas na listagem, e para gerar o relatório impresso.
Conta Contábil
Tipo: seleção (autocomplete vinculado ao Plano de Contas)
Obrigatoriedade: obrigatório
Descrição: conta do Plano de Contas à qual a nota explicativa se refere (identificada pelo código reduzido da conta).
Comportamento: compõe o identificador único da nota junto com a filial e o ano.
Impacto: usado para agrupar as notas na listagem e nos filtros de busca (Plano de Contas).
Ano
Tipo: número
Obrigatoriedade: obrigatório
Descrição: ano de referência ao qual as notas explicativas pertencem.
Comportamento: obrigatório para o sistema conseguir montar a grade de meses do período (ver Regra 5); se não informado ao gerar a grade, o sistema bloqueia a operação.
Impacto: usado para filtrar a listagem e compor o identificador único da nota.
Data (linha do mês)
Tipo: data (somente leitura, gerada automaticamente)
Obrigatoriedade: gerada automaticamente pelo sistema — não editável pelo usuário
Descrição: data de referência de cada linha da nota explicativa, correspondente ao último dia de cada mês do ano informado.
Comportamento: o sistema preenche automaticamente uma linha para cada mês do ano; ao reabrir uma nota já existente, os meses ainda não preenchidos também aparecem como linhas em branco.
Impacto: usado como parte da chave de cada item de nota ao gravar/atualizar/excluir individualmente.
Texto
Tipo: texto (área de texto livre)
Obrigatoriedade: opcional por linha/mês — mas ao menos uma linha da nota precisa ter texto preenchido para permitir salvar
Descrição: conteúdo da nota explicativa para aquele mês/data.
Comportamento: se o usuário deixar o texto vazio em uma linha que já tinha conteúdo salvo anteriormente, o sistema entende isso como uma exclusão daquele item específico (ver Regra 2). Se todas as linhas ficarem vazias, o sistema bloqueia a gravação (ver Regra 1).
Impacto: texto exibido no relatório impresso de notas explicativas (“NOTAS-EXPLICATIVAS.rpt”) e nas demonstrações/obrigações que referenciam essa informação.
Utilização e Consulta de Registros
Na listagem, as notas explicativas aparecem agrupadas por filial, ano e conta contábil — uma linha por combinação, mesmo que existam vários meses preenchidos dentro do mesmo ano. O usuário pode:
Buscar livremente por ID/nome da filial, ID/nome/código da conta, ou por ano (se o texto digitado for um número, o sistema também filtra por ano igual a esse número).
Filtrar por uma ou mais filiais específicas.
Filtrar por um ano específico.
Filtrar por uma ou mais contas contábeis (é possível informar múltiplos códigos de conta na busca).
Processo de Edição das Notas Explicativas Contábeis
A edição de uma nota explicativa reaproveita a mesma tela e a mesma rotina de gravação da criação — não existe, tecnicamente, uma ação de “editar” separada de “criar”: ao reabrir uma combinação de filial + conta + ano já existente, o sistema apresenta os textos já lançados junto com os meses ainda em branco, e o usuário altera o que for necessário.
Ao salvar as alterações, o sistema decide, mês a mês, o que fazer com cada linha:
Se o mês já tinha texto e o usuário manteve ou alterou o texto (não vazio), o sistema atualiza o texto existente.
Se o mês já tinha texto e o usuário apagou o texto (deixou vazio), o sistema exclui aquele item específico.
Se o mês não tinha texto e o usuário preencheu um texto, o sistema cria um novo item.
Se o mês não tinha texto e permanece vazio, nada é feito.
Estrutura Técnica e Comportamento do Sistema das Notas Explicativas Contábeis
A gravação (tanto “Novo” quanto “Editar”) aciona internamente o mesmo método de serviço “Salvar”, que decide item a item se deve inserir, atualizar ou excluir cada linha de nota, conforme descrito na seção anterior.
A exclusão realizada pela tela remove, de uma só vez, todos os registros de Notas Explicativas Contábeis pertencentes à combinação de filial + conta + ano informada — não é possível excluir apenas um mês isoladamente por essa ação; para remover um único mês, o usuário deve salvar aquele item com o texto em branco (ver Regra 4).
A ação de impressão prepara o arquivo de relatório copiando o modelo padrão “NOTAS-EXPLICATIVAS.rpt” para a pasta do cliente, caso ainda não exista lá, antes de gerar o documento impresso.
A exportação da listagem gera um arquivo (Excel/PDF/CSV, conforme o formato solicitado) com até 1000 registros, usando a mesma projeção de dados exibida na tela de listagem.
Regras de Negócio e Restrições das Notas Explicativas Contábeis
É necessário informar ao menos um texto para salvar
Ao salvar a nota explicativa (seja incluindo ou editando), o sistema exige que pelo menos um mês tenha texto preenchido. Se nenhum item for enviado ou todos estiverem vazios, a gravação é bloqueada.
Apagar o texto de um mês exclui aquele item
Se o usuário apagar o texto de um mês que já tinha conteúdo salvo, o sistema entende essa ação como uma exclusão daquele item específico (e não como manter um item vazio).
Erros de gravação são sempre exibidos como erro
Qualquer problema durante a gravação (inclusive os bloqueios da Regra 1) é sempre exibido ao usuário como mensagem de erro, mesmo em casos em que o texto interno do sistema sugira “aviso”.
Exclusão pela tela remove a combinação inteira, não um mês isolado
A ação de excluir apaga todos os meses lançados para a filial + conta + ano informados de uma só vez. Para remover apenas um mês específico, o usuário precisa salvar aquele item com o texto em branco (ver Regra 2), em vez de usar a exclusão completa.
O ano é obrigatório para montar a grade de meses
Se o sistema tentar montar a grade de meses do período sem um ano informado, a operação é bloqueada.
Preenchimento automático dos meses ainda não lançados
Ao abrir uma nota explicativa já existente, o sistema completa automaticamente a lista com os meses do ano que ainda não têm texto lançado, exibindo-os como linhas em branco prontas para preenchimento.
Verificação de nota já existente para a combinação
Antes de criar uma nova nota, o sistema verifica se já existe algum lançamento para a mesma filial + conta + ano: se não existir nenhum, libera a criação; se já existir ao menos um lançamento, sinaliza que a combinação já possui registro.
