Processo Emissão da NFS-e Padrão Nacional via Micro Serviço

Caminho de acesso: Menu Principal › Preferências › Empresa › Documentos Fiscais Eletrônicos › NFS-e

Telas associadas a esta jornada: Preferências · Cadastro de Empresas · Preferências da Empresa · Central de Vendas · Tipos de Operação - TOP · Cidades · Modelo de Impressão (Nota/Pedido) · Cadastro de Produtos

Você encontra neste artigo:

O que é e para que serve

A emissão da NFS-e Padrão Nacional via Micro Serviço integra o Sankhya Om a parceiros que transmitem a Nota Fiscal de Serviço Eletrônica (NFS-e) ao Portal Nacional por meio de um Micro Serviço, disponível a partir da versão 4.27. Este artigo reúne todas as configurações necessárias para habilitar essa emissão — parâmetros, credenciais, certificado, cidades, template de impressão e as regras específicas de doação/estorno, locação de bens móveis, deduções e pagamento antecipado.

Este artigo não trata da emissão de NFS-e no Padrão Prefeitura e não se aplica a quem emite no Padrão Nacional em versões anteriores à 4.27 sem utilizar o Micro Serviço — nesses casos, as configurações aqui descritas não são necessárias.

Antes de começar

Antes de iniciar as configurações, garanta os pré-requisitos abaixo, que precisam ser resolvidos fora das telas de configuração:

• O Sankhya Om deve estar na versão 4.27 ou superior.
• Você precisa das credenciais de login da Prefeitura do município emissor.
• É necessário um Certificado Digital válido para o CNPJ da empresa emissora da NFS-e.

↑ Voltar ao início

Configurações no sistema

Realize as etapas abaixo, na ordem apresentada, para habilitar a emissão da NFS-e Padrão Nacional via Micro Serviço.

1. Na tela Preferências, configure o parâmetro Cód. IBGE Munic. utilizam NFSe Nacional via broker (CODIBGENFSENAC) com o código IBGE do município. Caso haja mais de um, separe-os por vírgulas.

2. No cadastro da Empresa, aba Naturezas, faça os ajustes:

   • Habilite a marcação Optante pelo SIMPLES.
   • No campo Cód. Regime Tribut., escolha Simples Nacional.
   • No campo Tipo de Partilha/Anexo SN, selecione Anexo I - Comércio.

   

3. Nas Preferências da Empresa, em Documentos Fiscais Eletrônicos › NFS-e › Geral, preencha o campo Regime de Apuração dos Tributos do Simples Nacional com a opção 3 - Reg. Apuração Trib. Fed. e Mun. pela NFSe conforme legislação Fed. e Mun. de cada tributo e o campo Prefixo Série NFS-e Padrão Nacional de acordo com a Configuração da Série.

   Geral, com os campos Regime de Apuração dos Tributos do Simples Nacional e Prefixo Série NFS-e Padrão Nacional"

   A Configuração da Série deve ser feita assim:

   • Verifique se o campo Status está definido como Credenciais Configuradas.
   • A série deve conter cinco dígitos: preencha Prefixo Série NFS-e Padrão Nacional com dois dígitos e o campo Série da Nota da Grade Cabeçalho da Central de Vendas com três dígitos.
   • Com isso, o campo Série NFS-e da Grade de Itens da Central de Vendas é configurado automaticamente para envio ao Portal Nacional.

   Para emissão via Micro Serviço da versão 4.27 em diante, utilize a faixa 00001 a 49999 - Emissão com aplicativo próprio. Exemplo de preenchimento:

   • Prefixo = 00 → campo Prefixo Série NFS-e Padrão Nacional.
   • Série da nota = 001 → campo Série (Controle de numeração da tela Tipos de Operação - TOP).
   • Série NFS-e = 00001 → a ser gerada na DPS.

4. Ainda nas Preferências da Empresa › Documentos Fiscais Eletrônicos › NFS-e › Geral, faça a Configuração das Credenciais: preencha todas as informações da seção Credenciais de Login de Prefeitura.

   

   Ao clicar em Configurar Credenciais, o sistema apresenta o pop-up Credenciais de login da prefeitura, cujas credenciais são usadas na emissão das NFS-e junto à Prefeitura do município.

   

   Depois de informar os campos acima, ative a opção Utiliza Ambiente Nacional?.

   

   ℹ️ Nota

   Se o campo Cód. Regime Tribut. estiver configurado como Regime Normal, selecione em Tipo de Regime a opção da empresa: Lucro Presumido ou Lucro Real. Esse campo fica visível somente quando Cód. Regime Tribut. está como Regime Normal.

