Documentação Técnica - Padrão IPM20

Esta documentação reúne as regras e os recursos do padrão IPM20 utilizados na emissão integrada de NFS-e, com foco em ambientes, autenticação, métodos disponíveis, particularidades municipais, uso no PlugNotas, ManagerSaaS e Componente NFSe, além de orientações sobre XML/RPS/TX2, erros comuns, arquivos de exemplo e campos customizados de impressão. Consulte este manual principalmente se você é:

• Cliente/integrador (dev/tech lead): para entender ambientes, autenticação por certificado, fluxo (DPS → NFS-e), métodos e pontos de atenção.

---

Tópicos deste artigo (Sumário)

• Manual do web service

• Portais disponíveis

• Métodos disponíveis

• Tipo de impressão

• Observações gerais do padrão

• Observações específicas por município

• Observações sobre a geração do XML

• Campos disponibilizados para adequação da Reforma Tributária

• Como obter os parâmetros de autenticação

• Emissão pelo PlugNotas

• Emissão pelo ManagerSaaS

• Emissão pelo Componente NFSe

• Erros comuns

• Campos customizados para impressão

• Exemplos de arquivos de integração

---

Manual do web service

• Manual de integração com o web service da IPM: Download do manual.

---

Portais disponíveis

• Produção
• Homologação

---

Métodos disponíveis

Emissão

• Envio sequencial (RPS em sequência): (X) Necessita ( ) Não necessita
  Nota: “envio sequencial” = a numeração do RPS precisa seguir a sequência esperada pelo web service.

• Modo: (X) Síncrono ( ) Assíncrono ( ) Ambos ( ) Não informado

• Lote: ( ) Aceita lote (X) Não aceita lote ( ) Não informado

O padrão IPM20 exige envio sequencial, opera em modo síncrono e não aceita envio de lote de RPS.

Consulta

• ( ) Consulta de lote

• () Consulta por RPS

• (X) Consulta por NFS-e

• ( ) Consulta por protocolo

• () Consulta notas tomadas

Cancelamento

• (x) cancelamento via web service

• (x) cancelamento administrativo

---

Tipo de impressão

• ( ) Impressão via link da prefeitura
  Os produtos fazem download do PDF gerado pela prefeitura.

• (X) Impressão via layout Tecnospeed
  Os produtos geram o PDF, aproximando ao máximo o layout da prefeitura.

Importante: o tipo de impressão depende do que o padrão permite. Não é possível editar livremente o layout além das opções suportadas pelo produto/padrão.

---

Observações gerais do padrão

• Padrão exige que o prestador solicite autorização para emitir via WebService. A Solicitação deve ser feita a prefeitura do prestador. 
• É necessário preencher os parâmetros "Login" e "Senha" nas configurações de Autenticação da Prefeitura com o Login e Senha de acesso ao portal da prefeitura.
  Dúvidas sobre o preenchimento, clique aqui.
• Caso o tomador seja órgão público informar o campo no campo DescricaoDocumentoTomador o valor "OP".
• O padrão IPM possui apenas um campo para envio de desconto no Xml do WebService que é preenchido pelo campo DescontoCondicionado. Em contato feito com o suporte de IPM, foi validado que o DescontoIncodicionado não existe no envio por WebService e só pode ser envaiado na emissão pelo portal da cidade
• ISSQN: É utilizado o campo customizado ValorISS para a soma do ISS de cada item. Caso não possuir múltiplos serviços, este campo ficará com o valor do ISS do único item.
• Para municípios que utilizam IPM padrão abrasf, não é permitido a emissão de múltiplos serviços.
• A consulta de NFSe pode ser feita de duas formas:
  • código verificador de autenticidade: informar o código verificador de autenticidade no parâmetro aNumeroNFSe da consulta da nota, este é o primeiro parâmetro do método Consultar. 
  • número da NFSe + série + IM: informar o número da NFSe no parâmetro do método Consultar, aNumeroNFSe e no parâmetro extra informar a SerieNFSe, além das informações de login e senha. Ex: Login=00000000000000;Senha=123;SerieNFSe=1. O cadastro da IM é preenchido automaticamente.
