NFSeConsultaLoteRPS_V2

A função NFSeConsultaLoteRPS_V2 é usada para consultar o resultado do processamento de envio do lote de RPS realizado pela função NFSeEnviaLoteRPS_V2 enviado ao provedor do município, com detalhes dos erros ocorridos.

Tipo de Retorno

Boolean

Pacote

A função NFSeConsultaLoteRPS_V2 está definida dentro do pacote NFSeConsultaLoteRPS_V2.pkg.

Sintaxe

Move (NFSeConsultaLoteRPS_V2(&{vParams}) to {bRet}

Onde:

  • &{vParams} é uma variável do tipo tNFSeConsultaLoteRPS_V2_Param e é passada por referência contendo os parâmetros para execução da função e possui também algumas propriedades de retorno, conforme abaixo:
    • iCdMunicipio: é o código IBGE do município prestador do serviço que está emitindo a NFS-e;
    • sCertificado: é a string que representa o certificado digital que será usado na transmissão dos dados. Se não for informado, uma tela será exibida para o usuário escolher um dos certificados instalados. Você pode obter esta string e armazená-la em um campo de sua base de dados com a função NFSePegaNomeCertificado. Veja mais detalhes sobre como informar este parâmetro clicando aqui;
    • iTpAmbiente: é o código que indica o ambiente para onde o lote será enviado: 1 - Produção e 2 - Homologação. ATENÇÃO: verifique se existe o ambiente de homologação, pois algumas cidades/provedores não possuem, assim todos os RPS’s são enviados para o ambiente de produção sendo necessário o seu cancelamento;
    • sVersao: é a versão do XML, caso não seja informado será utilizado a versão padrão "2.03";
    • sXmlResultadoWs: é o XML de retorno do WS. Normalmente será útil somente para propósitos de depuração e homologação de novas prefeituras. Por exemplo, se o XML de retorno não estiver no padrão correto a função pode não devolver o código de retorno no parâmetro icResultado e/ou em iSituacao e neste caso o desenvolvedor poderá ler o retorno diretamente do XML devolvido;
    • icResultado: é uma variável do tipo Integer que após a execução da função receberá o código do resultado da execução. Um código igual a 5000 indica que a comunicação com o Web Service foi bem sucedida e qualquer outro código de retorno indica um erro. Para saber o retorno da consulta faz-se necessário analisar os demais retornos;
    • sMsgResultado: é uma variável do tipo String que, após a execução da função, receberá a mensagem literal do resultado da chamada do Web Service;
    • sCNPJPrestador: é número do CNPJ do prestador;
    • sIMPrestador: é número da inscrição municipal do prestador, que deverá ser informada sem espaços e caracteres separadores;
    • sProtocolo: é número do protocolo de recebimento obtido como retorno da função NFSeEnviaLoteRPS_V2;
    • sListaMensagemRetorno: é uma variável do tipo String que, após a execução da função, receberá as mensagens de erro ou advertências do WS;
    • sNrNFSe: é uma variável do tipo String que após a execução da função receberá o número da NFS-e, no caso do lote ser processado com sucesso;
    • sCdVerificacao: é uma variável do tipo String que após a execução da função receberá o código de verificação da NFS-e, no caso do lote ser processado com sucesso;
    • sProxy: é usado para informar o endereço do servidor proxy, se necesário. Por exemplo ’http://proxyserver:port’. Verificar com o cliente qual é o endereço do servidor proxy e a porta https, pois a porta padrão do https é 443, e sendo assim teríamos algo como ’http://192.168.15.1:443’;
    • sUsuario: é usado para informar o usuário para autenticação no proxy, se necessário;
    • sSenha: é usado informar a senha de autenticação no proxy, se necessário;
    • sLicenca: é usado para informar a chave da licença de uso. O envio pode ser utilizado sem qualquer restrição no ambiente de homologação. O uso em ambiente de produção requer o licenciamento da DLL. Entre em contato para mais informações;
    • bExibeErro: é usado para indicar se a função deve exibir ou não os erros que ocorrerem na execução; 
  • {bRet} é uma variável do tipo Boolean onde True indica que a comunicação com o Web Service foi feita com sucesso. Para saber o resultado do processamento é necessário analisar os demais valores devolvidos nos parâmetros passados por referência.

Exemplo

Um exemplo de uso da função pode ser encontrado dentro da Workspace de Exemplo na view RPS_V203.vw.

Observações

  • A função está disponível a partir da versão 2024/01 da NFSeLibrary.
  • Função compatível com a prefeitura de Bauru/SP.
  • Para teste em ambiente de homologação na prefeitura de Bauru/SP, é obrigatório informar o CPF 55555555555 e a inscrição municipal (IM) 614960 nos dados do prestador.

 

Não encontrou o que precisava, entre em contato conosco.