5. Após conferir as informações e os dados do Certificado Digital, clique em Confirmar. O sistema valida as informações da empresa, os dados de login e se há Certificado Digital válido para o CNPJ da empresa selecionada no pop-up. Estando apto, o sistema informa que a empresa pode emitir a NFS-e e o campo Status muda para Credenciais Configuradas.

   Os cenários possíveis de validação do certificado na emissão no Padrão Nacional são:

   • Validar empresa sem configuração para broker nacional com próprio certificado
   • Validar empresa sem configuração para broker nacional com certificado de 3's
   • Validar empresa com configuração para broker nacional com próprio certificado
   • Validar empresa com configuração para broker nacional com certificado de 3's

↑ Voltar ao início

Critérios para validação do Certificado

Para a emissão da NFS-e Padrão Prefeitura, é permitido utilizar o Certificado Digital da matriz. O sistema verifica os campos na seguinte ordem de prioridade:

1. Preferências da Empresa › Documentos Fiscais Eletrônicos › NFS-e › Geral: campo Empresa certificado (NFS-e).
2. Cadastro de Empresas › Geral: campo Empresa Matriz.
3. Pop-up Credenciais de Login da Prefeitura (Preferências da Empresa › Documentos Fiscais Eletrônicos › NFS-e › Geral): campo CNPJ/CPF.

Para a emissão da NFS-e Padrão Nacional, não é permitido utilizar o Certificado Digital da matriz: o sistema verifica se o certificado pertence ao mesmo CNPJ da empresa emissora, na ordem de prioridade:

1. Preferências da Empresa › Documentos Fiscais Eletrônicos › NFS-e › Geral: campo Empresa certificado (NFS-e).
2. Cadastro de Empresas › Geral: campo Empresa Matriz.
3. Pop-up Credenciais de Login da Prefeitura (Preferências da Empresa › Documentos Fiscais Eletrônicos › NFS-e › Geral): campo CNPJ/CPF.

↑ Voltar ao início

Cidades e Cancelamento

Na tela Cidades, aba NFS-e, selecione as cidades a serem utilizadas na emissão e acione a marcação Tem substituição NFS-e. Ainda nessa aba, configure o campo Tipo de Cancelamento para NFS-e e cadastre os motivos de cancelamento conforme o manual.

Motivos de cancelamento aceitos para a NFS-e Padrão Nacional:

Motivos de substituição aceitos para a NFS-e Padrão Nacional:

↑ Voltar ao início

Template Modelo de Impressão NFS-e Padrão Nacional

Na tela Modelo de Impressão (Nota/Pedido), o botão Baixar Modelos Padrões oferece a opção Modelo Padrão NFS-e Nacional para baixar o template do modelo nacional.

Ajuste esse template conforme os requisitos de cada Prefeitura que emite a NFS-e, incluindo a logo da Prefeitura na nota, uma vez que o template não possui uma logo padrão.

↑ Voltar ao início

Operações de Doação e Estorno de Créditos de IBS e CBS

Para que o sistema identifique operações de doação e calcule os valores de estorno de IBS e CBS, o item da nota precisa estar configurado com a Classificação Tributária adequada. As demais identificações e cálculos são automáticos, sem ação manual durante a emissão. A identificação ocorre quando o item possui CST = 410, Classificação Tributária = 410003 ou 410026, e incidência de IBS e CBS.

A tabela abaixo apresenta os cenários suportados e o impacto na geração das tags indicador de operação de doação (indDoacao) e estorno de créditos de IBS e CBS (gEstornoCred) no XML:

Quando a Classificação Tributária possui o indicador de estorno habilitado (ind_gEstornoCred = 1), o sistema calcula automaticamente os valores de IBS e CBS a estornar com base no motor tributário da Reforma Tributária, podendo recuperar os valores de crédito anteriormente apropriados a partir do documento fiscal de origem.

