Lista com todos os métodos do componente CTeOS.
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 |
|---|---|---|---|
| AssinarCTeOS | aXML | Gera assinatura de cada Conhecimento de transporte outros serviços (CTeOS) dentro do arquivo XML. | XML assinado |
| CalculaChave | aXML, aUF, aDtEmissao, aCNPJ, aModelo, aSerie, aNRCTeOS, aTipoEmissao, aCodigo | Calcula chave do conhecimento de transporte outros serviços de acordo com o manual 3.00. | Este método retornará a chave de acesso do CT-e OS |
| CancelarCTeOSEvento | aChaveCTeOS, aNumProtocolo, aJustificativa, aDataHoraEvento, aSequenciaEvento | Método que envia solicitação de Cancelamento do CT-e OS | XML com o resultado da operação solicitada. |
| 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. | Sem retorno |
| 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 EspdCteOSOSCheckParams. uando os seguintes arquivos não estiverem configurados corretamente: ArquivoServidoresHom, ArquivoServidoresProd, retornará a exception EspdCteOSOSFileNotFoundException. |
| 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 |
| ConsultarCTeOS | aChave | Função para consultar situação da chave do CT-e OS 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 retorna um objeto do tipo "TspdCteOSOSDataSet", populado com os dados do XML. |
| 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 |
| EnviarCCe | aChaveCteOS, aDataHoraEvento, aXmlEvento, aSequenciaEvento | Método que envia o evento CCe (Carta de Correção do CteOS). | XML com o resultado da operação solicitada |
| EnviarConhecimento TomadorAnexos |
aCaminhoXML, aCaminhoPDF, aAnexos | Método disponibilizado para a distribuição do CT-e OS para o Tomador de Serviço com Anexos. | Retorna TRUE caso tenha enviado com sucesso, senão retorna FALSE. |
| EnviarConhecimentoTomador | aIDCteOS, aLogConsRecibo | Método disponibilizado para a distribuição do CT-e OS para o Tomador de Serviço conforme documentação do manual versão 1.0.3. | Retorna TRUE caso tenha enviado com sucesso, senão retorna FALSE. |
| EnviarCteOS | aXML | Função para Enviar CT-e OS assinados ao WEBService da SEFAZ. | XML contendo a mensagem do resultado da solicitação. |
| EnviarDesacordo | aChaveCTeOS, 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 OS. | Número do protocolo (String) |
| GerarXMLCCeporTX2 | aTX2File | Método para retornar um XML de CCe para Envio ao servidor SEFAZ. | XML da CCe |
| GerarXmlCancelamento Destinatario |
aIDCTeOS, aContentLogPedCanc, aContentLogRetCanc, aSalvarComo | Método responsavel por gerar XML de Cancelamento que deve ser distribuído ao Destinatário. | XML do cancelamento |
| GerarXMLEnvio TomadorServico |
aIDCTeOS, 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 | aIDCTeOS, aLogEnvio, aLogRetorno; TEventoKind; aSalvarComo | Função 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 CTeOS |
| 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 |
| ObterCodigoUF | aUF | Retorna o código da UF. | Código da UF. |
| PreverDacte | XML, ArquivoRtm | Notas | |
| SaveConfig | aConfigFile | Salva configurações do componente em um arquivo .ini. | |
| StatusDoServico | n/a | 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, ArquivoRtm | 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 GerarXmlEventoDestinatario em 4 linguagens diferentes. Apesar do exemplo ser específico do geração de notas, o formato pode ser utilizado em qualquer um dos métodos.
Delphi
retorno := spdCTeOS.GerarXmlEventoDestinatario('00000000000000000000000', 'C:\ped-eve.xml', 'C:\eve.xml', 0, 'C:\Evento.xml');
C#
retorno = spdCTeOS.GerarXmlEventoDestinatario("0000000000000000000000000", "C:\ped-eve.xml", "C:\eve.xml", 0, "C:\Evento.xml");
Visual Basic 6
retorno = spdCTeOS.GerarXmlEventoDestinatario("00000000000000000000000000000000", "C:\ped-eve.xml", "C:\eve.xml", 0, "C:\Evento.xml")
PHP
$retorno = spdCTeOS->GerarXmlEventoDestinatario("00000000000000000000000", "C:\ped-eve.xml", "C:\eve.xml", 0, "C:\Evento.xml");
Comentários
0 comentário
Por favor, entre para comentar.