NFSeEnviarXMLRPSSP

A função NFSeEnviarXMLRPSSP é usada para enviar um XML contendo o RPS, de forma síncrona, ao Web Service da prefeitura que irá gerar a NFS-e.

Tipo de Retorno

Boolean

Pacote

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

Sintaxe

Move (NFSeEnviarXmlRPSSP(&vParam)) to {bRet}

Onde:

  • &{vParams} é uma variável do tipo NFSeEnviarXmlRPSSP_vParam. Deve ser passada por referência. Contém os parâmetros para execução da função e também retornos, conforme abaixo:
    • {iTpAmbiente} indica o ambiente para onde o XML será enviado, sendo 1-Produção e 2-Homologação;
    • {sCNPJPrestador} é o número do CNPJ do prestador, que deverá ser informado sem espaços e caracteres separadores;
    • {sCdMunicipioPrestador} é o código do IBGE do município do prestador de serviço que está emitindo a NFS-e;
    • {sCertificado} é a string que representa o certificado digital que será usado no envio do XML. Se não for informado, uma tela será exibida para o usuário escolher um dos certificados instalados para o usuário corrente. Veja mais detalhes sobre como informar este parâmetro clicando aqui;
    • {sArquivoEntrada} é o caminho completo do arquivo XML do RPS que será enviado. O arquivo XML do RPS pode ser gerado com a função NFSeGerarXMLRPSSP;
    • {sUsuario} é o usuário que será autenticado no servidor proxy para realizar a consulta;
    • {sSenha} é a senha do usuário que será autenticado no servidor proxy para realizar a consulta;
    • {sProxy} é o endereço do servidor proxy que deve ser usado para realizar a consulta;
    • {sChLicenca} é usado para informar a chave da licença de uso quando a função é utilizada em ambiente de produção;
    • {bExibeErro} indica se as mensagens de erro devem ser mostradas (TRUE) ou não (FALSE);
    • {sRetNumLote} retorna o número do lote gerado;
    • {sRetMensagem} retorna o texto contendo a mensagem de retorno de acordo com iRetCdRetorno;
    • {iRetCdRetorno} retorna o código numérico que representa o resultado do envio do RPS;
    • {vtChaveNFeRPSs} é uma variável do tipo NFSeEnviarXmlRPSSP_ChaveNFeRPS que retorna as informações conforme abaixo:
      • {sChaveRPSNFeInscricaoPrestador} retorna a inscrição municipal de prestador do serviço;
      • {sSerieRPS} retorna a série do RPS;
      • {sNumeroRPS} retorna o número do RPS;
      • {sNumeroNFe} retorna o número da NFS-e;
      • {sCodigoVerificacaoNFe} retorna o código de verificação da NFS-e;
      • {sChaveNotaNacional} retorna a chave da nota nacional.
    • {vtErros} é um array do tipo NFSeEnviarXmlRPSSP_ErroAlerta que retorna mensagens de erro conforme abaixo:
      • {iCodigoErroAlerta} retorna o código do erro;
      • {sDescricaoErroAlerta} retorna a descrição do erro;
      • {sChaveRPSNFeInscricaoPrestador} retorna a inscrição municipal do prestador de serviço;
      • {sSerieRPS} retorna a série do RPS;
      • {sNumeroRPS} retorna o número do RPS;
      • {sNumeroNFe} retorna o número da NFS-e;
      • {sCodigoVerificacaoNFe} retorna o código de verificação da NFS-e;
      • {sChaveNotaNacional} retorna a chave da nota nacional.
    • {vtAlertas} é um array do tipo NFSeEnviarXmlRPSSP_ErroAlerta que retorna mensagens de alerta conforme abaixo:
      • {iCodigoErroAlerta} retorna o código do erro;
      • {sDescricaoErroAlerta} retorna a descrição do erro;
      • {sChaveRPSNFeInscricaoPrestador} retorna a inscrição municipal do prestador de serviço
      • {sSerieRPS} retorna a série do RPS;
      • {sNumeroRPS} retorna o número do RPS;
      • {sNumeroNFe} retorna o número da NFS-e;
      • {sCodigoVerificacaoNFe} retorna o código de verificação da NFS-e;
      • {sChaveNotaNacional} retorna a chave da nota nacional.
  • {bRet} é o retorno da execução da função, sendo que True indica que o envio foi bem-sucedido e neste caso é necessário analisar a variável {vtChaveNFeRPSs}, caso retorne false é necessário analisar as variáveis {vtErros} e {vtAlertas}.

Observações

  • A função está disponível a partir da versão 2025/01 da NFSeLibrary;
  • Função compatível com o município de São Paulo;
  • Para os prestadores enquadrados no Simples Nacional, as emissões com fato gerador até 31/12/2028, deverão utilizar as antigas funções (leiaute versão 1).

 

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