Quando identifica uma operação de doação, o payload enviado ao Micro Serviço de NFS-e inclui automaticamente a tag indDoacao, quando aplicável, e as tags valor de estorno de crédito de IBS (vIBSEstCred) e valor de estorno de crédito de CBS (vCBSEstCred), quando a Classificação Tributária exige estorno. O envio ocorre somente quando o item está sujeito à tributação de IBS e CBS e a Classificação Tributária possui o indicador de estorno habilitado. Nos demais casos, o payload segue o padrão normal de emissão, sem alteração no fluxo.

Estrutura do grupo de estorno no XML — quando gerado, o grupo de estorno de créditos é inserido no caminho: NFSe/infNFSe/DPS/infDPS/IBSCBS/valores/trib/gIBSCBS/gEstornoCred. O grupo contém as tags valor do crédito de IBS estornado (vIBSEstCred) e valor do crédito de CBS estornado (vCBSEstCred), cujos valores correspondem aos calculados pelo motor tributário no ERP ou recuperados do documento fiscal de origem.

↑ Voltar ao início

Locação de Bens Móveis

O sistema suporta a geração do grupo Locação de Bens Móveis (gLocBensMoveis) no XML da NFS-e Padrão Nacional para operações de locação de bens móveis, conforme a Nota Técnica nº 005 v1.1. Essas operações exigem configurações adicionais para que as informações dos bens sejam enviadas ao Micro Serviço e geradas corretamente no XML.

Configuração para Locação de Bens Móveis

1. Preferências da Empresa — em Documentos Fiscais Eletrônicos › NFS-e › Geral, habilite a marcação Enviar detalhamento de bens móveis (NCM) em operações de locação?. Quando habilitada, o sistema inclui automaticamente no payload de integração com o Micro Serviço a lista de bens móveis vinculados à operação.
2. Tipos de Operação - TOP — na TOP usada para emissão de NFS-e de locação de bens móveis, acesse NFS-e › Seção Reforma Tributária e habilite a marcação Operação de Locação de Bens Móveis. Essa configuração indica que a nota deve recuperar os bens móveis exclusivamente a partir do componente Bens Objetos de Locação, disponível no botão Outras Opções da grade de itens.
3. Cadastro de Produtos — os produtos vinculados a operações de locação devem ter o campo NCM preenchido. Itens sem NCM não são enviados ao Micro Serviço.
4. Central de Vendas - botão Outras Opções — durante a emissão da nota de prestação de serviço de locação, acesse o botão Outras Opções na grade de itens e utilize o componente Bens Objetos de Locação para vincular os bens móveis locados ao item da nota. Esse componente é a origem oficial do vínculo entre os bens e o documento fiscal — a recuperação automática via contrato de locação não é mais utilizada.

Como funciona

Quando a operação é identificada como locação de bens móveis — pelas configurações na TOP e na Preferência da Empresa descritas acima — o Micro Serviço gera automaticamente o grupo gLocBensMoveis no XML para cada bem móvel vinculado à nota, suportando até 99 ocorrências do grupo por documento fiscal. O envio ocorre de forma automática durante a emissão, sem ação adicional: o ERP inclui no payload a lista de bens vinculados ao item, com NCM, descrição e quantidade de cada bem.

Estrutura do grupo no XML

O grupo gLocBensMoveis é inserido dentro da estrutura IBSCBS da DPS, no caminho:

NFSe
└─ infNFSe
   └─ DPS
      └─ infDPS
         └─ IBSCBS
            └─ gLocBensMoveis (0 a 99 ocorrências)
               ├─ cNCMBemMovel
               ├─ xNCMBemMovel
               └─ qtdNCMBemMovel

Os campos gerados em cada ocorrência do grupo são:

• cNCMBemMovel — Código NCM do bem móvel, com 8 dígitos numéricos (máscaras e separadores são removidos automaticamente).
• xNCMBemMovel — Descrição do bem móvel (máximo de 150 caracteres).
• qtdNCMBemMovel — Quantidade física do bem móvel locado no período.

Regras de geração

O grupo gLocBensMoveis é gerado somente quando todas as condições abaixo são atendidas simultaneamente:

