NFBConsultarConvenio

A função NFBConsultarConvenio é usada para consultar os convênios de um município com o ambiente nacional.

Tipo de Retorno

Boolean

Pacote

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

Sintaxe

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

Onde:

• &{vParams} é uma variável do tipo tNFBConsultarConvenioParam. Deve ser passada por referência. Contém os parâmetros para execução da função e retornos, conforme abaixo:
  • iTpAmb: indica o ambiente que será consultado, sedo 1-produção ou 2-produção-retrita (antigo ambiente de homologação);
  • Certificado: é 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 para o usuário corrente;
  • iCodMun: é o código do município que deseja consultar;
  • sProxy: é usado para informar o endereço do servidor proxy, se necessário. Por exemplo ’https://proxyserver:port’. Verificar 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 ’https://192.168.15.1:443’;
  • sUsuarioProxy: é usado para informar o usuário para autenticação no proxy, se necessário;
  • sSenhaProxy: é usado informar a senha de autenticação no proxy, se necessário;
  • bExibeErro: indica se as mensagens de erro devem ser mostradas (TRUE) ou não (FALSE);
  • iRetAderenteAmbienteNacional : indica se o município consultador está aderente ao ambiente nacional, ou seja, está integrado com o ambiente nacional, sendo: 1 aderente, 0 não aderente ou -1 não possui a informação;
  • iRetAderenteEmissorNacional: indica se o município emite a NFS-e via ambiente nacional (NFBLibrary) ou via provedor prórpio (NFSeLibrary), sendo: 1 emite via ambiente nacional, 0 não emite via ambiente nacional ou -1 não possui a informação;
  • bRetPermiteAproveitametoDeCreditos: indica se o município permite aproveitamento de créditos;
  • sRetMsgResultado: retorna o texto contendo a mensagem de retorno de acordo com iCdRetorno;
  • iCdRetorno: retorna o código numérico da operação realizada, podendo ser o código de retorno da DLL ou o código de retorno da Sefin. O código 200 indica que a consulta foi realizada com sucesso.
• {bRet} é uma variável do tipo boolean que recebe o retorno da função, sendo que TRUE indica Web Service foi consumido com sucesso e FALSE indica que ocorreu algum erro.

Exemplo

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

Observação

Esta função deve ser utilizada preferencialmente no ambiente de produção, pois foi constatado que muitos municípios não mantém os ambientes de produção e homologação atualizados.