Versão disponível: a partir da 4.27Neste artigo expõem-se as etapas para a integração com parceiros que realizam a emissão da NFS-e do Micro Serviço Padrão Nacional via Micro Serviço.
Caso esteja emitindo notas no Padrão Nacional através do Sankhya Om antes da versão 4.27 e não queira utilizar a emissão via Micro Serviço, não é necessário realizar essas configurações.
Configurações no sistema
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.
No cadastro da Empresa, na aba Naturezas, realize os ajustes abaixo:
Habilite a marcação "Optante pelo SIMPLES";
No campo "Cód. Regime Tribut." escolha a opção "Simples Nacional";
Selecione a opção "Anexo I - Comércio" no campo "Tipo de Partilha/Anexo SN".
Nas Preferências da Empresa, aba Documentos Fiscais Eletrônicos, sub-aba 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.
A "Configuração da Série" deve ser realizada da seguinte forma:
Primeiramente, nas Preferências da Empresa, aba Documentos Fiscais Eletrônicos, sub-aba NFS-e > Geral, verifique se o campo "Status" está definido com a opção "Credenciais Configuradas";
A série deve conter cinco dígitos, portanto, preencha os campos 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;
Desse modo, o campo "Série NFS-e" da Grade de Itens também da Central de Vendas será automaticamente configurado para que, assim, seja enviado ao Portal Nacional.
Observe abaixo os códigos e respectivos exemplos específicos para cada código de emissão, conforme o preenchimento do campo Prefixo Série NFS-e Padrão 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:
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.
Ainda nas Preferências da Empresa, aba Documentos Fiscais Eletrônicos, sub-aba NFS-e > Geral é necessário fazer a "Configuração das Credenciais". Para isso, preencha todas as informações da seção "Credenciais de Login de Prefeitura".
Assim, ao clicar no botão "Configurar Credenciais" será apresentado o pop-up "Credenciais de login da prefeitura" onde as credenciais cadastradas serão utilizadas para a emissão das NFS-e's junto à Prefeitura da cidade.
Lembre-se que, caso não possua as credenciais, deverá procurar o contador de sua empresa ou sua Prefeitura.
Caso, o campo "Cód. Regime Tribut." esteja configurado com a opção "Regime Normal", selecione o "Tipo de Regime" que a empresa faça parte, sendo "Lucro Presumido" ou "Lucro Real". Tem-se ainda que esse campo estará visível somente quando o campo Cód. Regime Tribut. estiver configurado com a opção Regime Normal.
Após informar os campos acima, ative a opção "Utiliza Ambiente Nacional?".
Após a conferência correta das informações e dados do Certificado Digital, acione o botão
"Confirmar". Assim, será efetuada a validação das informações da empresa, informações de login e do Certificado Digital válido para o CNPJ da empresa selecionada no pop-up.
Desse modo, o sistema o informará que este encontra-se apto para a emissão da NFS-e, e assim, o campo Status será alterado para a opção Credenciais Configuradas.
Abaixo, confira os possíveis cenários para a validação dos certificados no caso de emissão de NFS-e no Padrão Nacional:
- 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.
Critérios para validação do Certificado
Para a emissão da NFS-e Padrão Prefeitura será permitido utilizar o Certificado Digital da matriz, uma vez que o sistema irá verificar os campos na ordem de prioridade abaixo:
Preferências da Empresa, aba Documentos Fiscais Eletrônicos, sub-aba NFS-e > Geral: campo "Empresa certificado (NFS-e)";
Cadastro de Empresas, aba Geral: campo "Empresa Matriz";
Pop-up Credenciais de Login da Prefeitura, tela Preferências da Empresa, aba Documentos Fiscais Eletrônicos, sub-aba NFS-e > Geral: campo "CNPJ/CPF".
Para a emissão da NFS-e Padrão Nacional não será permitido utilizar o Certificado Digital da matriz, uma vez que o sistema irá verificar se esse Certificado pertence ao mesmo CNPJ da empresa emissora da NFS-e de acordo com a ordem de prioridade abaixo:
Preferências da Empresa, aba Documentos Fiscais Eletrônicos, sub-aba NFS-e > Geral: campo Empresa certificado (NFS-e);
Cadastro de Empresas, aba Geral: campo Empresa Matriz;
Pop-up Credenciais de Login da Prefeitura, tela Preferências da Empresa, aba Documentos Fiscais Eletrônicos, sub-aba NFS-e > Geral: campo CNPJ/CPF.
Nota: caso o Certificado Digital encontrado não seja do mesmo CNPJ da empresa emissora da NFS-e no Padrão Nacional, ao clicar no botão Confirmar do pop-up Credenciais de Login da Prefeitura será apresentada a mensagem abaixo:
"Certificado Digital para o CNPJ da empresa não encontrado.
Adicione um certificado válido para o CNPJ dessa empresa Matriz ou Filial na tela "Console NFS-e"."
Cidades e Cancelamento
Na tela Cidades, selecione as cidades a serem utilizadas na emissão e acione a marcação "Tem substituição NFS-e" da aba NFS-e.
Ainda na aba acima, configure o campo "Tipo de Cancelamento para NFS-e" e cadastre os motivos de cancelamento conforme definido pelo manual.
Motivos de Cancelamentos aceitos para a NFS-e Padrão Nacional:
| Código | Descrição |
| 1 | Erro na Emissão |
| 2 | Serviço não prestado |
| 9 | Outros |
Os motivos acima foram obtidos no Anexo IV-LeiautesRN_ADN-SNNFSe_V1.00.02-Produção. Então, verifique sempre a última versão da Documentação Técnica.
Motivos de Substituições aceitos para NFS-e Padrão Nacional:
| Código | Descrição |
| 01 | Desenquadramento de NFS-e do Simples Nacional |
| 02 | Enquadramento de NFS-e no Simples Nacional |
| 03 | Inclusão Retroativa de Imunidade/Isenção para NFS-e |
| 04 | Exclusão Retroativa de Imunidade/Isenção para NFS-e |
| 05 | Rejeição de NFS-e pelo tomador ou pelo intermediário se responsável pelo recolhimento do tributo |
| 99 | Outros |
Os motivos acima foram obtidos no Anexo IV-LeiautesRN_ADN-SNNFSe_V1.00.02-Produção. Então, verifique sempre a última versão da Documentação Técnica.
Template Modelo de Impressão NFS-e Padrão Nacional
Na tela Modelo de Impressão (Nota/Pedido), tem-se no botão "Baixar Modelos Padrões" a opção "Modelo Padrão NFS-e Nacional" para que o template do modelo nacional seja baixado.
Este deve ser ajustado conforme os requisitos de cada Prefeitura que emite a NFS-e com a logo da Prefeitura da nota, uma vez que esse template não possui uma logo padrão.
Operações de Doação e Estorno de Créditos de IBS e CBS
Para que o sistema identifique corretamente operações de doação e calcule os valores de estorno de IBS e CBS, é necessário que o item da nota esteja configurado com a Classificação Tributária adequada. O sistema realizará as demais identificações e cálculos de forma automática, sem necessidade de ação manual durante a emissão.
A identificação ocorre quando o item possuir 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:
| Cenário | CST | Classificação Tributária | indDoacao no XML | gEstornoCred no XML |
|---|---|---|---|---|
| Doação com contraprestação | diferente de 410 | qualquer | Não gerada | Não gerado |
| Doação sem contraprestação, sem crédito anterior | 410 | 410003 | Gerada | Não gerado |
| Doação sem contraprestação, com crédito anterior e necessidade de estorno | 410 | 410026 | Gerada | Gerado |
Quando a Classificação Tributária possuir o indicador de estorno habilitado (ind_gEstornoCred = 1), o sistema calculará automaticamente os valores de IBS e CBS a serem estornados com base no motor tributário da Reforma Tributária, podendo também recuperar os valores de crédito anteriormente apropriados a partir do documento fiscal de origem.
Quando o sistema identificar uma operação de doação, o payload enviado ao Micro Serviço de NFS-e incluirá automaticamente a tag indicador de operação de doação (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 exigir estorno. O envio desses campos ocorre somente quando o item estiver sujeito à tributação de IBS e CBS e a classificação tributária possuir o indicador de estorno habilitado. Em todos os demais casos, o payload segue o padrão normal de emissão, sem alteração no fluxo do usuário.
Estrutura do grupo de estorno no XML
Quando gerado, o grupo de estorno de créditos é inserido no seguinte caminho do XML da NFS-e: 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). Os valores dessas tags correspondem diretamente aos calculados pelo motor tributário no ERP ou recuperados do documento fiscal de origem.
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 as regras da Nota Técnica nº 005 v1.1.
Configuração para Locação de Bens Móveis
Operações de locação de bens móveis passam a exigir configurações adicionais para que as informações dos bens sejam enviadas ao Micro Serviço e geradas corretamente no XML da NFS-e Padrão Nacional.
Em Preferências da Empresa → aba Documentos Fiscais Eletrônicos → sub-aba 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.
Na TOP utilizada para emissão de NFS-e de locação de bens móveis, acesse a aba NFS-e → Seção Reforma Tributária e habilite a marcação:
"Operação de Locação de Bens Móveis"
Esta configuração indica ao sistema que a nota fiscal 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.
Os produtos vinculados a operações de locação de bens móveis devem ter o campo NCM preenchido no cadastro. Itens sem NCM não serão enviados ao Micro Serviço.
Central de Vendas - botão Outras Opções - Vinculação dos bens na nota fiscal
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. Este 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.
Nota: Quando todas as configurações acima estiverem realizadas, o envio das informações de locação de bens móveis ao Micro Serviço ocorre de forma automática durante a emissão da NFS-e. O ERP inclui no payload de integração a lista de bens vinculados ao item da nota, contendo o NCM, a descrição e a quantidade de cada bem. Não é necessária nenhuma ação adicional do usuário durante a emissão.
O envio ocorre somente quando:
- A TOP estiver configurada com a marcação "Operação de Locação de Bens Móveis";
- A preferência "Enviar detalhamento de bens móveis (NCM) em operações de locação?" estiver habilitada;
- Existirem bens vinculados no componente "Bens Objetos de Locação";
- Os bens possuírem NCM válido informado no cadastro de produtos.
Como funciona
Quando a operação for identificada como locação de bens móveis — por meio das configurações na TOP e na Preferência da Empresa descritas na seção anterior — o Micro Serviço gera automaticamente o grupo Locação de Bens Móveis (gLocBensMoveis) no XML para cada bem móvel vinculado à nota. O sistema suporta até 99 ocorrências do grupo por documento fiscal.
Estrutura do grupo no XML
O grupo Locação de Bens Móveis (gLocBensMoveis) é inserido dentro da estrutura IBSCBS da DPS, no seguinte caminho:
NFSe
└─ infNFSe
└─ DPS
└─ infDPS
└─ IBSCBS
└─ gLocBensMoveis (0 a 99 ocorrências)
├─ cNCMBemMovel
├─ xNCMBemMovel
└─ qtdNCMBemMovelOs 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 pelo sistema) -
<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 Locação de Bens Móveis (gLocBensMoveis) é gerado somente quando todas as condições abaixo forem atendidas simultaneamente:
- A operação estiver 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?" estiver habilitada nas Preferências da Empresa → aba Documentos Fiscais Eletrônicos → sub-aba NFS-e > Geral;
- Existirem bens vinculados no componente "Bens Objetos de Locação";
- Os bens possuírem NCM válido informado no cadastro de produtos.
Quando alguma dessas condições não for atendida, o grupo não é gerado no XML e a nota segue o fluxo padrão de emissão sem impacto para o usuário.
Envio de Deduções ao Micro Serviço de NFS-e
Após registrar as deduções na aba "Deduções da Base IBS/CBS", elas são automaticamente convertidas e enviadas 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 corretamente no documento fiscal gerado.
O que é o grupo de informações relativas a valores de dedução e redução da Base de Cálculo do IBS e da CBS
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. Ele é 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 nos seguintes momentos:
- Ao confirmar a NFS-e: O ERP valida todas as informações e envia o payload JSON com 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) (se houver deduções)
- Automaticamente: Não há ação manual do usuário; o envio é parte do fluxo de emissão
- Uma única vez: Após confirmar a NFS-e, ela é imutável e não pode ser reenviada
Nota: Se você não registrar deduções na aba, 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) não será incluído no payload enviado ao Micro Serviço. Neste caso, a base de cálculo será o valor total do serviço.
Estrutura do grupo de informações relativas a valores de dedução e redução da Base de Cálculo do IBS e da CBS no JSON
Quando deduções são registradas, o ERP as converte em um formato JSON estruturado como abaixo:
"gDedRedIBSCBS": [
{
"tpDedRedIBSCBS": "01",
"dscDedRedIBSCBS": "IPTU incluso no aluguel",
"vlrDedRedIBSCBS": 500.00
},
{
"tpDedRedIBSCBS": "04",
"dscDedRedIBSCBS": "Redutor Social",
"vlrDedRedIBSCBS": 250.00
}
]Cada dedução contém:
- Tipo de Dedução ou Redução de Base de Cálculo: Código do tipo de dedução (01, 02, 03, 04, 05 ou 99)
- Descrição da Dedução/Redução do IBS/CBS: Descrição da dedução (obrigatória apenas para tipo 99)
- Valor da Dedução/Redução do IBS e CBS: Valor da dedução 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:
- Valida a estrutura: Verifica se o JSON está bem formado conforme o esquema esperado
- Valida as regras de negócio: Confirma compatibilidade de tipos com NBS, valores positivos, etc.
- Calcula a base tributária: Subtrai o total de deduções do valor da nota para determinar a base para IBS e CBS
- Gera o XML: Transforma o JSON em XML conforme a NT 005 v1.1 com o grupo grupo de informações relativas a valores de dedução e redução da Base de Cálculo do IBS e da CBS (gDedRedIBSCBS) estruturado
- Envia à Prefeitura: Transmite o documento para o Portal Nacional da NFS-e
Dica: Você pode visualizar o JSON enviado ao Micro Serviço através de ferramentas de monitoramento ou logs do sistema. Isso é útil para validar que suas deduções foram corretamente formatadas antes do envio à prefeitura.
O que acontece se não houver deduções
Se você não registrar nenhuma dedução na aba "Deduções da Base IBS/CBS":
- 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)não será incluído no payload JSON - O Micro Serviço entenderá que não há deduções a processar
- A base de cálculo para IBS e CBS será o valor total da NFS-e
Nota: Omitir deduções quando são necessárias resultará em cálculo incorreto de impostos e pode gerar rejeições fiscais. Sempre registre as deduções aplicáveis à sua operação.
Impacto das deduções na base tributária
As deduções afetam diretamente o cálculo dos impostos:
Base de Cálculo (IBS/CBS) = Valor Total da NFS-e - Total de Deduções
Exemplo:
- Valor total da NFS-e: R$ 1.000,00
- Dedução de IPTU (tipo 01): R$ 100,00
- Dedução de Condomínio (tipo 03): R$ 50,00
- Total de deduções: R$ 150,00
- Base de cálculo (IBS/CBS): R$ 850,00
O IBS e CBS serão calculados sobre R$ 850,00, não sobre R$ 1.000,00.
Atenção: Deduções incorretas resultarão em base de cálculo incorreta e consequentemente em imposto a maior ou a menor. Isso pode gerar rejeições fiscais ou autuações. Sempre valide suas deduções antes de confirmar a nota.
Mensagens de validação esperadas
Durante o envio ao Micro Serviço, você pode receber as seguintes mensagens:
- "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." — Você tentou registrar dedução com valor 0.00 ou negativo
- "O campo descrição não pode exceder 150 caracteres." — A descrição (para tipo 99) ultrapassou o limite
- "Preencha a descrição da dedução para tipo 99." — Você selecionou tipo 99 mas não preencheu 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
Atenção: Se receber qualquer mensagem de erro, corrija os dados antes de tentar confirmar novamente. O sistema não permite envio de dados inconsistentes ao Micro Serviço.
Validação final antes do envio
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 tipo 99)
- ✓ Todos os valores são positivos (> 0)
- ✓ Limite de 150 caracteres na descrição
- ✓ Soma total de deduções não ultrapassa valor da nota
- ✓ Persistência em banco de dados (SQL/Oracle)
Se todas as validações passarem, a NFS-e será enviada ao Micro Serviço com o grupo de informações relativas a valores de dedução e redução da Base de Cálculo do IBS e da CBS estruturado corretamente.
Dica: Revise sempre as deduções antes de confirmar a nota. Uma vez confirmada, a NFS-e não pode ser editada — apenas cancelada e substituída conforme legislação aplicável.
O que acontece com o XML
Após você confirmar a NFS-e com deduções, o Micro Serviço converte as informações em um documento XML conforme o padrão nacional (NT 005 v1.1). Cada dedução registrada é incluída no grupo de informações relativas a valores de dedução e redução da Base de Cálculo do IBS e da CBS (gDedRedIBSCBS) do XML e a base de cálculo é automaticamente reduzida pelos valores informados.
Exemplo: se você registra uma dedução de IPTU de R$ 500,00 em uma nota de R$ 1.000,00, o XML será gerado com a base de cálculo como R$ 500,00 (não R$ 1.000,00), resultando em IBS e CBS calculados sobre esse valor reduzido.
Nota: se nenhuma dedução for registrada, o grupo de deduções não aparece no XML e a base é o valor total da nota.
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(s) 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 de pagamentos antecipados (gPagAntecipado) no XML somente quando as seguintes condições 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 (utilizada no campo
refNFSe); - os campos
tpOperetpEnteGovestão preenchidos conforme os valores permitidos pelo layout nacional; - o parceiro não está configurado como ente governamental.
Se qualquer uma dessas condições não for atendida, o grupo de pagamentos antecipados (gPagAntecipado) é simplesmente omitido do XML, sem interromper a emissão da NFS-e.
Estrutura do grupo no XML
Quando gerado, o grupo é posicionado no seguinte caminho: NFSe/infNFSe/DPS/infDPS/IBSCBS/valores/trib/gIBSCBS/gPagAntecipado/refNFSe
Observação: em caso de rejeição relacionada a esse grupo, consulte os artigos "1147 Rejeição: NF-e referenciada de pagamento antecipado inexistente" e "1146 Rejeição: NF-e referenciada de pagamento antecipado informada indevidamente".
Regras de envio do grupo de pagamentos antecipados (gPagAntecipado) ao Micro Serviço
O ERP transmite o grupo de pagamentos antecipados (gPagAntecipado) ao Micro Serviço de NFS-e somente quando todas as condições abaixo forem atendidas:
- 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 Referenciadapreenchido) - O parceiro não está configurado como ente governamental
Condições que impedem o envio:
- Ausência de documento vinculado
- Documento vinculado sem chave de acesso de NFS-e registrada
- tpEnteGov (Parceiro configurado como ente governamental)
Comentários
0 comentário
Escreva seu comentário aqui
Por favor, entre para comentar.