NFSeGeraLoteRPS

A função NFSeGeraLoteRPS recebe uma estrutura com os dados do RPS e gera e assina o arquivo XML para envio.

Tipo de Retorno

Boolean

Pacote

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

Sintaxe

Move (NFSeGeraLoteRPS({vtRPS}, {sProvedor}, {sArquivoXML}, {sNrLote}, ;
      {sCertificado}, {icMunicipio}, &{sResultado}, &{sErros}, ;
      {sLicenca}, {bExibeErro})) to {bRet}

Onde:

  • {vtRPS} é uma variável do tipo tNFSeRPS que deve conter todos os dados necessários para gerar o lote RPS;
  • {sProvedor} é o nome do provedor do serviço usado pela prefeitura. Exemplo: GINFES, ISS.NET, etc. Esta informação é importante, pois existem particularidades para determinados provedores que serão tratados automaticamente pela função. No caso de prefeituras que usam provedor próprio informe "PROPRIO";
  • {sArquivoXML} caminho completo de onde deve ser gerado o arquivo XML do lote do RPS informado;
  • {sNrLote} número do lote RPS. Como a função NFSeGeraLoteRPS só suporta um RPS por lote, você pode usar o próprio número do RPS para o lote. Note entretanto, que em caso de lote rejeitado, algumas prefeituras não permitem reutilizar o número do lote para um novo envio;
  • {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;
  • {icMunicipio} é o código do IGBE do município para o qual será gerado o lote, ou seja, o código do município da empresa que está emitindo a NFS-e;
  • &{sResultado} é uma variável do tipo String que precisa ser passada por referência e que receberá o resultado literal ou o erro da execução;
  • &{sErros} é uma variável do tipo String que precisa ser passada por referência e que receberá a descrição dos erros que ocorrerem na geração;
  • {sLicenca} é usado para informar a chave da licença de uso ou registro. A geração pode ser utilizada sem qualquer restrição no ambiente de homologação. O uso em ambiente de produção requer o licenciamento ou registro 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} é o retorno da execução da função, sendo que True indica que a geração do lote foi bem sucedida e False se houve um erro, e neste caso analise os retornos de sResultado e sErros.

Exemplo

Um exemplo de uso da função pode ser encontrado dentro da Workspace de Exemplo no pacote NFSeGeraRPSExemplo.pkg função NFSeGeraRPSExemploByNumero. Abaixo em destaque a função citada e a chamada da função da Library na linha 190.

NFSeGeraLoteRPS - Exemplo

Layout do RPS

Para ver o layout do RPS, clique aqui.

Observações

  • A estrutura tNFSeRPS está definida no pacote NFSeStructs.pkg;
  • A estrutura tNFSeRPS possui todos os campos necessários para todas as prefeituras homologadas. Existem campos que devem ser preenchidos com formatos diferentes ou mesmo não precisam ser preenchidos para determiandas prefeituras. Em caso de dúvida no preenchimento dos campos, consulte a documentação da prefeitura.

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