Manual de integração com o webservice

• Download do manual

Portais Disponíveis 

• Produção 

Métodos Disponíveis

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

Observações

• Possui envio em lote.
• É necessário preencher o parâmetro "Senha" nas configurações de Autenticação da Prefeitura com a Chave de Validação adquirida no perfil do prestador no portal da prefeitura pelo caminho: Ferramentas > Importação de NF > Informações Adicionais para Integração. 
  Dúvidas sobre o prenchimento, clique aqui.
• TipoDocumento: Deverá ser informado no campo TipoCodificacao do tx2.

 Cancelamento de NSFe 

• Para realizar o cancelamento de uma NFSe, é necessário informar a Chave de Cancelamento do padrão, que será constituída pelo número da NFSe concatenada com a chave de validação:
  • Ex: NumNFSe_ChaveValidacao = 99_1234-A567B
• É possível informar o motivo do cancelamento da NFSe. Caso o mesmo não seja informado, será preenchido por: "NFSe cancelada a pedido do prestador.";

Geração do XML - Campos Importantes

• O campo CodigoItemListaServico é obrigatório e não segue a lista nacional, sendo necessário verificar os códigos disponibilizados no portal da prefeitura na seção "CÓDIGO DOS ITENS DE ATIVIDADES:". Após identificar o código da atividade, informe o mesmo no campo do TX2.
• A tag LocalPrestacao do XML, será preenchida com o valor 1(serviço na sede do prestador) para quando o CodigoCidadePrestacao for igual ao CodigoCidadePrestador. E será preenchido com o valor 4 (serviço fora do município) quando os mesmos campos tiverem valores diferentes. Para que a tag LocalPrestacao seja preenchida com outros valores, deverá ser informado o campo com @:
  • Ex: @LocalPrestacao=2;
• O endereço da prestação do serviço deverá ser preenchido quando o serviço for realizado fora da cidade, representado pelos campos CodigoCidadePrestacao diferente de CodigoCidadePrestador, e deve ser no seguinte formato:
  • EnderecoPrestacaoServico=Rua_Numero_Bairro_Cep, conforme o exemplo: Rua Teste_999_Bairro teste_99999999

Erros comuns

• A rejeição "A quantidade de Notas Fiscais do arquivo para o Tipo de Documento 3 é maior que a quantidade autorizada." tem como causa a falta de numerações liberadas para as emissões de NFS-e, a mesma pode ser consultada e solicitada no portal da prefeitura:
  

  - Acesse o portal da prefeitura > Movimentação > Documentos Fiscais > Consultar/Solicitar:

  - Solicitar: Solicita a numeração de NFS-e a ser emitida.

  - Consultar: Consulta as numerações liberadas até o momento.

  

Campos customizados para a impressão

Impressão do RPS

• NomeFantasiaPrestador=String[80]
• CpfCnpjPrestador=String[30]
• InscricaoMunicipalPrestador=String[30]
• InscricaoEstadualPrestador=String[30]
• RazaoSocialPrestador=String[80]
• EnderecoPrestador=String[80]
• UfPrestador=String[2]
• BairroPrestador=String[40]
• CepPrestador=String[8]
• EmailPrestador=String[80]
• ComplementoPrestador=String[80]
• NumeroPrestador=String[7]
• CodigoCidadePrestador=String[10]
• InscricaoEstadualTomador=String[30]
• InscricaoMunicipalTomador=String[30]
• CodigoServico=String[255]
  • Deverá ser informado o código do serviço, seguindo a lista nacional, por exepmlo:
    • CodigoServico=09.01
• AliquotaISS=String[10]
• DataEmissaoRPS=String[20]
• ValorISSRetido=String[30]
• ValorISS=String[30]
• ValorBaseCalculo=String[30]
• ValorTotalServicos=String[30]
• ValorLiquidoNFSe=String[30]

Impressão da NFSe

• NomeFantasiaPrestador=String[80]
• RazaoSocialPrestador=String[80]
• EnderecoPrestador=String[80]
• ComplementoPrestador=String[80]
• NumeroPrestador=String[7]
• CodigoCidadePrestador=String[10]
• UfPrestador=String[2]
• BairroPrestador=String[40]
• DataHoraCancelamento=String[20]
  • Será necessário para que apareça a frase da data em que a NFSe foi cancelada
• ValorISSRetido=String[30]
• DataEmissaoRPS=String[30]
• AliquotaISS=String[30]
  • O campo deverá ser informado, pois a prefeitura retorna o valor "***"