• A operação está configurada como locação de bens móveis na TOP.
• A preferência Enviar detalhamento de bens móveis (NCM) em operações de locação? está habilitada nas Preferências da Empresa › Documentos Fiscais Eletrônicos › NFS-e › Geral.
• Existem bens vinculados no componente Bens Objetos de Locação.
• Os bens possuem NCM válido informado no cadastro de produtos.

Quando alguma condição não é atendida, o grupo não é gerado no XML e a nota segue o fluxo padrão de emissão, sem impacto.

↑ Voltar ao início

Envio de Deduções ao Micro Serviço de NFS-e

Depois de registrar as deduções na aba Deduções da Base IBS/CBS, elas são convertidas e enviadas automaticamente ao Micro Serviço de NFS-e como parte do payload JSON. O Micro Serviço transforma essas informações na estrutura XML conforme a NT 005 v1.1, garantindo que o abatimento da base tributária (IBS e CBS) seja refletido no documento fiscal.

O que é o grupo gDedRedIBSCBS

O Grupo de informações relativas a valores de dedução e redução da Base de Cálculo do IBS e da CBS (gDedRedIBSCBS) é a estrutura técnica no layout nacional da NFS-e que armazena todas as deduções registradas na nota. É gerado automaticamente pelo ERP e enviado ao Micro Serviço apenas quando há deduções cadastradas.

Quando as deduções são enviadas

As deduções são enviadas ao Micro Serviço ao confirmar a NFS-e: o ERP valida as informações e envia o payload JSON com o grupo gDedRedIBSCBS (se houver deduções). O envio é automático, sem ação manual, e ocorre uma única vez — após confirmada, a NFS-e é imutável e não pode ser reenviada. Se você não registrar deduções na aba, o grupo gDedRedIBSCBS não é incluído no payload e a base de cálculo será o valor total do serviço.

Estrutura do grupo no JSON

Quando há deduções, o ERP as converte em um JSON estruturado:

"gDedRedIBSCBS": [
  {
    "tpDedRedIBSCBS": "01",
    "dscDedRedIBSCBS": "IPTU incluso no aluguel",
    "vlrDedRedIBSCBS": 500.00
  },
  {
    "tpDedRedIBSCBS": "04",
    "dscDedRedIBSCBS": "Redutor Social",
    "vlrDedRedIBSCBS": 250.00
  }
]

Cada dedução contém o Tipo de Dedução ou Redução de Base de Cálculo (tpDedRedIBSCBS, com os códigos 01, 02, 03, 04, 05 ou 99), a Descrição da Dedução/Redução (dscDedRedIBSCBS, obrigatória apenas para o tipo 99) e o Valor da Dedução/Redução de IBS e CBS (vlrDedRedIBSCBS, em formato numérico).

Como o Micro Serviço processa as deduções

Após receber o payload JSON com o grupo gDedRedIBSCBS, o Micro Serviço:

1. Valida a estrutura, verificando se o JSON está bem formado conforme o esquema esperado.
2. Valida as regras de negócio, confirmando compatibilidade de tipos com a NBS, valores positivos etc.
3. Calcula a base tributária, subtraindo o total de deduções do valor da nota.
4. Gera o XML conforme a NT 005 v1.1, com o grupo gDedRedIBSCBS estruturado.
5. Envia o documento à Prefeitura, transmitindo ao Portal Nacional da NFS-e.

Você pode visualizar o JSON enviado ao Micro Serviço por ferramentas de monitoramento ou logs do sistema, o que ajuda a validar a formatação das deduções antes do envio à Prefeitura.

Impacto das deduções na base tributária

As deduções afetam diretamente o cálculo dos impostos, conforme: Base de Cálculo (IBS/CBS) = Valor Total da NFS-e - Total de Deduções. Por exemplo, em uma NFS-e de R$ 1.000,00 com dedução de IPTU (tipo 01) de R$ 100,00 e dedução de condomínio (tipo 03) de R$ 50,00, o total de deduções é R$ 150,00 e a base de cálculo de IBS/CBS passa a ser R$ 850,00 — o IBS e a CBS incidem sobre R$ 850,00, não sobre R$ 1.000,00.

Mensagens de validação esperadas

Durante o envio ao Micro Serviço, você pode receber as mensagens abaixo. Corrija os dados antes de confirmar novamente — o sistema não permite o envio de dados inconsistentes ao Micro Serviço.