• O padrão IPM possui a inclusão de múltiplas parcelas. O preenchimento no arquivo TX2 de integração fica conforme exemplo abaixo: 

INCLUIRFORMAPAGAMENTO

TipoPagamento=1 -> Tipo da forma de Pagamento, verificar possíveis valores abaixo.

Parcela=1 -> Número da parcela

DataVencimentoParcela=2020-05-27 -> Data do vencimento da parcela, deve estar no formato yyyy-mm-dd

ValorParcela=2.00 -> Valor da parcela.

SALVARFORMAPAGAMENTO

 

Valores referentes ao tipo da forma de pagamento:

1 - À vista
2 - À prazo
3 - Na Apresentação
4 - Cartão de Débito
5 - Cartão de Crédito 

Cancelamento de NFS-e

• Ao realizar o cancelamento da NFS-e, o motivo de cancelamento e o código de cancelamento são obrigatórios.

• Em alguns casos, ao informar valor na tag MotivoCancelamento, pode ser retornada a mensagem "Erro na estrutura do arquivo XML enviado, verifique a estrutura da tag NFSE"; nessa situação, o artigo orienta enviar o motivo de cancelamento em branco.

• Para cancelamentos, deve ser utilizada a chave no formato numeroNFSE|chaveCancelamento.

Exemplo informado no artigo-base:

NFSe.CancelarNota("856|86_164_1_1");

---

Observações específicas por município

---

Observações sobre a geração do XML

• O código do serviço segue o que está descrito na LC-116.
  • Caso não esteja utilizando o TecnoNFSe, o código deve ser informado sem pontuação.
• O campo CodigoCNAE não é utilizado no esquema. E o campo CodigoTributacaoMunicipio é facultativo para cidades que utilizam o Schema proprietário da IPM. Para cidades que utilizam o esquema ABRASF é necessário enviar o CodigoCnae e CodigoTributacaoMunicipio.
• Caso não esteja utilizando o padrão único, a alíquota deve ser informada com o valor inteiro, utilizando ',' para separador decimal. Ex: Aliquota=5,00.
• A Tag situacao_tributaria atualmente é preenchido automaticamente pelos nossos produtos, levando em conta os outros campos informados (Clique aqui para acessar as orientações de como preencher os campos para envio correto da Situação Tributária). Caso o cliente opte por preencher esse campo manualmente, é possível através do campo SituacaoTributaria no tx2. Os números referentes ao preenchimento podem ser vistos na pg 23 do manual da IPM. O modelo Abrasf 2.04 não faz o uso deste campo
• Para gerar a tag nfse_teste no XML de envio basta informar dentro do INCLUIRRPS e SALVARRPS com um @. Dessa maneira: 
  @nfse_teste=1
  Lembrando que ao adicionar o campo acima, a nota emitida não terá valor fiscal. 

 

---

Novos campos disponibilizados para adequação da Reforma Tributária

 

FinalidadeNFSe	OperacaoPessoal	CodigoOperacao	TipoEnteGovernamental
DescTipoEnteGovernamental	ClassificacaoTributariaIbsCbs	SituacaoTributariaIbsCbs	CodigoCreditoPresumidoIbsCbs
SituacaoTributariaRegularIbsCbs	ClassifTributariaRegularIbsCbs	ValorPercDiferimentoEstadual	ValorPercDiferimentoMunicipal
ValorPercDiferimentoCbs	InscricaoFiscalImovel	CodigoCIB	CodigoPaisImovel
CepImovel	DescricaoCidadeImovel	RegiaoImovel	LogradouroImovel
NumeroImovel	ComplementoImovel	BairroImovel

Observação: Campos obrigatórios conforme o arquivo de esquema do Padrão estão destacados em negrito.

