| Description | Query Document Output Request |
| Name | QueryDocumentOutputRequestIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Input Output Management |
| Process Component Name | InputAndOutputManagement |
| Process Component Namespace | http://sap.com/xi/AP/FO/FileInputControl/Global |
| Deployment Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to perform query and read operations on Output Management History Items.
A Document Output Request is a set of output requests and processed output requests related to the Reference Business Object. Several output channels are supported for sending out documents.An invoice can only been output once as an original document, later on only a document marked as copy can be output. QueryDocumentOutputRequestIn webservice can be used to access the output history.A Document Output Request supports the output to several output channels. Possible output channels are Print, E-mail, Fax, XML and External System.
| Advanced Shipping Notification |
| Balance Confirmation |
| Canceled Purchase Order |
| Changed Purchase Order |
| Confirmation Notification |
| Created Purchase Order |
| Customer Contract |
| Customer Invoice |
| Customer Return |
| Delivery Note |
| Down Payment Request |
| Dunning Letter |
| ERS Invoice |
| Inbound Delivery Notification |
| Incoming check receipt |
| Invoice Request |
| Journal Entry Report |
| Order to Service Performer |
| Petty Cash Receipt |
| Purchase Order Reminder Letter |
| Remittance Advice |
| Sales Order |
| Sales Quote |
| Service Order |
| Service Request |
| Summary Invoice Form |
| Tax Return |
| Third Party Logistics Outbound Request |
| Unified Reporting Israel |
The web service interface QueryDocumentOutputRequestIn enables you to connect external applications to your solution and to query and read Output History data in your system. The web service interface QueryDocumentOutputRequestIn is relevant if your company wants to access Output management data from external applications.
| Operation name | Description |
|---|---|
| FindByElements | Fetch Document data via query |
| ReadOutputPDF | Read PDF content |
| ReadOutputXML | Read XML content |
| Codes | Value |
|---|---|
| 1 | Pending |
| 2 | Successful |
| 3 | Error |
| Codes | Value |
|---|---|
| FAX | Fax |
| INT | |
| PRT | |
| XML | XML |
| XMS | External System |
Here is an example of a simple web service request, which seeks for two records of output management data between 15-11-2017 00:00 to 23:00.
<n0:DocumentOutputRequestByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestSelectionByElements> <SelectionBySubmittedOn> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>3</IntervalBoundaryTypeCode> <LowerBoundaryCreationDate>2017-11-15T00:00:00.0000000Z</LowerBoundaryCreationDate> <UpperBoundaryCreationDate>2017-11-15T23:00:00.0000000Z</UpperBoundaryCreationDate> </SelectionBySubmittedOn> </DocumentOutputRequestSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>2</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:DocumentOutputRequestByElementsQuery_sync>
Here is an excerpt of the response of the request above.
Show full documentation
Show full documentation
<?xml version="1.0"?>
<n0:DocumentOutputRequestByElementsResponse_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TASB77DFAEF292DE455BC6A:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<DocumentOutputRequestInformation>
<ChangeStateID> 20171115025426.4008310</ChangeStateID>
<DocumentUUID>00163e07-3d62-1ed7-b2b6-0859df157cf0</DocumentUUID>
<RecipientBusinessPartnerUUID>00163e06-5908-1ed6-8ddd-80d3e69d75e7</RecipientBusinessPartnerUUID>
<SenderCompanyID>GCKR-1200</SenderCompanyID>
<ResponsibleIdentityID>GREENEPETERM</ResponsibleIdentityID>
<HostDocumentID>KRCI-42</HostDocumentID>
<HostObjectNodeID>00163E073D621ED7B2B6084615595CF0<HostObjectNodeID>
<HostObjectTypeCode>28</ReferenceObjectTypeCode>
<HostObjectNodeTypeCode>229</HostObjectNodeTypeCode>
<DocumentDetails>
<DocumentName>Customer Invoice KRCI-42</DocumentName>
<OutputStatus>1</OutputStatus>
<SubmittedOn>2017-11-15T02:54:16.599705Z</SubmittedOn>
<OutputOn>2017-11-15T02:54:26.400831Z</OutputOn>
<CreationIdentityUUID>00300571-ce9b-1ded-8dc7-429a837d069a</CreationIdentityUUID>
<SenderIdentityUUID>00300571-ce9b-1ded-8dc7-429a837d069a</SenderIdentityUUID>
</DocumentDetails>
<OutputDetails>
<FormGroupCode>C41</FormGroupCode>
<FormTemplateCode>C4101</FormTemplateCode>
<FormTemplateCountryCode>KR</FormTemplateCountryCode>
<FormTemplateLanguageCode>EN</FormTemplateLanguageCode>
<SenderCountryCode>KR</SenderCountryCode>
<ChannelType>PRT</ChannelType>
<PrintDetails>
<PrintQueueID>Customer_Invoice_Queue</PrintQueueID>
<NumberOfCopies>1</NumberOfCopies>
</PrintDetails>
</OutputDetails>
</DocumentOutputRequestInformation>
<DocumentOutputRequestInformation>
<ChangeStateID> 20171115025426.4008310</ChangeStateID>
<DocumentUUID>00163e07-3d62-1ed7-b2b6-08d7d011fcf0</DocumentUUID>
<RecipientBusinessPartnerUUID>00163e06-5908-1ed6-8ddd-80d3e69d75e7</RecipientBusinessPartnerUUID>
<SenderCompanyID>GCKR-1200</SenderCompanyID>
<ResponsibleIdentityID>GREENEPETERM</ResponsibleIdentityID>
<HostDocumentID>KRCI-42</HostDocumentID>
<HostObjectNodeID>00163E073D621ED7B2B6084615595CF0</HostObjectNodeID>
<HostObjectTypeCode>28</HostObjectTypeCode>
<HostObjectNodeTypeCode>229</HostObjectNodeTypeCode>
<DocumentDetails>
<DocumentName>Resubmission of Customer Invoice KRCI-42</DocumentName>
<OutputStatus>1</OutputStatus>
<SubmittedOn>2017-11-15T02:54:16.599705Z</SubmittedOn>
<OutputOn>2017-11-15T02:54:26.400831Z</OutputOn>
<CreationIdentityUUID>00300571-ce9b-1ded-8dc7-429a837d069a</CreationIdentityUUID>
<SenderIdentityUUID>00300571-ce9b-1ded-8dc7-429a837d069a</SenderIdentityUUID>
</DocumentDetails>
<OutputDetails>
<FormGroupCode>C41</FormGroupCode>
<FormTemplateCode>C4101</FormTemplateCode>
<FormTemplateCountryCode>KR</FormTemplateCountryCode>
<FormTemplateLanguageCode>EN</FormTemplateLanguageCode>
<SenderCountryCode>KR</SenderCountryCode>
<ChannelType>PRT</ChannelType>
<PrintDetails>
<PrintQueueID>Customer_Invoice_Queue</PrintQueueID>
<NumberOfCopies>2</NumberOfCopies>
</PrintDetails>
</OutputDetails>
</DocumentOutputRequestInformation>
<ProcessingConditions>
<ReturnedQueryHitsNumberValue>2</ReturnedQueryHitsNumberValue>
<MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator>
<LastReturnedObjectID>00163E073D621ED7B2B608D7D011FCF0</LastReturnedObjectID>
</ProcessingConditions>
</n0:DocumentOutputRequestByElementsResponse_sync>
Here is one more example of a simple web service request, which seeks for a particular Output Histry entry based on UUID.
<n0:DocumentOutputRequestByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestSelectionByElements> <SelectionByDocumentUUID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryUUID >00163e04-f9df-1ed3-8791-1e9abdd4b2e4</LowerBoundaryUUID> <UpperBoundaryUUID /> </SelectionByDocumentUUID> </DocumentOutputRequestSelectionByElements> </n0:DocumentOutputRequestByElementsQuery_sync>
Here is an excerpt of the response of the request above.
<?xml version="1.0"?>
<n0:DocumentOutputRequestByElementsResponse_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TASB77DFAEF292DE455BC6A:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<DocumentOutputRequestInformation>
<ChangeStateID> 20171027070103.9019110</ChangeStateID>
<DocumentUUID>00163e04-f9df-1ed3-8791-1e9abdd4b2e4</DocumentUUID>
<RecipientBusinessPartnerUUID>00163e02-1b8d-1ee0-bc98-7a4ab543f931</RecipientBusinessPartnerUUID>
<SenderCompanyID>GCNL-1200-1</SenderCompanyID>
<ResponsibleIdentityID>GESE6NMXGJD</ResponsibleIdentityID>
<HostObjectNodeID>00163E04F9DF1ED387911E862617F2E4</HostObjectNodeID>
<HostObjectTypeCode>28</HostObjectTypeCode>
<HostObjectNodeTypeCode>229</HostObjectNodeTypeCode>
<DocumentDetails>
<DocumentName>Customer Invoice NL1I-1</DocumentName>
<OutputStatus>2</OutputStatus>
<SubmittedOn>2013-09-13T15:27:12.631006Z</SubmittedOn>
<OutputOn>2017-10-27T07:01:03.901911Z</OutputOn>
<CreationIdentityUUID>00163e02-ed16-1ed1-b4cc-8577acd907e2</CreationIdentityUUID>
<SenderIdentityUUID>00300571-ce9b-1ded-8dc7-301872e1069a</SenderIdentityUUID>
</DocumentDetails>
<OutputDetails>
<FormGroupCode>C41</FormGroupCode>
<FormTemplateCode>C4101</FormTemplateCode>
<FormTemplateCountryCode>NL</FormTemplateCountryCode>
<FormTemplateLanguageCode>EN</FormTemplateLanguageCode>
<SenderCountryCode>NL</SenderCountryCode>
<OutputChannel>PRT</OutputChannel>
<PrintDetails>
<PrintQueueID>Customer_Invoice_Queue</PrintQueueID>
<NumberOfCopies>1</NumberOfCopies>
</PrintDetails>
</OutputDetails>
</DocumentOutputRequestInformation>
<ProcessingConditions>
<ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue>
<MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator>
<LastReturnedObjectID>00163E04F9DF1ED387911E9ABDD4B2E4</LastReturnedObjectID>
</ProcessingConditions>
</n0:DocumentOutputRequestByElementsResponse_sync>
Here is an example of a simple web service request, which seeks output pdf data based on the Document UUID
<n0:DocumentOutputRequestPdf_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestPDFInformation> <ReadByDocumentUUID >00163E07-3D62-1EE8-8F97-845BB293475D</ReadByDocumentUUID> </DocumentOutputRequestPDFInformation> </n0:DocumentOutputRequestPdf_sync>
Here is an excerpt of the response of the request above:
<?xml version="1.0"?> <n0:DocumentOutputRequestPdfResponse_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS0F3E5B6FC0848993D839:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestPDF> <DocumentUUID>00163e07-3d62-1ee8-8f97-845bb293475d</DocumentUUID> <OutputPDF>……</OutputPDF> <DocumentName>MCCI-272_20180410-123924UTC</DocumentName> <TotalPagesNumberValue>1</TotalPagesNumberValue> </DocumentOutputRequestPDF> </n0:DocumentOutputRequestPdfResponse_sync>
Here is one more example for passing more than one UUID.
<n0:DocumentOutputRequestPdf_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestPDFInformation> <ReadByDocumentUUID >00163E07-3D62-1EE8-8F97-845BB293475D</ReadByDocumentUUID> </DocumentOutputRequestPDFInformation> <DocumentOutputRequestPDFInformation> <ReadByDocumentUUID >00163E07-3D62-1EE8-8F97-845BB293475D</ReadByDocumentUUID> </DocumentOutputRequestPDFInformation> </n0:DocumentOutputRequestPdf_sync>
Here is an excerpt of the response of the request above.
<?xml version="1.0"?> <n0:DocumentOutputRequestPdfResponse_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS0F3E5B6FC0848993D839:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestPDF> <DocumentUUID>00163e07-3d62-1ee8-8f97-845bb293475d</DocumentUUID> <OutputPDF>……</OutputPDF> <DocumentName>MCCI-272_20180410-123924UTC</DocumentName> <TotalPagesNumberValue>1</TotalPagesNumberValue> </DocumentOutputRequestPDF> <DocumentOutputRequestPDF> <DocumentUUID>00163e07-3d62-1ee8-8f97-845bb293475d</DocumentUUID> <OutputPDF>……</OutputPDF> <DocumentName>MCCI-272_20180410-123924UTC</DocumentName> <TotalPagesNumberValue>1</TotalPagesNumberValue> </DocumentOutputRequestPDF> </n0:DocumentOutputRequestPdfResponse_sync>
Here is an example of a simple web service request, which seeks output xml data based on the Document UUID.
<n0:DocumentOutputRequestXml_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestReadXML> <ReadByDocumentUUID >00163E07-3D6A-1EE8-8FB1-230E477DB8DA</ReadByDocumentUUID> </DocumentOutputRequestReadXML> </n0:DocumentOutputRequestXml_sync>
Here is an excerpt of the response of the request above.
<?xml version="1.0"?> <n0:DocumentOutputRequestXmlResponse_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS9E8BF2F008CC81239E69:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestXML> <DocumentUUID>00163e07-3d6a-1ee8-8fb1-230e477db8da</DocumentUUID> <OutputXMLData>……</OutputXMLData> </DocumentOutputRequestXML> </n0:DocumentOutputRequestXmlResponse_sync>
Here is one more example for passing more than one UUID.
<n0:DocumentOutputRequestXml_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestReadXML> <ReadByDocumentUUID >00163E07-3D6A-1EE8-8FB1-230E477DB8DA</ReadByDocumentUUID> </DocumentOutputRequestReadXML> <DocumentOutputRequestReadXML> <ReadByDocumentUUID >00163E07-3D62-1EE8-8F97-845BB293475D</ReadByDocumentUUID> </DocumentOutputRequestReadXML> </n0:DocumentOutputRequestXml_sync>
Here is an excerpt of the response of the request above.
<?xml version="1.0"?> <n0:DocumentOutputRequestXmlResponse_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS9E8BF2F008CC81239E69:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <DocumentOutputRequestXML> <DocumentUUID>00163e07-3d62-1ee8-8f97-845bb293475d</DocumentUUID> <OutputXMLData>……</OutputXMLData> </DocumentOutputRequestXML> <DocumentOutputRequestXML> <DocumentUUID>00163e07-3d6a-1ee8-8fb1-230e477db8da</DocumentUUID> <OutputXMLData>……</OutputXMLData> </DocumentOutputRequestXML> </n0:DocumentOutputRequestXmlResponse_sync>
You can find general information about Web services, their structure and consumption in the Web Services documentation.
| Description | Find document output request |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Released |
To find Output Management data by elements
The request message of the operation "FindByElements" contains the DocumentOutputRequestSelectionByElements node that groups all possible selection parameters. This node is described in the following sub-chapter.
This node groups all selection parameters. The selection parameters are:
| Selection Parameter | Remark |
|---|---|
| SelectionByFormGroupCode | Selection By Form Group Code |
| SelectionByFormTemplateCode | Selection By Form Template Code |
| SelectionByOutputStatus | Selection By Output Status |
| SelectionByChannelType | Selection By Channel Type |
| SelectionByHostObjTypeCode | Selection By Host Obj Type Code |
| SelectionByHostNodeTypeCode | Selection By Host Node Type Code |
| SelectionBySubmittedOn | Selection By Submitted On |
| SelectionByOutputOn | Selection By Output On |
| SelectionByHostObjUUID | Selection By Output On |
| SelectionByRecipientBusinessPartnerUUID | Selection By Recipient Business PartnerUUID |
| SelectionByDocumentUUID | Selection By Document UUID |
Interval Boundary Type Code for Date Time selection parameters are below.
| Selection Parameter | Description |
|---|---|
| 1 | Equal To |
| 2 | Between (excl. upper boundary) |
| 3 | Between |
| 4 | Between (excl. both boundaries) |
| 5 | Between (excl. lower boundary) |
| 6 | Less Than |
| 7 | Less Than or Equal to |
| 8 | Greater Than |
| 9 | Greater Than or Equal to |
The response contains the list of found Document data, log items, and processing conditions.
| Release | Change Description | Details |
|---|---|---|
| 1808 | Service created | To query Output Management data |
| Description | Read document output request xml |
| Name | ReadOutputXML |
| Synchronous | yes |
| Release Status | Released |
To read Output Management xml data via document uuid
The request message of the operation "ReadOutputOutputXML" contains the DocumentOutputRequestReadXML node that contains Document UUID . This node is described in the following sub-chapter.
Following read parameter should be used to trigger read service:
| Read Parameter | Remark |
|---|---|
| DocumentUUID | Read By Document UUID |
The response contains the list of found xml details, log items, and processing conditions.
| Release | Change Description | Details |
|---|---|---|
| 1808 | Service created | To Read xml content corresponding to document |
| Description | Read document output request pdf |
| Name | ReadOutputPDF |
| Synchronous | yes |
| Release Status | Released |
To read Output Management pdf data via document uuid
The request message of the operation "ReadOutputOutputPDF" contains the DocumentOutputRequestPdfInformation node that contains Document UUID . This node is described in the following sub-chapter.
Following read parameter should be used to trigger read service:
| Read Parameter | Remark |
|---|---|
| DocumentUUID | Read By Document UUID |
The response contains the list of found Message payload details, log items, and processing conditions.
| Release | Change Description | Details |
|---|---|---|
| 1808 | Service created | To Read PDF content corresponding to document |