Documentação

Português

English
Español

Português

English
Español

Appearance

Gerenciar NFEs ​

Pré-requisitos de acesso

  • Permissão (módulo): viewNFEs (para ver a listagem) OU manageNFEs (para criar/editar)
  • Licença/Feature: Nenhuma.
  • Contêiner do menu: GERAL → grupo Contabilidade

O que é / quando usar ​

Esta tela administra as configurações de NFE (Nota Fiscal Eletrônica de Serviço) por tipo de operação. Cada registro define como uma nota deve ser emitida quando o usuário realiza determinado tipo de transação (compra de token, aporte, taxa de serviço etc.): qual o código de serviço da prefeitura, qual a descrição que vai na nota e se a emissão está habilitada. Não é aqui que a nota é emitida ao cliente — aqui se define o gabarito fiscal que o emissor de NFE consulta na hora de gerar a nota. As notas já geradas para os usuários ficam em Notas Fiscais Emitidas.

Pré-condições ​

  • Permissão: viewNFEs para ver; manageNFEs para criar/editar (permissão dupla — enum CPM no backend + módulo dinâmico no DB; ambas precisam estar cadastradas para a role do operador).
  • Licença/Feature: Nenhuma.
  • Dependências de outras telas: a integração com o provedor de NFE precisa estar configurada para que a emissão de fato ocorra. Esta tela apenas guarda os parâmetros de emissão por tipo.

Passo a passo ​

  1. Acesse o menu Contabilidade → Gerenciar NFEs.
  2. A tabela lista as configurações existentes, identificadas pelo tipo de operação.
  3. Clique no ícone editar (lápis) para ajustar uma configuração ou em visualizar (olho) para abri-la em modo leitura.
  4. Na tela de edição, preencha Código do serviço na cidade e Descrição para nota fiscal, e use o toggle Habilitado para ligar/desligar a emissão daquele tipo.
  5. Salve. Um rodapé (bottom-sheet) pede confirmação antes de gravar.

Campos ​

CampoO que éObrigatório?Efeito no sistema/backend
TipoTipo da operação a que a configuração se aplica (exibido na listagem)Sim (definido na criação)Chave que liga a configuração ao tipo de transação; grava type na entidade NFEConfigurations. É o identificador do gabarito.
Código do serviço na cidadeCódigo de serviço municipal (lista de serviços da prefeitura) usado na notaSim (para emissão válida)Grava properties.cityServiceCode. Vai no campo de código de serviço da NFS-e enviada ao provedor. Limite de 20 caracteres.
Descrição para nota fiscalTexto descritivo do serviço que aparece na notaSim (para emissão válida)Grava properties.description. Compõe a discriminação do serviço na nota. Limite de 20 caracteres.
HabilitadoLiga/desliga a emissão automática para aquele tipoNão (default desligado)Grava enabled. Quando desligado, transações daquele tipo não disparam emissão de NFE, mesmo que os demais campos estejam preenchidos.

WARNING

O formulário só libera o botão Salvar quando Código do serviço na cidade e Descrição estão preenchidos. Ambos têm limite de 20 caracteres — descrições longas precisam ser resumidas.

Ações e modais ​

  • Novo / Criar: abre o formulário em branco. Ao confirmar no bottom-sheet, chama createNFE. Se já existir uma configuração para aquele tipo (violação de chave única), o sistema mostra o erro de "iniciais já existentes" — escolha outro tipo ou edite o existente.
  • Editar: carrega a configuração e grava via saveNFE (PUT). Um bottom-sheet de confirmação é exibido antes de salvar.
  • Visualizar: modo somente leitura; o botão Editar dentro da tela leva ao modo de edição.
  • Cancelar: se houver edição/criação em andamento, pede confirmação para descartar antes de voltar à listagem.

Regras de negócio / cuidados ​

Atenção

  • O Tipo é a chave da configuração. Não é possível ter duas configurações para o mesmo tipo — o backend rejeita por violação de chave única.
  • O toggle Habilitado é o interruptor mestre da emissão daquele tipo: desligá-lo suspende a geração de notas sem apagar a configuração.
  • Conformidade fiscal: o código de serviço e a descrição precisam refletir o serviço real prestado e o cadastro municipal da empresa — campos incorretos geram notas inválidas perante a prefeitura.
  • Valores financeiros: esta tela não trata valores; os montantes da nota vêm da transação que a originou.

Telas relacionadas ​