NFSeConsultarServicoTomado

A função NFSeConsultarServicoTomado é utilizada para buscar o XML da NFS-e emitidas para o CNPJ/CPF consultado.

Tipo de Retorno

Boolean

Pacote

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

Sintaxe

Move (NFSeConsultarServicoTomado(&{vParams})) to {bOk}

Onde:

  • &{vParams} é uma variável do tipo tNFSeConsultarServicoTomadoParam 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:
    • sCdMunicipio: código do município, segundo tabela do IBGE, no qual o tomador deseja consultar as notas fiscais;
    • sNomeCertificado: é 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. Veja mais detalhes sobre como informar este parâmetro clicando aqui;
    • iTipoAmbiente: indica o ambiente onde a consulta será feita, sendo 1-Produção e 2-Homologação;
    • sVersao: versão do XML da prefeitura que será consultada;
    • sMsgDados: retorna o XML usado para realizar a consulta no WS;
    • icStat: código numérico que representa o retorno da consulta realizada, podendo ser o código de retorno da DLL ou o código de retorno da consulta feita na SEFAZ;
    • sMsgResultado: texto contendo a mensagem de retorno de acordo com icStat;
    • sCNPJCPFConsulente: CNPJ ou CPF do consulente;
    • sIMConsulente: inscrição municipal do consulente;
    • sCNPJCPFPrestador: CNPJ ou CPF do prestador;
    • sIMPrestador: inscrição municipal do prestador;
    • sNumeroNfse: número da primeira que se deseja consultar;
    • sDataInicialEmissao: data inicial do período de emissão (dd/MM/aaaa);
    • sDataFinalEmissao: data final do período de emissão (dd/MM/aaaa);
    • sDataInicialCompetencia: data inicial do período de competencia (dd/MM/aaaa);
    • sDataFinalCompetencia: data final do período de competencia (dd/MM/aaaa);
    • sCNPJCPFTomador: CNPJ ou CPF do tomador;
    • sIMTomador: inscrição municipal do tomador;
    • sCNPJCPFIntermediario: CNPJ ou CPF do  intermediário;
    • sIMIntermediario: inscrição municipal do intermediário;
    • sPagina: página que deseja consultadar;
    • sListaNFSe: retorna as NFS-e’s separada por "|" papeline;
    • sProximaPagina: retorno o número da próxima página da consulta;
    • sListaMensagemRetorno: retorna as mensagens de erro do WS;
    • sSoapMsgTx: retorna a mensagem SOAP transmitida ao WS;
    • sSoapMsgRx: retorna a mensagem SOAP recebida do WS;
    • sProxy: endereço do servidor proxy que deve ser usado para realizar a consulta;
    • sUsuario: usuário que será autenticado no servidor proxy para realizar a consulta;
    • sSenha: senha do usuário que será autenticado no servidor proxy para realizar a consulta;
    • sLicenca: chave da DLL que será verificada para permitir a consulta em ambiente de produção;
    • sXmlRet: é o XML retornado pelo WS;
    • vXmlsRetorno: matriz do tipo tNFSeConsultarServicoTomadoXmlRetorno contendo cada NF-e retornada na consulta,
    • bExibeErro: indica se as mensagens de erro do processo devem ser mostradas (TRUE) ou não (FALSE);
  • {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 ConsultarServicoTomado.vw.

Observações

  • A função está disponível a partir da versão 2022/01 da NFSeLibrary.
  • Para o município de São Paulo/SP, deve ser utilizada a função NFSeConsultarNFeRecebidasSP.
  • Esta função é compatível com os municípios que implementam o padrão ABRASF a partir da versão 2.0.
  • Para mais informações referente aos parâmetros, é necessário consultar a documentação do serviço ConsultaNfseServTomado na prefeitura onde será realizado a consulta.