Tópicos deste artigo

• Manual do web service
• Portais disponíveis
• Métodos disponíveis
• Tipo de impressão
• Observações gerais
• Observações específicas por cidades
• Emissão pelo PlugNotas
• Emissão pelo ManagerEDoc/ManagerSaaS
• Emissão pelo Componente NFSe
• Observações sobre a geração do XML
• Como obter os parâmetros de autenticação
• Erros comuns 
• Campos customizados para a impressão do RPS
• Campos customizados para a impressão da NFSe

Manual de integração com o webservice

Download do manual

 

 

Portais Disponíveis 

• Produção
• Homologação

 

 

Métodos Disponíveis

• Envio
  
  • Necessita envio sequencial¹
  • Síncrono
  • Não aceita envio de lote de RPS
• Consulta de NFSe
• Cancelamento de NFSe

¹ Necessita que as notas sejam enviadas de forma sequencial

Observações gerais

• Padrão exige que o prestador solicite autorização para emitir via WebService. A Solicitação deve ser feita a prefeitura do prestador.  O formato da senha da autorização é: "Login=333333333333", e "Senha: 123abc"
• 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
• 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 o valor na tag MotivoCancelamento, é retornado a seguinte mensagem "Erro na estrutura do arquivo XML enviado, verifique a estrutura da tag NFSE", nesse caso passe o motivo do cancelamento em branco.
• 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. 

O padrão IPM20 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 

 

 

Observações específicas por cidade

 

Cidade	Observação
Novo Hamburgo/RS	Não aceita o parcelamento do valor dos serviços. A consulta da NFS-e deve ser realizada pelo número da NFS-e. (específico para componente) Informar o número da NFS-e no parâmetro da consulta da nota e no parâmetro extra informar a SerieNFSe, além das informações de login e senha Não é permitido o cancelamento via webservice, devendo o cliente realizar uma solicitação através do portal da prefeitura. A cidade de Novo Hamburgo utiliza em seu envio o padrão Abrasf, não permitindo o envio de Múltiplos Serviços
Cascavel/PR	É realizado uma solicitação de cancelamento, portanto deverá consultar a nota posteriormente para verificar se o cancelamento foi efetuado corretamente. Utiliza a serie 13 para o RPS.
Rio do Sul/SC	Múltiplos Serviços
Araquari/SC	Não utiliza desconto incondicionado, para que seja enviado o desconto para o município, deve ser informado na tag de DescontoCondicionado. Exemplo: PlugNotas: "servico":{ "valor":{ "descontoCondicionado": 99.99 } } Saas: DescontoCondicionado=99.99
Biguaçu/SC	A cidade não permite múltiplos serviços
Videira/SC	A cidade não permite emissões com competência retroativa

 

Emissão pelo PlugNotas

• Requer configuração de "login" e "senha" (são os mesmos dados usado para o acesso ao portal da prefeitura).

Exemplo de configuração da senha da autenticação pela Interface do PlugNotas

 

Exemplo de configuração da senha pela API

• Notas com situação "processando", que estiverem autorizadas no portal da prefeitura, deve ser utilizado o endpoint resolve, informando o código de verificação da NFS-e. 
  
  Exemplo: 
  
  
  

 

 

Emissão pelo ManagerEdoc/ManagerSaaS

• No Manager SaaS e eDoc é possível realizar a consulta de NFSe apenas pelo código verificador de autenticidade.
• Notas com o status "enviada" e motivo "já consta uma NFS-e para o referido prestador de serviço com o mesmo IDENTIFICADOR de arquivo", deve ser utilizado resolve e informar o código de verificação da NFS-e.  

• Requer configuração de "login" e "senha" (são os mesmos dados usado para o acesso ao portal da prefeitura).

Exemplo de configuração da senha da autenticação: 

 

 

Emissão pelo Componente NFSe

• Os dados de login e senha devem ser informados nos parâmetros extras.

Exemplo:

NFSe.ParametrosExtras = "Login=33333333333;Senha=123abc";

• Para cancelamentos,  é necessário utilizar a chave numeroNFSE|chaveCancelamento.

Exemplo:

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

 

• A consulta da NFS-e, pode ser realizada de duas maneiras:
  
  • Código verificador de autenticidade, informando o código, no parâmetro da consulta da nota. 
  • Através do número da NFS-e, informando o número da NFS-e no parâmetro da consulta da nota, e no parâmetro extra informar a SerieNFSe, além das informações de login e senha.

 

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.

 

 

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.