Manual de integração com o webservice

Download do manual

Portais Disponíveis

• Produção
• Homologação

Métodos Disponíveis

• Envio.
  • Síncrono.
• Consulta de NFSe.
• Cancelamento de NFSe. 

Observações

• Não utiliza certificado digital para assinatura de XML.
• Para iniciar a integração Web Service, é necessário solicitar o código “TOKEN” que estará disponível no cadastro do contribuinte no site da NFS-e.
  • Ao realizar os métodos disponíveis no componente, este token deve ser informado da seguinte forma: "senha=XXXXXXXXXXXXXXXXX", pois o componente automaticamente concatena a inscrição municipal ao token, ficando ao final da seguinte forma: "123456-AGHJOPBEFFRE3Z4VIRZKZKIIY9ILLOOP", por exemplo.
  • No Edoc/Saas/PlugNotas o token deverá ser informado nas configurações, na aba de Autenticação da Prefeitura.
  • No PlugNotas a Inscrição Municipal precisa ser informada no campo de Login e o token no campo de Senha nas configurações de Autenticação da Prefeitura.
  •  
• Não aceita envio em lote.
• A cada nota enviada ao Webservice, deve-se incrementar o número do rps.
• Nos testes realizados, a quebra de linha não funcionou corretamente, portanto mesmo ao informar o caracter  pipe ' | ',  a quebra de linha não ocorrerá na comunicação com o Webservice.
• Para impressão - fazer a chamada utilizando o XML de sucesso do retorno do envio síncrono que tem a tag <link> com o XML utilizado no envio síncrono. (exemplo: ProxyNFSe.ComponenteNFSe.Impressao.CriarDatasets('XML de retorno do envio Sincrono','XML do envio sincrono');

Componente

•  Para consultar a NFSe deve ser usado o valor do código de verificação localizado na tag <codigoVerificacao> no lugar do número da NFSe.
  Ex V1: ConsultarNota(aCodigoVerificacao, senha='token fornecido pela prefeitura')
  Ex V2: Consultar(aCodigoVerificacao, null, null, null, null)
• A chave de cancelamento da NFSe é formada pelo número da NFSe e pelo número do RPS correspondente. Deve ser informada dessa forma: "NumeroNFSe_NumeroRPS".

Notas Rejeitadas por Duplicidade (Edoc/SaaS)

• Caso ocorra divergências entre a situação da nota na prefeitura (Autorizada) e em nosso produto (Enviada), o procedimento a ser realizado é informar o Código de Verificação da nota na rota de resolve, acrescentando o parâmetro CodVerificacao, Exemplo: CodVerificacao=12345678AB
  
  • Para encontrar a Código de Verificação da nota, é necessário fazer o download do XML no portal da prefeitura e visualizar o conteúdo da tag "<codigoVerificacao>" ;

• Procedimentos: 
  • Para comunicações via API:
    • O parâmetro CodVerificacao=... deverá ser adicionado no body da requisição, como no exemplo abaixo:
  • Para comunicações via integração por pasta:
    • o parâmetro CodVerificacao=... deverá ser adicionado no TX2;
  • Para realizar via Interface Web:
    • Selecione a nota desejada e clique no botão RESOLVE. Abrirá uma caixa de texto aonde deve ser informado o código de verificação daquela nota.
      
      • Obs.: O procedimento funcionará apenas quando:
        
        • A nota estiver com a situação ENVIADA.
        • Possuir um motivo de duplicidade.
        • Apenas uma nota for selecionada.

• ATENÇÃO: a sincronização será realizada independente de que as informações contidas na nota emitida difiram da NFSe do portal da prefeitura. Portanto, é necessário se certificar que o Código de Verificação sejam exatamente os correspondentes à nota resolvida.

Geração do XML - Campos Importantes

• O código do serviço segue o que está descrito na  LC-116.
• É obrigatório informar o código CNAE.
  • Código CNAE segue a tabela nacional com 7 digítos.
• Acentuação muitas vezes causa problema de rejeição no servidor. Devido a isso está sendo removido os acentos do RPS.

Campos customizados para a impressão

Impressão do RPS

• RazaoSocialPrestador=String[80]
• CpfCnpjPrestador=String[14]
• InscricaoEstadualPrestador=String[20]
• EnderecoPrestador=String[80]
• NumeroEnderecoPrestador=String[10]
• CepPrestador=String[15]
• ComplementoPrestador=String[50]
• BairroPrestador=String[50]
• MunicipioPrestador=String[30]
• UfPrestador=String[2]
• PaisPrestador=String[20]
• EmailPrestador=String[50]
• TelefonePrestador=String[11]
• TelefoneTomador=String[11]
• CodigoMunicipioIncidencia=String[15]
• InscricaoMunicipalTomador=String[20]
• BaseCalculoISS=String[10]
• ValorISS=String[10]
• ValorIrrf=String[10]
• ValorPis=String[10]
• ValorLiquidoNfse=String[10]
• ValorDeducoes=String[10]
• ValorTotalTributos=String[10]
• OutrasRetencoes=String[10]
• Competencia=String[10]
• OptanteSimplesNacional=String[2]
• NomePrestador=String[80]
• SitePrestador=String[100]

Impressão da NFSe

• CpfCnpjPrestador=String[14]
• InscricaoEstadualPrestador=String[20]
• EnderecoPrestador=String[80]
• NumeroEnderecoPrestador=String[10]
• CepPrestador=String[15]
• ComplementoPrestador=String[50]
• BairroPrestador=String[50]
• MunicipioPrestador=String[30]
• UfPrestador=String[2]
• PaisPrestador=String[20]
• EmailPrestador=String[50]
• TelefonePrestador=String[11]
• TelefoneTomador=String[11]
• CodigoMunicipioIncidencia=String[15]
• InscricaoMunicipalTomador=String[20]
• BaseCalculoISS=String[10]
• VlrISS=String[10]
• ValorIrrf=String[10]
• ValorPis=String[10]
• ValorLiquidoNota=String[10]
• ValorDeducoes=String[10]
• ValorTotalTributos=String[10]
• OutrasRetencoes=String[10]
• Competencia=String[10]
• IssPagoTomadorServico=String[1]
• CodigoCancelamento=String[2]
• HoraCancelamento=String[5]
• OptanteSimplesNacional=String[2]
• SitePrestador=String[100]
• Serie=String[2]
• HoraEmissao=String[8]

Soluções Tecnospeed

• Componente NFSe:    Release 8.7.49.X.
• Manager eDoc:    Release 3.0.83.X.