Lista com todos os métodos do componente CTe.
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 |
|---|---|---|---|
| AssinarCT | aXML | Gera assinatura de cada Conhecimento de transporte (CT) dentro do arquivo XML. | |
| CalculaChave | aXML, aUF, aDtEmissao, aCNPJ, aModelo, aSerie, aNRCTe, aTipoEmissao, aCodigo | Calcula chave do conhecimento de Transporte de acordo com o manual 3.00. | Este método retornará a chave de acesso do CT-e |
| CancelarComprovanteEntrega | aChaveCTe, aDataHoraEvento, aNumProtocolo, aNumProtocoloCE, aSequenciaEvento | Método utilizado para enviar o cancelamento de um comprovante de entrega da carga pelo transportador. O autor do evento é o emissor do CT-e. | É retornado um Xml informando se o evento foi ou não vinculado. |
| CancelarCTEvento | aChaveCTe, aNumProtocolo, aJustificativa, aDataHoraEvento, aSequenciaEvento | Função que envia solicitação de Cancelamento do CT-e | XML com o resultado da operação solicitada |
| CancelarDesacordo | aChaveCTe, aDataHoraEvento, aNumProtocolo, aSequenciaEvento |
Método utilizado para que o tomador possa cancelar o evento de prestação de serviço em desacordo gerado indevidamente em um CTe. |
É retornado o XML informando se o evento foi ou não cancelado. |
| LoadConfig | aConfigFile | Carrega configurações do componente a partir de um arquivo .ini configurado na propriedade (aConfigFile). Caso não seja informado o parâmetro, o componente irá procurar o arquivo .ini presente na pasta do .exe para realizar a configuração. De preferência quando iniciar seu projeto, de modo que as configurações do componente já sejam feitas. | |
| CheckConfig | aConfigFile | Valida as configurações previamente configuradas no ini de configuração. | Quando as seguintes propriedades não estiverem configuradas ou estiverem de forma inválida: Local, CNPJ, DiretorioLog, DiretorioXMLTomadorServico, MaxSizeLoteEnvio), retornará a exception EspdCTeCheckParams. uando os seguintes arquivos não estiverem configurados corretamente: ArquivoServidoresHom, ArquivoServidoresProd, retornará a exception EspdCTeFileNotFoundException. |
| ConfigurarSoftwareHouse | aCNPJSoftwareHouse, aKey | Para que possa utilizar nosso componente, é necessário que configure o CNPJ da software house, através do método ConfigurarSoftwareHouse. | O método ConfigurarSoftwareHouse não possui retorno. Notas |
| ConsultarRecibo | aNumRecibo | Função para consultar situação do CT-e no WebService da SEFAZ através do numero de recibo, para verificar se a nota foi autorizada ou rejeitada, com o motivo. | XML de resposta da consulta. |
| ConsultarDistribuicaoDFe | aCodigoUF, aCNPJCPF, aNSU, aTipoNSU | O método disponibiliza para os atores do CT-e informações e documentos fiscais eletrônicos de seu interesse. A distribuição será realizada para emitentes e tomadores de serviço, informados no conteúdo do CT-e (Conhecimento de Transporte Eletrônico). | É retornado um Xml contendo os documentos (Compactados em base64) de interesse do ator. Para tratar este retorno deverá utilizar o método TratarXMLRetornoDFe. |
| ConsultarCT | aChave | Função para consultar situação da chave do CT-e no WebService da SEFAZ. Nos casos onde é necessário confirmar se uma nota está autorizada, cancelada ou rejeitada. | XML de resposta da consulta. |
| ConverteXmlparaDataSet | aXML | Para realizar a conversão de um XML tomador para dataset, utilize o método ConverteXmlparaDataSet, isso facilitará a importação e manipulação de dados de um XML. | Este método retornará um objeto do tipo "TspdCTeDataSets", populado com os dados do XML. |
| DescompactarXMLZip | aXML | Para descompactar um XML zipado, utilize o método DescompactarXMLZip. | O método DescompactarXMLZip retorna o XML descompactado. |
| EditarModeloCCe | aXMLCCe, ArquivoRtm | Método que edita Carta de Correção, abrindo o editor de RTM (Report Builder). | Notas |
| EditarModeloDacte | XML, ArquivoRtm | Método utilizado para editar e configurar o leiaute do Dacte (arquivo rtm). | Notas |
| EnviarConhecimento TomadorAnexos |
aCaminhoXML, aCaminhoPDF, aAnexos | Método para enviar o conhecimento para os e-mails especificados Notas | |
| EnviarCCe | aChaveCTe, aDataHoraEvento, aXmlEvento, aSequenciaEvento | Função que envia o evento CCe (Carta de Correção do CTe). | XML com o resultado da operação solicitada Exemplo Carta Correção CTe.tx2 |
| EnviarConhecimento TomadorAnexos |
aCaminhoXML, aCaminhoPDF, aAnexos | Método disponibilizado para a distribuição do CT-e para o Tomador de Serviço com Anexos | Retorna TRUE caso tenha enviado com sucesso, senão retorna FALSE. Notas |
| EnviarCTSincrono | aXML | Método para Enviar CTe's assinados ao WebService da SEFAZ de modo síncrono, não sendo necessário fazer uma consulta de chave ou recibo após o envio. | Xml contendo mensagem do resultado da solicitação. |
| EnviarCT | aNumLote, aXML | Método para Enviar CTe's assinados ao WEBService da SEFAZ. | XML contendo a mensagem do resultado da solicitação |
| EnviarConhecimentoTomador | aIDCTe, aLogConsRecibo | Método disponibilizado para a distribuição do CT-e para o Tomador de Serviço conforme documentação do manual versão 1.0.3. | |
| EnviarComprovanteEntrega | aChaveCTe, aDataHoraEvento, aNumProtocolo, aDataHoraEntrega, aDocumentoPessoa, aNomePessoa, aLatitude, aLongitude, aPathImagemEntrega, aListaChavesNFe, aSequenciaEvento | Método utilizado para indicar a efetivação da entrega da carga pelo transportador. O autor do evento é o emissor do CT-e. | É retornado um Xml informando se o evento foi ou não vinculado. |
| EnviarDesacordo | aChaveCTe, aDataHoraEvento, aObservacao, aSequenciaEvento | Método utilizado para que o tomador possa informar ao fisco que o documento CT-e que o relaciona está em desacordo com a prestação de serviço. | É retornado um Xml informando se o evento foi ou não vinculado. |
| ExportarCCe | aXMLCCe, ArquivoRtm, FileName, aFormataExportacao | Para gerar um PDF da Carta de Correção no diretório configurado no método. | Notas |
| ExportarDacteParaPDF | XML, ArquivoRtm, FileName | Método utilizado para exportação do Dacte em um arquivo no formato PDF. | Notas |
| ExtrairProtocolo | aXML | Extrai o protocolo do XML de retorno do envio e da consulta do CT-e. | Número do protocolo (String) |
| GerarXMLCCeporTX2 | aTX2File | Método para retornar um XML de CCe para Envio ao servidor SEFAZ. | XML da CCe |
| GerarXmlCancelamentoDestinatario | aIDCTe, aContentLogPedCanc, aContentLogRetCanc, aSalvarComo | Método responsavel por gerar XML de Cancelamento que deve ser distribuído ao Destinatário. | XML do cancelamento |
| GerarXMLEnvioTomadorServico | aIdCTe, aLogEnvLote, aLogConsChave, aSalvarComo | Gerar XML no Padrão da SEFAZ a ser enviado ao Tomador de Serviço | XML Padrão da SEFAZ para Envio ao Tomador de Serviço |
| GerarXmlEventoDestinatario | aIDCTe, aLogEnvio, aLogRetorno; aTpEvento; aSalvarComo | Método responsável por gerar XML de Eventos que deve ser distribuído ao Destinatário. | Conteúdo do XML gerado Notas |
| GerarXMLporTX2 | aTX2File | Método para retornar um XML para Envio ao servidor SEFAZ. | XML do CTe |
| ImprimirCCe | aXMLCCe, ArquivoRtm, aImpressora | Método que imprime Carta de Correção. | Notas |
| ImprimirDacte | XML, ArquivoRtm, Impressora | Método utilizado para realizar a impressão do Dacte na impressora configurada. | Notas |
| ImprimirDacteXmlDiretorio | aDiretorioXml, aArquivoModelo, aExportarArquivoPara, aImpressora | Este método permite realizar a impressão do DACTE de XML's autorizados, que estão em um determinado diretório. | |
| InutilizarCT | aAno, aCNPJ, aModelo, aSerie, aCTIni, aCTFin, aJustificativa | Método responsável por inutilizar uma faixa de numeração do CTe (nCT). | XML com o resultado da operação solicitada |
| ObterCodigoUF | aUF | Retorna o código da UF. | Código da UF. |
| PreverDacte | XML, ArquivoRtm | Método utilizado para prever o Dacte antes do Envio. | Notas |
| SaveConfig | aConfigFile | Salva configurações do componente em um arquivo .ini. | |
| 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 | método 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 | |
| VisualizarCCe | aXMLCCe, | Método que visualiza Carta de Correção. | Notas |
| VisualizarDacte | XML, ArquivoRtm | Método utilizado para visualização do Dacte. |
Exemplos
Aqui, podemos verificar exemplos de utilização do método EnviarGuia em linguagens diferentes. Apesar do exemplo ser específico do envio de guia, o formato pode ser utilizado em qualquer um dos métodos.
Delphi
retorno := spdCTe.EnviarCCe('00000000000000000000000000000000000000000000', '2017-07-18T09:51:00', 'XML da CCe', '1');
C#
retorno = spdCTe.EnviarCCe("00000000000000000000000000000000000000000000", "2017-07-18T09:51:00", "XML da CCe", "1");
Visual Basic 6
retorno = spdCTe.EnviarCCe("00000000000000000000000000000000000000000000", "2017-07-18T09:51:00", "XML da CCe", "1")
PHP
$retorno = spdCTe->EnviarCCe("00000000000000000000000000000000000000000000", "2017-07-18T09:51:00", "XML da CCe", "1");
Comentários
0 comentário
Por favor, entre para comentar.