Ressaltamos que, para manter a funcionalidade em ambos os ambientes de emissão (produção e homologação), essas regras de validação ainda não foram aplicadas em nossas aplicações.

O padrão IPM disponibiliza apenas uma rota de emissão que realiza a validação da nota enviada, por esse motivo não é retornado uma nota completa, não sendo possível realizar a impressão da nota ou obter o XML de uma NFSe.

Para maiores informações sobre a forma de preenchimento destes campos novos, acesse nossa documentação do Padrão Unificado de TX2.

Municípios que seguem um esquema diferente do IPM20 convencional: 

• Novo Hamburgo/RS
• Araucária/PR
• Navegantes/SC
• Pouso Alegre/MG
• Tunápolis/SC
• Itabirito/MG
• Saudades/SC
• Riqueza/SC
• Imbituba/SC
• Estância Velha/RS
• Lacerdópolis/SC
• São Sepé/RS
• Águas Frias/SC
• Arapoti/PR
• Paraíso do Norte/PR
• Santa Rosa de Lima/SC
• Céu Azul/PR
• Gramado/RS
• Biguaçu/SC
• Carazinho/RS
• Canoinhas/SC
• Pato Bragado/PR
• Honório Serpa/PR
• Clevelândia/PR
• Palma Sola/SC
• Juranda/PR
• Camaquã/RS
• Itapiranga/SC
• Cunhaporã/SC

---

Como obter os parâmetros de autenticação 

• Em algumas cidades do padrão é necessário liberar o uso do web service no portal da prefeitura e liberar numeração de RPS no sistema do IPM Fiscal.

---

Emissão pelo PlugNotas

Conteúdo voltado para quem usa PlugNotas.

Documentação completa do produto: docs.plugnotas.com.br

Autenticação

No PlugNotas, os dados de autenticação da prefeitura para os padrões IPM e IPM20 são Login e Senha de acesso ao portal da prefeitura.

Configuração via interface

• No painel PlugNotas acesse o menu Empresas para cadastrar ou editar algum cadastro já realizado.
  Em seguida selecione a guia NFS-e: 
  Obs.: Caso não esteja aparecendo a guia NFS-e será necessário acessar Documentos Ativos para habilitar a mesma.

 

• Na guia NFS-e, localize a área Autenticação Prefeitura, onde deverá ser preenchido os campos de acordo com a definição de cada Padrão de WebService.
  Exemplo 1: Abaixo trata-se dos dados de Autenticação prefeitura definidos para o padrão IPM e IPM20 que são o Login e Senha de acesso ao portal da prefeitura:

          Exemplo 2: Abaixo trata-se dos dados de Autenticação prefeitura definidos para o padrão
          AGILI onde é necessário informar apenas o campo Senha:

Configuração via API

---

Emissão pelo ManagerSaaS

Conteúdo voltado para quem usa Manager Saas.

Documentação completa do produto: https://atendimento.tecnospeed.com.br/hc/pt-br/sections/4422795883287-Nota-de-servi%C3%A7o-NFS-e

Autenticação

• Deve ser informado no painel ManagerSaaS no menu Configurações → Autenticação da prefeitura

 

---

Emissão pelo Componente NFSe

Conteúdo voltado para quem usa Componente NFS-e V2.

Documentação completa do produto:https://atendimento.tecnospeed.com.br/hc/pt-br/sections/4422773785623-Componente-NFS-e-V2

• Os dados de Autenticação prefeitura deverão ser informadas nos parâmetros extras "Login" e "Senha" como definidos pelo padrão IPM e IPM20:

NFSe.ParametrosExtras = "Login=12123123000112;Senha=1234BC2";

---

Erros comuns

