Documentação técnica - Padrão ATIV

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

Observações

• Não possui envio em Lote;
• É necessário preencher os parâmetros "Login" e "Senha" nas configurações de Autenticação da Prefeitura. Caso não possua as credenciais, basta acessar o portal da prefeitura e realizar o cadastro. Caso o login do portal não funcione, tentar o Cnpj sem máscara;
  Dúvidas sobre o preenchimento, clique aqui.
• Para realizar uma consulta de NFSe por RPS, alem das credenciais, é necessário informar o Número do Lote do RPS em questão como parâmetro extra:
  • Login=12341234123412;Senha=123senha;Lote=1

Cancelamento de uma NSFe 

• Para realizar o cancelamento de uma NFSe, é necessário informar a Chave de Cancelamento do padrão, que será constituída do Número do RPS e o Número do Lote da NFSe. Por exemplo:
  • NumeroRPS_NumeroLote: 1_1 

Impressão

• Para realizar a impressão da NFSe pelo componente, deverá ser informado o XML de envio do RPS, pois no retorno do Envio (autorizado) e da consulta de NFSe por RPS, não retornam todos os dados necessários para a impressão ser compatível com a da prefeitura.
• Além do XML de envio do RPS, deverá ser informado os campos Customizados informados na seção "Campos customizados para a impressão". 
  • ATENÇÃO ao informar o XML do RPS referente a NFSe autorizada, para que não haja diferenças;
• No momento da homologação do padrão, não havia como informar quebra de linha para a impressão.

Geração do XML - Campos Importantes

• O padrão utiliza número de RPS sequencial e não faz uso da série do RPS e do Tipo RPS. Os campos poderão ser informados, mas o webservice ignora os mesmos.
• Padrão não utiliza o campo ItemListaServico. Caso seja informando, o mesmo será desconsiderado na geração. Isso também se aplica ao campo CodigoTributacaoMunicipio.
• O campo CodigoCnae é obrigatório e segue a lista nacional.
• O campo DescricaoRPS será referente a tag OBSERVACAO do XML.
  
  

Campos customizados para a impressão

Impressão do RPS

• CpfCnpjPrestador=String[20]
• NomeFantasiaPrestador=String[80]
• RazaoSocialPrestador=String[80]
• InscricaoMunicipalPrestador=String[20]
• EnderecoPrestador=String[80]
• CodigoCidadePrestador=String[10]
• NumeroPrestador=String[7]
• ComplementoPrestador=String[20]
• BairroPrestador=String[40]
• CepPrestador=String[8]
• OptanteSimplesNacional=String[30]
  • Preencher com '1' - Sim ou '2' - Não.
• ValorServicos=String[30]
  • Preencher com o valor total (bruto) da NFSe.
• ValorLiquidoNfse=String[30]
  • Preencher com o valor total (bruto) e subtrair os impostos.
• OutrasInformacoes=String[255]

Impressão da NFSe

• CpfCnpjPrestador=String[20]
• NomeFantasiaPrestador=String[80]
• RazaoSocialPrestador=String[80]
• InscricaoMunicipalPrestador=String[20]
• EnderecoPrestador=String[80]
• CodigoCidadePrestador=String[10]
• NumeroPrestador=String[7]
• ComplementoPrestador=String[20]
• BairroPrestador=String[40]
• CepPrestador=String[8]
• OptanteSimplesNacional=String[30]
  • Preencher com '1' - Sim ou '2' - Não.
• ValorServicos=String[30]
  • Preencher com o valor total (bruto) da NFSe.
• ValorLiquidoNfse=String[30]
  • Preencher com o valor total (bruto) e subtrair os impostos.
• OutrasInformacoes=String[255]