• "O tipo de dedução '04 - Redutor Social' é permitido apenas para NBS 1.1002.10.00." — o tipo escolhido é incompatível com a NBS do item.
• "O valor da dedução deve ser maior que zero." — foi registrada dedução com valor 0.00 ou negativo.
• "O campo descrição não pode exceder 150 caracteres." — a descrição (para o tipo 99) ultrapassou o limite.
• "Preencha a descrição da dedução para tipo 99." — foi selecionado o tipo 99 sem preencher a descrição.
• "A soma das deduções não pode ultrapassar o valor total da NFS-e." — o total de deduções é maior que o valor da nota.

Antes de confirmar uma NFS-e com deduções, o sistema valida automaticamente: compatibilidade entre tipo de dedução e NBS do item; descrição obrigatória preenchida (para o tipo 99); todos os valores positivos (> 0); limite de 150 caracteres na descrição; soma total de deduções não superior ao valor da nota; e persistência em banco de dados (SQL/Oracle). Se todas as validações passarem, a NFS-e é enviada ao Micro Serviço com o grupo gDedRedIBSCBS estruturado corretamente.

O que acontece com o XML

Após confirmar a NFS-e com deduções, o Micro Serviço converte as informações em XML conforme o Padrão Nacional (NT 005 v1.1). Cada dedução registrada é incluída no grupo gDedRedIBSCBS do XML e a base de cálculo é reduzida pelos valores informados. Por exemplo, uma dedução de IPTU de R$ 500,00 em uma nota de R$ 1.000,00 gera o XML com base de cálculo de R$ 500,00. Se nenhuma dedução for registrada, o grupo não aparece no XML e a base é o valor total da nota.

↑ Voltar ao início

"gReeRepRes": [
  {
    "tpReeRepRes": "01",
    "descricao": "Repasse de comissão para agente",
    "cnpjcpfTerc": "12345678000190",
    "vlrReeRepRes": 150.00,
    "percentualReeRepRes": 10.00
  },
  {
    "tpReeRepRes": "02",
    "descricao": "Reembolso de despesa de transporte",
    "cnpjcpfTerc": "98765432000180",
    "vlrReeRepRes": 75.50,
    "percentualReeRepRes": 5.00
  }
]

Pagamento Antecipado (NT 005 v1.1)

A partir da NT 005 v1.1, o layout nacional da NFS-e passa a exigir o grupo de pagamentos antecipados (gPagAntecipado) no XML, responsável por vincular NFS-e previamente emitidas que representem pagamento antecipado do serviço. Essa exigência não se aplica a parceiros configurados como ente governamental.

Para vincular a(s) NFS-e de pagamento antecipado previamente emitidas, acesse, na Central de Vendas, a aba Referências e ajustes da NFS-e › sub-aba NFS-e referenciadas e realize o vínculo com o documento fiscal correspondente.

O Micro Serviço de NFS-e gera o grupo gPagAntecipado no XML somente quando todas as condições abaixo são atendidas simultaneamente:

• Existe NFS-e de pagamento antecipado vinculada na aba Referências e ajustes da NFS-e.
• O documento vinculado é uma NFS-e Nacional válida e possui chave de acesso registrada (usada no campo refNFSe).
• Os campos tpOper e tpEnteGov estão preenchidos conforme os valores permitidos pelo layout nacional.
• O parceiro não está configurado como ente governamental.

Se qualquer condição não for atendida, o grupo gPagAntecipado é omitido do XML, sem interromper a emissão da NFS-e.

Estrutura do grupo no XML — quando gerado, o grupo é posicionado no caminho: NFSe/infNFSe/DPS/infDPS/IBSCBS/valores/trib/gIBSCBS/gPagAntecipado/refNFSe.

Regras de envio do grupo gPagAntecipado ao Micro Serviço — o ERP transmite o grupo somente quando existe NFS-e de pagamento antecipado vinculada na aba Referências e ajustes da NFS-e, o documento vinculado possui chave de acesso registrada (campo Nota Fiscal de Serviços Eletrônica Referenciada preenchido) e o parceiro não está configurado como ente governamental. As condições que impedem o envio são: ausência de documento vinculado; documento vinculado sem chave de acesso de NFS-e registrada; ou parceiro configurado como ente governamental (tpEnteGov).

↑ Voltar ao início