NFSeEnviaLoteRPSSincrono_V2

A função NFSeEnviaLoteRPSSincrono_V2 consome o serviço enviando o XML de um Lote RPS de forma síncrona e gera a NFS-e para cada RPS informado no lote. Nem toda prefeitura/provedor disponibiliza essa funcionalidade, então é importante verificar a documentação antes do seu uso.

Tipo de Retorno

Boolean

Pacote

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

Sintaxe

Move (NFSeEnviaLoteRPSSincrono_V2(&{vtParametros})) to {bRet}

Onde:

  • &{vtParametros} é uma variável do tipo tNFSeEnviaLoteRPSSincrono_V2_Parametros, que é uma estrutura com diversos campos que serão usados como parâmetros e também como retorno da função, então o parâmetro precisa ser passado por referência. As propriedades da estrutura são:
    • bExibeErro: do tipo Boolean, é usado para indicar se a função deve exibir ou não os erros que ocorrerem na execução;
    • iCdMunicipio: do tipo Integer, é o código do município para o qual será enviado o RPS;
    • sArquivoXML: do tipo String, é o caminho do arquivo XML com o lote RPS que será enviado;
    • sArquivoXMLResposta: do tipo String, é um parâmetro opcional contendo o caminho onde será salvo o XML que foi recebido como resposta do processamento do Web Service;
    • sCertificado: do tipo String, 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. No caso do provedor SIMPLISS, em vez de passar o nome do certificado deve-se passar uma string no formato "CNPJ|00000000000000|SENHA" (LITERAL CNPJ, PIPE, número do CNPJ, PIPE e senha);
    • iTpAmbiente: do tipo Integer, é 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: do tipo String, usado para informar a versão do XML. Na maioria dos casos será "2.0";
    • sLicenca: do tipo String, é usado para informar a chave da licença de uso ou registro. O cancelamento pode ser utilizado 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;
    • sProxy: do tipo String, é 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’;
    • sSenha: do tipo String, é usado informar a senha de autenticação no proxy, se necessário;
    • sUsuario: do tipo String, é usado para informar o usuário para autenticação no proxy, se necessário;
    • sMsgDados: do tipo String, deve ser passado em branco, pois será carregado com o XML informado em {sArquivoXML};
    • iResultado: do tipo Integer, retorna o código de erro ou sucesso da operação de consumo do Web Service sendo que 5000 indica que o Web Service foi consumido com sucesso;
    • sMsgResultado: do tipo String, retorna o literal da chamada do WS;
    • sCNPJPrestador: do tipo String, deve conter o CNPJ do prestador do serviço;
    • sNumLote: do tipo String, retorna o número do lote recebido pela prefeitura, mas não é obrigatório;
    • sDtRecebimento: do tipo String, retorna a data de recebimento do lote na prefeitura, mas não é obrigatório;
    • sProtocolo: do tipo String, retorna o protocolo de recebimento atribuído pela prefeitura, mas não é obrigatório;
    • sListaNFSe: do tipo String, retorna uma lista formatada com as notas convertidas;
    • sMsgAlertaRetorno: do tipo String, retorna as mensagens de alerta do WS;
    • sListaMsgRetorno: do tipo String, retorna as mensagens de erro do WS;
    • sListaMSgRetornoLote: do tipo String, retorna as mensagens de erro ocorridas no Lote do RPS;
    • sRetSoapMsgTx: do tipo String, retorna a mensagem SOAP recebida do WS;
    • sRetSoapMsgRx: do tipo String, retorna a mensagem SOAP transmitida ao WS;
    • sRetorno: do tipo String, é o XML de resposta do WS.
  • {bRet} é o retorno da chamada da função, sendo que True indica que a comunicação com o Web Service foi feita com sucesso. Para saber o resultado do processamento é necessário analisar a propriedade iResultado e sMsgResultado de vtParametros.

Exemplo

Um exemplo de uso da função pode ser encontrado dentro da Workspace de Exemplo no Data Dictionary cRPS_V2DataDictionary.dd no procedimento EnviaLoteRPSSincrono. Abaixo em destaque a função citada e a chamada da função da Library na linha 81.

NFSeEnviaLoteRPSSincrono_V2

Observações

  • Esta função está disponível a partir da versão 2014/01.

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