Lista com todos os métodos do componente MDFe.
Abaixo da tabela é possível verificar exemplos de utilização dos métodos.
Obs: Posicionando o cursor em cima de cada um dos parâmetros, é possível visualizar detalhes de cada um deles
| Método | Parâmetros | Descrição | Retorno |
|---|---|---|---|
| AssinarMDFe | aXML | Gera assinatura de cada MDFe dentro do arquivo XML. Usado sempre antes de enviar um manifesto. | O retorno do método é o Xml do MDFe assinado. |
| CalculaChave | aUF, aDtEmissao, aCNPJ, aModelo, aSerie, aNumMDFe, aTipoEmissao, aCodMDFe | Calcula chave do Manifesto de acordo com o manual 3.00. O componente gera essa chave automaticamente, caso você deixe vazio o campo no dataset, porém se você quiser calcular utilizando essa função, você pode sem problemas. | O retorno do método é a Chave do MDFe em questão. |
| CancelarMDFe | aChaveMDFe, aNumProtocolo, aJustificativa, aDHEvento, aSequenciaEvento, | Função que envia solicitação de Cancelamento do MDFe. | XML com o resultado da operação solicitada. |
| LoadConfig | aConfigFile | Carrega configurações do componente a partir de um arquivo .ini presente na pasta do executável. De preferência quando iniciar seu projeto, de modo que as configurações do componente já sejam feitas. | Sem retorno |
| ConfigurarSoftwareHouse | aCNPJSoftwareHouse, aKey | Para que possa utilizar nosso componente, é necessário que configure o CNPJ da software house, através do método ConfigurarSoftwareHouse. | Sem retorno, este método deve ser utilizado após a criação da instância do componente |
| ConsultarDistribuicaoDFe | aCNPJCPF, aNSU, aTipoNSU | O método disponibiliza para os atores do MDFe informações e documentos fiscais eletrônicos de seu interesse. A distribuição será realizada para emitentes, destinatários, informados no conteúdo do MDFe. | É retornado um Xml contendo os documentos (Compactados em base64) de interesse do ator. |
| ConsultarNaoEncerradas | aChave | Função que consulta as MDFe's não encerrados de acordo com o CNPJ. | Será um XML composto por uma lista de Chave e Protocolo dos MDFe's não encerrados. |
| ConsultarMDFe | aChaveMDFe | Função para consultar MDFe no servidor. Nos casos onde é necessário confirmar se um manifesto está autorizado ou cancelado. | XML de resposta da consulta. |
| ConsultarReciboMDFe | aNumRecibo | A consulta é utilizada para verificarmos a situação da nosso manifesto na Sefaz, através do número do recibo retornado no envio do MDFe. | XML de resposta da consulta. |
| ConverterTx2ParaXml | aTx2 | Método responsável pela geração do XML de envio da MDFe, a partir do caminho do Tx2. | O retorno é o XML de envio do MDFe. |
| DescompactarXMLZip | aXML | Realiza a descompactação de um XML compactado. | É retornado um XML descompactado e legível. |
| EditarModeloMDFe | aXML, aArquivoRtm | Método utilizado para editar e configurar o leiaute do MDFe (arquivo rtm). | Sem retorno |
| EncerrarMDFe | aChaveMDFe, aNumProtocolo, aDHEvento, aSequenciaEvento, aDataEncerramento, aCodUFEncerramento, aCodMunicipioEncerramento, aFusoHorario | Método responsável pelo encerramento de um MDF-e já emitido. | XML informando se o evento foi registrado e vinculado ao MDF-e. |
| EnviarMDFeSincrono | aXmlMDFe | Função para Enviar MDFe's assinados ao WebService da SEFAZ de modo síncrono, ou seja, tem o retorno da SEFAZ no próprio envio do manifesto, não sendo necessário fazer uma consulta de chave ou recibo após o envio. Notas | Xml contendo mensagem do resultado da solicitação. |
| PagamentoOperacaoMDFePorTx2 | aChaveMDFe, aDHEvento, aSequenciaEvento, aFusoHorario, aTx2Evento | Enviar Pagamento Operação. Para utilizar este evento, seu MDF-e deve ser emitido com a propriedade abaixo: Tx2 = tpProp_33=0 / Xml = < tpProp >0< /tpProp > | XML com o resultado da operação solicitada. |
| EnviaEmailXMLMDFe | aArquivoXML, aOutros, aEmailDestinatario | Método usado para enviar um email com o xml destinatário e anexos informados ao destinatário. Pode ser usado para enviar xml destinatário de cancelamento, encerramento e envio. | É retornado "OK Operação realizada com sucesso" caso o retorno seja de sucesso, caso contrário retorna o motivo da falha. |
| ExportarMDFe | aXMLDestinatario, aArquivoRtm, aFormato, aExportarParaArquivo | Método utilizado para exportação do DAMDFE em um arquivo no formato PDF. |
Sem retorno Notas Links: , Danfe Encerrada , Exemplo XML Dest e Cancelada , Danfe Cancelada , Exemplo XML Dest e Enc |
| GerarXMLDestinatarioMDFe | aChaveMDFe, aLogEnvio, aLogConsulta, aSalvarComo | Gerar XML no Padrão da SEFAZ para ser armazenado. | XML Padrão da SEFAZ para Envio ao Tomador de Serviço. |
| GerarXMLEventoDestinatarioMDFe | aChaveMDFe, aLogEnvio, aLogRetorno, aTpEvento, aSalvarComo | Função responsável por gerar XML de Eventos que deve ser distribuído ao Destinatário. | Conteúdo do XML gerado. Notas |
| ImprimirMDFe | aXMLDestinatario, aArquivoRtm, aImpressora | Método utilizado para realizar a impressão do DAMDFE. | Sem retorno Notas Links: Danfe Cancelada , Danfe Encerrada , XML Dest e Canc, , XML Dest e Enc |
| IncluirCondutorMDFe | aChaveMDFe, aNumProtocolo, aDHEvento, aSequenciaEvento, aNomeCondutor, aCPFCondutor, aFusoHorario | Método responsável por vincular um novo motorista ao MDF-e. | XML com o resultado da operação solicitada. |
| InclusaoDFe | aChaveMDFe, aNumProtocolo, aDHEvento, aSequenciaEvento, aCodigoMunicipioCarga, aNomeMunicipioCarregamento, aListaCodMuniciopioDescarga, aListaNomeMunicipioDescarga, aListaChave, aFusoHorario | Método responsável por vincular um novo documento ao MDF-e. | XML com o resultado da operação solicitada. |
| GetVencimentoCertificado | Método responsável por obter a data de Vencimento do Certificado Configurado. | É retornada a data de vencimento do certificado configurado (dd/mm/aaaa hh:mm:ss) | |
| PreverMDFe | aXML, aArquivoRtm | Método utilizado para previsão do DAMDFE antes da autorização do MDF-e. | Sem retorno Notas Links: Danfe Encerrada , XML Dest e Canc , Danfe Cancelada , XML Dest e Enc |
| RemoverCertificado | CertificateName | O método remove o certificado em questão do sistema. | Retorna True caso o certificado tenha sido removido. |
| SaveConfig | aConfigFile | Salva configurações do componente em um arquivo .ini. Quando precisar salvar as configurações antes de ocorrer um erro, de modo que facilite a verificação das propriedades configuradas no momento do erro. | Sem retorno |
| TratarXMLRetornoDFe | aXML, aDiretorio | Esse método recebe o XML de retorno da Consulta Distribuição DFe, faz o tratamento de cada XML compactado e os salva no diretório desejado. | O método retornará os XML's tratados no diretório passado ao método. |
| StatusDoServico | Função que Verifica a situação do serviço WebService solicitado. Geralmente antes de enviar uma nota, porém essa consulta nem sempre está 100% correta. | XML de resposta da consulta | |
| VisualizarMDFe | aXML, aArquivoRtm | Método utilizado para visualização do DAMDFE. | Sem retorno Notas Links: Danfe Encerrada , XML Dest e Canc , Danfe Cancelada , XML Dest e Enc |
| ConfirmarServico | aChaveMDFe, aNumProtocolo, aDhEvento, aSequenciaEvento, aFusoHorario | Esse método é responsável em confirmar o serviço de transporte vinculado ao MDF-e. | XML com o resultado da operação solicitada. |
| ConverterJsonparaTX2 | aJsonFile | Esse método utilizado para converter um arquivo Json para Tx2 | Esse método retorna o recebimento da GUIA |
| ConverterJsonParaXml | aJsonFile | Método responsável pela geração do XML de envio da MDFe, a partir do caminho do Json. | Esse método retorna o recebimento da GUIA |
Exemplos
Aqui, podemos verificar exemplos de utilização do método EnviarMDFe em linguagens diferentes. Apesar do exemplo ser específico do envio de manifesto, o formato pode ser utilizado em qualquer um dos métodos.
Delphi
retorno := spdMDFe.EnviarMDFeSincrono('XML Assinado');
C#
retorno = spdMDFe.EnviarMDFeSincrono("XML Assinado");
Visual Basic 6
retorno = spdMDFe.EnviarMDFeSincrono("XML Assinado")
PHP
$retorno = spdMDFe->EnviarMDFeSincrono("XML Assinado");
Comentários
0 comentário
Artigo fechado para comentários.