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 por RPS.
• Cancelamento de NFSe.

Observações

• O padrão utiliza lotes de pré-notas para a geração das NFS-e definitivas;
• As pré-notas, podem ser consideradas como o RPS de outros padrões;
• Cada pré-nota possui um código de validação(obrigatório) para a geração definitiva de uma NFS-e;
• O código de validação da pré-nota, só será consumido quando a nota for emitida em ambiente de Produção;
• No ambiente de homologação, o método de consulta não traz os dados da nota. Apenas retorna se obteve sucesso ou erro na consulta;
• Ao autorizar uma NFS-e, é retornado um código de validação referente a NFS-e.
• No processo de homologação, ao enviar uma nota com acentos na Discriminação do serviço, o WebService obteve comportamentos de rejeição da nota. Por esse motivo, ao realizar o envio, automaticamente serão removidos acentos existentes no XML;
• O padrão não possui envio em lote, só é possível enviar uma pré-nota(RPS) 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_11_2018
  • Sendo os valores divididos por '_' equivalentes respectivamente aos seguintes valores:
    • NumeroNota_CodigoItemLista_CodigoValidacao_Mes_Ano
• O padrão utilizará os parâmetros extras abaixo, sendo eles: 
  
  • Senha:
    • Senha do WebService, pode ser obtido através do acesso ao portal da prefeitura, no Item 19 do Menu de Acesso do Sistema, procure por: "Senha de Acesso p/ WebService";
      • Deve ser passado como parâmetro Extra, como Senha, para todos os Métodos disponíveis (Exemplos abaixo);
  • Bloco da Pre-Nota:
    • É obtido através do Bloco de pré-notas gerado no seu usuário do portal da prefeitura, no item 19 do Menu de Acesso do Sistema;
      • Na Consulta de NFSe por RPS e no TX2 TecnoNFSe, será preenchido como SerieRps;
      • No Cancelamento será passado como parâmetro Extra, como BlocoPreNota(Exemplo abaixo);
  • Sequência da Pre-Nota:
    •  A partir da geração de um bloco de pré-notas(item acima), serão disponibilizados números e códigos para a emissão de notas. A sequência da pré-nota, será o número de cada pré-nota do bloco;
      • Na Consulta de NFSe por RPS e no TX2 TecnoNFSe, será preenchido como NumeroRps;
      • No Cancelamento será passado como parâmetro Extra, como SequenciaPreNota(Exemplo abaixo);
  • Código da Pré-Nota:
    •  Cada pré-nota gerada no bloco(item 2), possuirá um código de validação referente a sua sequência. Será obtido na Lista das Pré-NFS-e do Bloco, a partir do Item 19 do Menu de Acesso do Sistema;
      • No TX2 TecnoNFSe, será preenchido como IdRps;
      • Na Consulta de NFSe por RPS e no Cancelamento será passado como parâmetro Extra, como CodigoPreNota(Exemplos abaixo);
  • Inscrição Sequencial:
    •  Obtido no usuário do portal da prefeitura, ou entre em contato com a prefeitura.
      • Deve ser passado como parâmetro Extra, como InscricaoSequencial, 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;BlocoPreNota=1;SequenciaPreNota=1;CodigoPreNota=XXXXXXXXXX;InscricaoSequencial=111
  • Consulta de NFSe por RPS
    • Para realizar a Consulta de uma NFS-e por RPS é necessário informar os seguintes parâmetros extras:
      •  Senha=11111111111111_11111;InscricaoSequencial=111;CodigoPreNota=YYYYYYYYYY;EnvioEmail=S;

• 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:
  • IdRps=deverá ser preenchido pelo Código da pré-nota;
  • SerieRps=deverá ser preenchido pelo Bloco da pré-nota;
  • 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;

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] 

Soluções Tecnospeed

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