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
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.
- É 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 da consulta da nota.
- número da NFSe + série + IM: informar o número da NFSe no parâmetro da consulta da nota 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 NFSe
-
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.
- Para cancelamentos, é necessário utilizar a chave numeroNFSE|chaveCancelamento.
Exemplo:
NFSe.CancelarNota("856|86_164_1_1");
Observações específicas por cidade
Cidade | Observação | |
Novo Hamburgo/RS |
|
|
Cascavel/PR |
|
|
Rio do Sul/SC |
|
|
Araquari/SC |
|
|
Biguaçu/SC
|
|
|
Videira/SC |
|
|
Santo Antônio da Platina
|
|
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.
Exemplo de como liberar o uso do web service e solicitação do RPS para Tijucas:
- Primeiramente, acesse o portal do município pelo site https://tijucas.atende.net/autoatendimento e realize login:
- No menu "Empresa", localize "Emissão de NFS-e por WebService" e clique sobre ele:
- Clique em "Acessar"
- Na parte "Liberar Acesso ao Usuário" marcar "Sim" e depois "Confirmar":
- Feito isso, deve-se acessar o portal do IPM em https://nfse-tijucas.atende.net e depois de fazer login, clicar em "Acessar":
- No menu "Autorizações" clicar em "Utilização de RPS":
- Na tela que será aberta, clicar em "Incluir":
- Preencher a numeração inicial e final de RPS a ser usada e depois "Confirmar":
Para saber quando a solicitação foi concluída, basta voltar na tela anterior, preencher o ano em questão e clicar em "Consultar". Caso a solicitação tenha sido liberada, irá aparecer no campo "Situação" como "Deferido"
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"
Campos Customizados para a 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 a impressão da NFSe
- 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]
Comentários
0 comentário
Por favor, entre para comentar.