• 00209 - Já consta uma NFSe para o referido prestador de serviço com o mesmo IDENTIFICADOR de arquivo.
  Caso ocorra divergências entre a situação da nota na prefeitura (Autorizada) e em nosso produto (Enviada), será necessário ativar a opção "Retornar XML Completo" no portal da prefeitura nos seguintes passos:
  - Acesse o portal da prefeitura do município do prestador e realize o login;
  - Localize o menu Manutenção e selecione a opção Personalização do Prestador;
  - Busque pelo CNPJ do prestador:
  
  
  - Selecione o registro e clique em Alterar para editar as configurações já definidas;
  - No menu WebService ative a opção Utiliza Retorno Completo na Importação de XML e Confirme as alterações no fim da página.
  
  
  Com essa opção ativada no portal do prestador fará com que o retorno de XML sejá completo contendo não apenas a Rejeição mas também todos os dados da NFSe Autorizada na prefeitura. Dessa forma nossa API conseguirá seguir o fluxo para resolver a nota automaticamente.
  Caso não seja ativado essa opção, basta seguir os próximos passos:

• Informe o Código de Verificação da nota na rota de resolve, acrescentando o parâmetro cod_verificador_autenticidade, Exemplo:

   cod_verificador_autenticidade=1234

  • Para encontrar a Código Verificador Autenticidade da nota, é necessário fazer o download do XML no portal da prefeitura e visualizar o conteúdo da tag "<cod_verificador_autenticidade>" .
• 00282 - Não há relacionamento de bairro e logradouro com o CEP informado.
  Este padrão tem algumas peculiaridades quanto ao envio do endereço do Tomador. Para algumas cidades é necessário que o Tomador esteja cadastrado no sistema IPM e deve-se enviar no arquivo de integração os mesmos dados de endereço que estão no sistema IPM. Para corrigir siga estes passos:
  • Acessar o portal IPM https://www.nfs-e.net/fiscalweb.php
  • Cadastrar o tomador em "cadastros > globais > pessoas > incluir"

• Lista completa de rejeições

---

Campos customizados para impressão do RPS

• NomeFantasiaPrestador=String[80]

• RazaoSocialPrestador=String[80]

• EnderecoPrestador=String[80]

• CodigoCidadePrestador=String[10]

• UfPrestador=String[2]

• NumeroPrestador=String[10]

• ComplementoPrestador=String[20]

• BairroPrestador=String[20]

• CepPrestador=String[20]

• TelefonePrestador=String[40]

• EmailPrestador=String[40]

• InscricaoMunicipalPrestador=String[40]

• InscricaoEstadualPrestador=String[15]

• DescontoIncondicionado=String[40]

• DescontoCondicionado=String[40]

• ValorIss=String[40]

• BaseCalculo=String[40]

• OptanteSimplesNacional=String[1]

• ValorLiquidoNfse=String[20]

Campos customizados para impressão da NFS-e

• NomeFantasiaPrestador=String[80]

• RazaoSocialPrestador=String[80]

• EnderecoPrestador=String[80]

• CodigoCidadePrestador=String[10]

• NumeroPrestador=String[10]

• ComplementoPrestador=String[20]

• BairroPrestador=String[20]

• CepPrestador=String[20]

• EmailPrestador=String[40]

• InscricaoMunicipalPrestador=String[40]

• ValorIss=String[40]

• BaseCalculo=String[40]

• ValorCSLL=String[40]

• OutrasRetencoes=String[40]

• DescontoIncondicionado=String[40]

• DescontoCondicionado=String[40]

• InscricaoEstadualPrestador=String[15]

• TelefonePrestador=String[40]

• OptanteSimplesNacional=String[1]

• DataVencimentoISS=String[10]

• ValorTributoFederal=String[20]

• ValorTributoEstadual=String[20]

• ValorTributoMunicipal=String[20]

• PorcentagemTributoFederal=String[20]

• PorcentagemTributoEstadual=String[20]

• PorcentagemTributoMunicipal=String[20]

• ValorTotalIssrf=String[20]

• DescontoIncondicionadoServico=String[40]

• ValorLiquidoNfse=String[20]

• CelularPrestador=String[40]

---

Exemplos de arquivos de integração