TDF – TOM API Versão 2.0
Olá pessoal,
Conforme anunciado no TDF SP07 – What’s New, uma API (Application Programming Interface) foi criada para trazer benefícios e agilidade no consumo das funcionalidades do Tax Obligation Monitordo TDF, sendo o ponto central de gerenciamento de execuções de relatórios fiscais dentro de uma empresa.
Abaixo, você encontrará mais detalhes sobre essa nova funcionalidade.
Segurança
- Novas regras foram adicionadas e padronizadas em relação à segurança.
- Novos objetos de autorização foram criados para todo o tipo de acesso no TOM – desde visualização e deleção até carregamento de arquivos, por exemplo.
Arquivos Grandes
- Um dos grandes desafios ao utilizar o TOM sempre foi o tratamento dos arquivos grandes.
- Com a nova API, agora é possível customizar o download dos arquivos grandes e definir uma URL externa para o download do arquivo desejado.
Consistência de Regras
Todas as regras referentes a criação de arquivos, sendo eles originais, retificados e/ou esboços, além da criação de execuções, carregamento, deleção e execução de arquivos, foram centralizadas na API.
Uso da API
O consumo da API pode ser realizado de duas formas:
- Para desenvolvimentos realizados fora do ambiente Netweaver do TDF, o acesso à API pode ser feito através do serviço TOM_API_SRV, que é REST/OData.
As aplicações podem acessar as funcionalidades da API a partir da URL base: https://<tdfhost>/sap/opu/odata/TMF/TOM_API_SRV. - Para desenvolvimentos ABAP, foi disponibilizado um conjunto de classes que compõem a interface pública da API, e que devem ser utilizadas para o bom funcionamento da API:
- /TMF/CL_TOM_METADATA – Essa é a principal classe para acesso da API do TOM, pois ela é responsável pelo acesso às entidades do TOM.
- /TMF/CL_TOM_REPORT_RUN – É a entidade que representa as execuções dos relatórios.
- /TMF/CL_TOM_REPORT_FILE – É a entidade que representa os arquivos das execuções dos relatórios.
- /TMF/CL_TOM_REPORT – É a entidade que representa um relatório configurado no TDF.
A API do TOM foi construída de uma forma cujas funcionalidades estão disponibilizadas em entidades, e são responsáveis por todo o controle de acesso à banco e segurança.
Segue abaixo uma ilustração para facilitar a visualização dessas entidades que compõem a API:
Pensando em mantê-lo informado sobre as novidades dessa nova funcionalidade criada pelo TDF, essa é a primeira postagem de uma sequência, com o intuito de sanar as suas dúvidas e auxiliá-lo na utilização da nova API do TOM.
Você encontra mais informações sobre a API do TOM nos links abaixo:
Em caso de dúvidas e sugestões, entre em contato.
Abraço,
Ailane
Time de desenvolvimento do TDF
Oi Ailane.
É uma tendência substituírem os serviços por APIs?
Grato
Eduardo Chagas
Olá, Eduardo
A decisão de utilizar REST API foi focada no cenário do TOM, por isso não podemos afirmar que seja uma tendência.
Novos cenários serão avaliados caso a caso.
Abraço
Qualquer dúvida em relação ao uso da API vocês podem nos questionar por aqui mesmo.
Boa tarde, gostaria de saber se existe a possibilidade de uso de Web Service para execução da obrigação? Se sim, existe alguma documentação?
Olá Jair,
Você se refere a execução dos SPEDs no TDF?
Se sim, existem Web Services para executar as obrigações, veja no help do SAP Tax Declaration Framework for Brazil 1.0 em Application Help (SAP Library - English), navegue pelo menu em Integration, Enterprise Services, SPED Reports.
Você encontrará a sessão Service Operation com detalhes em cada um dos serviços disponibilizados.
Atenciosamente.
Ailane, parabéns pelo post. Muito claro e relevante!
Eu estou precisando executar a geração do SPED EFD ICMS/IPI por meio de webservice.
Mas chamando http://url/sap/opu/odata/TMF/TMFEFDReportRun ele me retorna:
"No service found for namespace /TMF/, name TMFEFDReportRun, version 0001"
Como posso solucionar este problema? Por que ele não encontra o serviço? Será que minha URL está errada?
Agradeço bastante!
Olá Davi,
Na verdade o TMFEFDReportRun é um webservice.
Você não deve chamar direto por URL, pois ele é um protocólo SOAP e trabalha com WSDL/XML.
Você pode disponibilizar este serviço, configurando o mesmo pela transação "SOAMANAGER" e acessando o link web services configuration.
Alguns detalhes sobre o serviço, você pode encontrar em:
http://help.sap.com/saphelp_tdf_br_10/helpdata/en/62/4ab85437e09421e10000000a44176d/content.htm
Att,
Juliano Bellini
Juliano, muito obrigado!
O conhecimento da transação "SOAMANAGER" foi fundamental para conseguir realizar a tarefa.
Obrigado, consegui chamar o serviço!
Juliano,
Agora, quando eu chamo a geração via webservice, acontece o seguinte erro:
<ReturnTable>
<TYPE/>
<ID>VSCAN</ID>
<NUMBER>033</NUMBER>
<MESSAGE>Profile Indicator is empty in State Tax Number customizing</MESSAGE>
...
</ReturnTable>
O xml que estou passando é:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tmf="http://sap.com/xi/TMFLOCBR">
<soapenv:Header/>
<soapenv:Body>
<tmf:EFDReportRun>
<MONTHEXEC>07</MONTHEXEC>
<COD_FINALITY>1</COD_FINALITY>
<ORGSTR_PARAM>CC</ORGSTR_PARAM>
<YEAREXEC>2016</YEAREXEC>
<BUKRS>0001</BUKRS>
</tmf:EFDReportRun>
</soapenv:Body>
</soapenv:Envelope>
Você sabe o que é esse erro?
Obrigado!
Olá Davi,
Neste caso, você precisa configurar o Indicador de Perfil para esta empresa, no ORGSTR.
Att,
Juliano Bellini
Pessoal, bom dia.
Consegui obter, a partir do serviço REST "TOM_API_SRV/report_files", informações sobre os arquivos das obrigações.
Mas existe algum serviço (REST ou SOAP) a partir do qual eu possa fazer o download de determinado arquivo?
Muito obrigado!
Olá Davi,
Nós desenvolvemos o developer guide, nele é possível ver como usa e para que serve cada serviço.
https://help.sap.com/tdf_br_10.
Lá você pode conferir como baixar o arquivo, usando o serviço em REST.
Sobre o guia, ele foi anunciado aqui:
https://blogs.sap.com/2016/12/22/tdf-primeira-versao-do-guia-do-desenvolvedor.
Att,
Juliano Bellini
Olá pessoal!
Alguém poderia, por favor, auxiliar-me com um problema que estou enfrentando?
Através da transação SOAMANAGER, estou usando o serviço "TMFNotaFiscalCorrectionsSyncIn" (conforme https://help.sap.com/viewer/0a4833541f72447abbb923f3332ed049/1.0.8/en-US/5bfc98520a472657e10000000a423f68.html).
Entretanto, a chamada ao serviço está retornando erro. Consultando a transação ST22, obtive o detalhamento do erro, conforme imagem ao fim do post.
Alguém poderia prestar-me auxílio, por favor? Acredito que esteja faltando algum conhecimento para mim. Inclusive tentei criar uma role na transação PFCG e associar-lhe o objeto de autorização ITMF_NFCOR e o meu usuário, mas não obtive sucesso.
Olhando o dump me parece ser um erro de configuração, acredito que o time de basis da sua empresa ou algum consultor deve te ajudar a resolver isso. Não parece ser erro do serviço.
Abs!
Olá, bom dia.
Estou procurando a documentação compartilhada no link:
http://help.sap.com/saphelp_tdf_br_10/helpdata/en/62/4ab85437e09421e10000000a44176d/content.htm
Preciso estudar este webservice, mas o conteúdo da url não esta disponível.
Alguém pode me ajudar ?
Atenciosamente.
Olá Thiago,
Você encontra mais informações sobre o Enterprise Service do SPED EFD ICMS/IPI report através da página do produto TDF no SAP Help Portal, da seguinte maneira:
Atenciosamente,
Ailane Kuhn
Obrigado Ailane.
Att.