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

ATENÇÃO: A partir do dia 1 de julho (07/2021) as seguintes alterações entrarão em vigor:

• O padrão não possui mais sistema de Dados de RPS! Ou seja, o padrão não informará número, série e tipo de RPS no Envio, portanto tome cuidado para não duplicar suas notas ao fazer dois envios do mesmo XML.
• Alterado a Consulta de NFSe por RPS, para a Consulta de NFSe. Sua consulta será realizada informando o número da nota, mais os parâmetros extras.

• O padrão utiliza Token para a geração, consulta e cancelamento de NFSe;
• O Token tem validade de 24h, podendo assim, emitir, consultar e cancelar quantas NFS-e desejar nesse período;
• Após 24h, o Token será expirado e não poderá ser mais utilizado para nenhum método. Assim o componente irá gerar outro de forma automática.
• Para utilização do webservice é necessário contato prévio com a prefeitura para
  que seja feita a liberação do serviço para o contribuinte em questão. Neste momento será disponibilizado uma senha de utilização do webservice.
• O padrão não possui envio em lote, só é possível enviar uma NFSe por vez;
• O padrão não possui quebra de linha;
• A Chave de cancelamento da nota emitida, poderá ser obtida através de uma consulta de NFSe por RPS, da mesma nota. Segue o exemplo de uma chave de cancelamento:
  • ChaveCancelamento=111_0103_A1B2C3d4E5_02_2021
  • Sendo os valores divididos por '_' equivalentes respectivamente aos seguintes valores:
    • NumeroNota_CodigoAtividade_CodigoValidacao_Mes_Ano
• O padrão utilizará os parâmetros extras abaixo, sendo eles:
  • Inscrição Sequencial e Senha:
    •  Obtido no usuário do portal da prefeitura, acessando o Menu Principal procure por: "WebService -> Token" ou entre em contato com a prefeitura.
      • Deve ser passado como parâmetro Extra, como InscricaoSequencial e Senha, para todos os Métodos disponíveis (Exemplos abaixo);
  • Envio Email:
    •  Autorizará ou não, o envio de e-mail.
      • Na Consulta de NFSe por RPS será passado como parâmetro Extra, como EnvioEmail, Sendo '1' ou 'S' para Sim, e '2' ou 'N' para Não.(Exemplos abaixo);

• Parâmetros Extras nos Métodos:
  • Envio:
    • Para realizar o Envio é necessário informar os campos Senha e InscricaoSequencial, por exemplo:
      • Senha=11111111111111_11111;InscricaoSequencial=111
  • Cancelamento
    • Para realizar o Cancelamento da NFS-e é necessário informar a chave de cancelamento e os parâmetros Extras;
    • A chave de cancelamento é obtida a partir de uma consulta de uma NFS-e por Rps;
    • Os parâmetros extras devem ser informados conforme o exemplo: 
      • Senha=11111111111111_11111;InscricaoSequencial=111
  • Consulta de NFSe
    • Para realizar a Consulta de uma NFS-e é necessário informar os seguintes parâmetros extras:
      •  Senha=11111111111111_11111;InscricaoSequencial=111;CodigoPreNota=YYYYYYYY;EnvioEmail=S;CodigoAtividade=1111;MesNFSe=02;AnoNFSe=2021
      • Observação: O campo código CodigoPreNota é o código de validação da nota, existente no retorno do envio.

• Manager SaaS:
  • A Inscrição Sequencial deve ser configurada no campo Login da GUI Web do Manager SaaS.  Configurações -> Autenticação da Prefeitura -> Campo Login. 
  • A Senha deve ser configurado no campo Senha da GUI Web do Manager SaaS.  Configurações -> Autenticação da Prefeitura -> Campo Senha. 

Geração do XML - Campos Importantes

• O código do serviço segue o que está descrito na LC-116.
• Não possui CNAE e nem CodigoTributacaoMunicipio.
• Na geração do XML pelo Tx2 padrão TecnoNFSe, os campos devem ser preenchidos da seguinte forma:
  
  • TipoDocumentoTomador=Informe 1 para pessoa Física ou informe 2 para pessoa Jurídica;
  • DescricaoRps=será referente ao campo da Descrição Resumida da NFS-e;
  • DiscriminaçãoServico=será referente ao campo da Descrição Detalhada da NFS-e;
  • MunicipioIncidencia=Informe o código do Município referente ao Local de Retenção do serviço.
• Para saber como obter o valor dos campos, verifique o item Observações dessa Documentação;
• Em caso de tomador estrangeiro deve-se observar os seguintes dados:
  • DocTomadorEstrangeiro=Informe o número do documento estrangeiro
  • CidadeEstrangeiraTomador=Informe a descrição da cidade estrangeira do Tomador.
  • PaisTomador=Informe o código do pais do Tomador.
  • CepTomador=Informe o código postal do Tomador.
  • UfTomador=Informe 'EX' ou a descrição do Estado, Província ou Região.
  • CodigoCidadeTomador=9999999
  • CpfCnpjTomador=99999999999

Campos customizados para a impressão

Impressão do RPS

• RazaoSocialPrestador=String[50]
• EnderecoPrestador=String[50]
• NumeroEnderecoPrestador=String[50]
• ComplementoEnderecoPrestador=String[50]
• BairroPrestador=String[50]
• CodigoCidadePrestador=String[50]
• UfPrestador=String[50]
• CepPrestador=String[50]
• Competencia=String[10]
• DescricaoTributacao=String[100]
• AtividadeRetencao=String[100] 

Impressão da NFSe

• RazaoSocialPrestador=String[50]
• NomeFantasiaPrestador=String[50]
• EnderecoPrestador=String[50]
• NumeroEnderecoPrestador=String[50]
• ComplementoEnderecoPrestador=String[50]
• BairroPrestador=String[50]
• CodigoCidadePrestador=String[50]
• UfPrestador=String[50]
• CepPrestador=String[50]
• InscricaoMunicipalPrestador=String[15] 

Campos necessários em caso de tomador Estrangeiro:

• DocTomadorEstrangeiro=String[20]
• CidadeEstrangeiraTomador=String[50]
• RazaoSocialTomador=String[50]
• EnderecoTomador=String[50]
• NumeroTomador==String[50]
• BairroTomador==String[50]
• UfTomador==String[50]
• CepTomador==String[50]
• PaisTomador=String[4]

Soluções Tecnospeed

• Componente NFSe:  Release 9.1.56.X.
• Manager eDoc:  Release 4.1.X.X