Documents ERP API

(0 reviews)
This API is used to Create and Pull and Publish Documents in ASPIRE SAP S/4HANA

Overview


The Documents ERP API is a generic API which is suitable to Create, Publish, Transfer, Retrieve the documents to/from ASPIRE SAP S/4HANA System.

The Typical use cases as follows

  1. Assets maintenance Notification Attachments From ServiceNOW , JAMES, e.t.c.
  2. Transmit transportation documents from S/4HANA to 4PL,
  3. Publish Electronic data link of the Batch Master record from Veeva ECCM to S/4HANA,
  4. Publish PO attachments from GEP to S/4HANA ,
  5. Publish Customs declarations from GEP to S/4HANA.
  6. Retrieve Documents Info from SAP S/4HANA
  7. Archive Sales Order Attachments from DIA eComm to S/4HANA

Please note that this API Source systems includes:

  • ServiceNOW
  • JAMES
  • GEP
  • Veeva ECCM
  • SAP S/4HANA
  • DIA eComm
  • e.t.c

Getting Started


You may refer to the ASPIRE G-Site if you need information about the ASPIRE program

Data privacy


Data Privacy/Protection is everyone's responsibility, please always keep it in mind while processing data. You may refer to the below chart that explains the various data classification levels:

resources/image-a2a02b08-9133-4177-88bf-b3ba2f2d5830.png

Please also refer to the Information Commitments when processing data.

Intended Use


The Documents ERP API enables solutions to create or retrieve documents from the ASPIRE S/4HANA System. Through this API, source systems or process APIs can create or retrieve documents.

It also supports archiving sales order attachments into S/4HANA via the Archive Create SOAP service on behalf of the Attachment Process API.

Business Case


The Documents ERP API is a generic API which is suitable to Create, Publish, Transfer,Retrieve the documents to/from ASPIRE SAP S/4HANA System.

The Typical use cases as follows

  1. Assets maintenance Notification Attachments From ServiceNOW , JAMES, e.t.c.
  2. Transmit transportation documents from S/4HANA to 4PL,
  3. Publish Electronic data link of the Batch Master record from Veeva ECCM to S/4HANA,
  4. Publish PO attachments from GEP to S/4HANA ,
  5. Publish Customs declarations from GEP to S/4HANA.
  6. Retrieve Documents Info from SAP S/4HANA
  7. Archive Sales Order Attachments from DIA eComm to S/4HANA

The API endpoint /documentInfoFull . This resource Retrieve Document Info from SAP S/4HANA (CALLBACK API)

Sr.NoResourceMethodDescriptionquery Parms
1/documentInfoFullGETThis resource Retrieve Document Info from SAP S/4HANAdocNumber , docType , docPart , docVersion , getAll, getObjectLinks, getStatusLog, getLongTexts, getActiveFiles , getDocDescriptions , getDocFiles , getClassification , getStructure, getWhereUsed , outputFormat=json

Example url : https://test-eur-rcn5.apis.roche.com:37355/v1/documentInfoFull?docNumber=0000000000000010000083891&docType=Y02&docPart=000&docVersion=01&getAll=true&getObjectLinks=true&getStatusLog=true&getLongTexts=true&getActiveFiles=true&getDocDescriptions=true&getDocFiles=true&getClassification=true&getStructure=true&getWhereUsed=true&outputFormat=json

The API endpoint /salesOrderAttachmentsData. This resource archives Sales Order Attachment documents into SAP S/4HANA via the Archive Create SOAP service.

Sr.NoResourceMethodDescriptionpayload fields
1/salesOrderAttachmentsDataPOSTThis resource archives Sales Order Attachment documents into SAP S/4HANADocumenttype, FileContent, Length, Objecttype, SapObject, SapObjectId, Signature, VscanProfile

Reviews