Manual de integração com o webservice

 

Download do manual

 

 

Portais Disponíveis

 

• Produção

 

 

Métodos Disponíveis

 

• Envio.
  • Assíncrono.
• Consulta de lote.
• Consultar NFSe.
• Cancelar a Nota

 

 

Observações

• Não existem servidores de Homologação para esse município. Para testes a prefeitura disponibiliza 
  os seguintes dados: Usuário: XXXXXXXXXXX e  Senha: XXXX (Essa senha após aplicar hash fica XXXXXXXXXXXXXXXXXXXXXX=).  Para testar a comunicação, utilize as seguintes configurações: 
  • Componente NFSe: Ambiente=1, CNPJ=XXXXXXXXXXX, InscricaoMunicipal=XXXXXX, Tx2: InscricaoMunicipalEmissor=XXXXXX; CodAtividade=702, TecnoNfse: InscricaoMunicipalPrestador=XXXXXX; CodigoTributacaoMunicipio=6,  Parâmetros Extras para envio: (CpfUsuario=XXXXXXXXXXX;Senha=XXXX)
• Na Consulta de um protocolo com mais de um RPS, o web-service, retorna a NFSe equivalente a apenas o ultimo RPS emitido, portanto não é aconselhada a emissão de notas em lotes.
• Consulta de NFSe por RPS não é uma operação suportada para cidades do padrão SIL.
• O erro "Erro no script NFENotaFiscalValidar: 
 Null Pointer in Method Invocation" é conhecido pelo valor incorreto da Inscrição Municipal, o preenchimento esperado é o CCM do CNPJ na cidade. O CCM é apresentado no PDF de uma NFSe emitida pelo portal da prefeitura 

 

Componente

• Para as operações de Envio (ProxyNFSe.Enviar) e Consulta de Lote (ProxyNFSe.ConsultarLote) será necessário informar no parâmetro aParams o Cpf do Usuário e a senha do sistema web de NFSe do município. Ex: ProxyNFSe.Enviar(_Lote, 'CpfUsuario=XXXXXXXXXXX;Senha=XXXX'); Opcionalmente pode-se utilizar a Hash da senha, calculada com SHA1 e Base64. Ex: ProxyNFSe.Enviar(_Lote, 'CpfUsuario=XXXXXXXXXXX;HashSenha=XXXXXXXXXXXXXXXXXXXXX=').
• Com o arquivo de integração padrão único é possível a inserção de vários serviços na mesma nota, possibilitando ao cliente uma forma eficaz de diminuir o esforço na comunicação com o WebService, sendo assim não é mais preciso para cada serviço uma nova requisição.

 

Arquivo de Integração

• No arquivo de integração deve-se inserir os seguintes campos ficando da seguinte forma:

   

  INCLUIRSERVICO
    QuantidadeServicos=1
    DiscriminacaoServico=Servico de teste
    ValorUnitarioServico=1.00
SALVARSERVICO

   

  Onde:

  INCLUIRSERVICO – Identificador de inclusão que será a diretriz do novo serviço que será inserido.

  QuantidadeServicos – Neste campo será informado a quantidade de serviços que serão prestados.

  DiscriminacaoServico – Neste campo é atribuído uma breve descrição do serviço.

  ValorUnitarioServico – Este campo refere-se ao valor unitário do serviço.

  SALVARSERVICO – Identificador de inclusão que caracteriza o fim do serviço que foi prestado.

 

• Os campos referentes as faturas da nota devem ser informados da seguinte maneira:

   

  INCLUIRFORMAPAGAMENTO
    DataVencimentoParcela=2020-10-30
    ValorParcela=1.00
SALVARFORMAPAGAMENTO


   

  Onde:

  INCLUIRFORMAPAGAMENTO – Identificador de inclusão que será a diretriz da nova fatura que será inserida.

  DataVencimentoParcela – Neste campo é atribuído a data de vencimento da fatura em questão.

  ValorParcela – Este campo refere-se ao valor da fatura.

  SALVARFORMAPAGAMENTO – Identificador de inclusão que caracteriza o fim da fatura que foi inserida.

 

Notas Rejeitadas por Duplicidade (Edoc/SaaS)

• Caso ocorra divergências entre a situação da nota na prefeitura (Autorizada) e em nosso produto (Rejeitada), o procedimento a ser realizado é informar a Chave de Validação na nota, acrescentando o parâmetro nprotocolo, Exemplo: nprotocolo=AAAA-BBBB
  
  • Para encontrar a ChaveValidacao da nota, é necessário fazer o download do XML no portal da prefeitura e visualizar o conteúdo da tag "<ChaveValidacao>" ;

 

• Procedimentos: 
  • Para comunicações via API:
    • o parâmetro nprotocolo=chavevalidacao deverá ser adicionado no Body da requisição;
  • Para comunicações via integração por pasta:
    • o parâmetro nprotocolo=chavevalidacao 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 a Chave de Validação daquela nota.
      
      • Obs: O procedimento funcionará apenas quando:
        
        • A nota estiver com a situação REJEITADA;
        • Apenas uma nota for selecionada.

 

Geração do XML - Campos Importantes

 

• Não utiliza o campo CodigoItemListaServico
• Não Utiliza o CodigoCNAE.
• Utiliza o campo Código Tributação do Município. que é referente aos campos Cae e CodigoAtividade do XML da nota da prefeitura

 

 

Campos customizados para a impressão

 

Impressão do RPS

• RazaoSocialPrestador=String[80]
• CodigoMunicipioPrestador=String[10]
• EnderecoPrestador=String[80]
• UfPrestador=String[2]
• NumeroEnderecoPrestador=String[7]
• ComplementoEnderecoPrestador=String[20]
• BairroPrestador=String[40]
• CepPrestador=String[11]
• TelefonePrestador=String[20]
• EmailPrestador=String[80]
• CnpjCpfPrestador=String[20]
• InscricaoEstadualPrestador=String[20]
• ValorIss=String[20]
• ValorTotalNota=String[20]
• ValorTotalLiquido=String[20]
• ISSQNSemRetencao=String[20]
• ValorTotalDeducoes=String[20]
• EndCobranca=String[80]
• ChaveValidacaoRPS=String[20]
• ValorExtenso=String[255]

 

Impressão da NFSe

• EmailPrestador=String[80]
• InscricaoEstadualPrestador=String[20]
• TelefonePrestador=String[20]
• EndCobranca=String[255]
• ValorExtenso=String[255]
• ComplementoEnderecoPrestador=String[20]
• OptanteSimples=String[1]

 

 

Soluções Tecnospeed

 

• Componente NFSe:      Release 7.7.39.X.
• Manager eDoc:      Release 2.0.73.X.