NFSeEnviarXMLDPSNFB

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

Tipo de Retorno

Boolean

Pacote

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

Sintaxe

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

Onde:

  • &{vParams} é uma variável do tipo tNFSeEnviaXMLDPSNFBParam. Deve ser passada por referência. Contém os parâmetros para execução da função e também retornos, conforme abaixo:
    • {iCdMunicipio} é 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;
    • {iTpAmbiente} indica o ambiente para onde o XML será enviado, sendo 1-Produção e 2-Homologação;
    • {sVersaoXml} é a versão do XML que será enviado. Caso seja omitido, será utilizado "1.01" como padrão;
    • {sPathXMLEnvio} caminho completo, finalizado com ".xml", onde encontra-se o arquivo XML do DPS que será enviado;
    • {sDirXMLGerado} diretório onde será salva a NFS-e quando gerada. O nome do XML será formado pela junção da chave de acesso e "-NFSe.xml";
    • {sLicenca} é usado para informar a chave da licença de uso quando a função é utilizada em ambiente de produção;
    • {sProxy} é o endereço do servidor proxy que deve ser usado para realizar a consulta;
    • {sSenha} é a senha do usuário que será autenticado no servidor proxy para realizar a consulta;
    • {sUsuario} é o usuário que será autenticado no servidor proxy para realizar a consulta;
    • {sRetChNFSe} retorna a chave de acesso da NFS-e quando a NFS-e é gerada com sucesso;
    • {sRetChDPS} retorna a chave de acesso do DPS;
    • {sRetCodAutenticidade} retorna o código de autenticação da NFS-e gerada;
    • {sRetDhProcessamento} retorna a data e hora do processamento no formato AAAA-MM-DDTHH:MM:SS-TZD;
    • {iCdResultado} retorna o código numérico que representa o resultado do envio do DPS. Sendo que 0 indica que a NFS-e foi gerada com sucesso;
    • {sRetResultado} retorna texto contendo a mensagem de retorno;
    • {sRetXMLWS} retorna o XML gerado pelo Web Service;
    • {sRetXMLNFSe} retorna o XML da NFS-e;
    • {sRetMsgDados} retorna o JSon envioado para o Web Service;
    • {bRetSalvou} indica se o XML retornado foi salvo com sucesso;
    • {bExibeErro} indica se as mensagens de erro devem ser mostradas (TRUE) ou não (FALSE);
  • {bRet} é o retorno da execução da função, sendo que True indica que a geração da NFS-e foi bem-sucedida e False se houve um erro e, neste caso, analise os retornos do sRetResultado.

Observações

  • A função está disponível a partir da versão 2026/01 da NFSeLibrary.

 

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