| Description | Manage Goods And Service Acknowledgement |
| Name | ManageGoodsAndServiceAcknowledgementInbound |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Goods And Service Acknowledgement Processing |
| Process Component Name | GoodsAndServiceAcknowledgement |
| Process Component Namespace | http://sap.com/xi/AP/Purchasing/Global |
| Deployment Unit Description | Purchasing |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to migrate or create Goods and Service Acknowledgment from a source system or file.
The web service Interface Manage GoodsAndServiceAcknowledgement In enables you to connect external applications to your SAP Business By Design system and to create Goods and Service Acknowledgment in your system. The web service interface_Manage GoodsAndServiceAcknowledgement In_ is relevant if your company wants to access and manage Goods and Service Acknowledgment data from external applications.
The web service interface Manage GoodsAndServiceAcknowledgement In offers the operations MAINTAIN_BUNDLE.
In the Purchase Requests and Orders work center, , you can create a purchase order acknowledgment (PO acknowledgment) based on information from a supplier, in response to the supplier’s receipt of your purchase order (PO). if you accept changes to the PO acknowledgment, the system updates the original purchase order.
Existence of referenced business documents:
The following business documents are only referenced and will not be created by the service operations. They must exist in the system already at the time the web service is called:
• Purchase Order
• Business Partners (Supplier, Company Purchasing units)
• Employees (Recipient, Requester, Customer etc)
• Location (Ship-To)
• Products and Product Category.
• Cost Objects ( Cost center)
If the GSA needs to be posted using the web service then the GSA provided as input should be in Post GSA indicator ‘true’.
Maintain Bundle operations enable external applications to create and change business document data. Check Maintain Bundle operations enable external applications to simulate maintain bundle requests without changing business document data.
In particular, Check Maintain Bundle operations have the following functions:
• Return system messages similar to corresponding Maintain_ Bundle operation
• Provide the same message type as the corresponding Maintain_ Bundle operation
• Does not assign internal numbers from a productive number range interval (number range status are not increased)
• Does not change business documents
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.Following are the existing action codes and their description.
| Action Code | Description |
|---|---|
| 01 | Create; the system returns an error message if the node element already exists. |
The processing of node elements with cardinality > 1 (for example a list of descriptions in different languages or a list of telephone numbers) can be controlled using List Complete Transmission Indicators (LCTI). The LCTI indicates whether a list of node elements is transmitted completely. The LCTI of a node element with cardinality > 1 is modeled as an attribute of its parent node element (attribute name: <name of child element>ListCompleteTransmissionIndicator).
| LCTI | Description |
|---|---|
| false | The list of node elements is not transmitted completely and hence all node elements that are not transmitted remain unchanged. If transmitted node elements in the list can be identified uniquely, the system processes the node elements according the action code. If transmitted node elements in the list cannot be identified uniquely, the system appends the node element to the corresponding list of node elements in the target business document. |
| true | The list of elements is transmitted completely and hence all node elements that are not transmitted are removed. If no node element is transmitted, the complete list is removed. |
Default list complete transmission indicator: false.
Note: The LCTI refers to the completeness of the list of node elements and does not state completeness of sub-elements.
New description with language code DE (German) is created while an existing description with language code EN (English) is updated. Moreover, an existing description with language code FR (French) remains unchanged and any other description (with language code ES (Spanish), for example) is deleted. An error is raised if there is already a German description or if the English or French description does not exist.
Show full documentation
Show full documentation
<Root actionCode="04" descriptionListCompleteTransmissionIndicator="true" >
<Description actionCode="01">
<Description languageCode="DE">neuer deutscher Text
</Description>
<Description actionCode="02">
<Description languageCode="EN">changed english text
</Description>
<Description actionCode="06">
<Description languageCode="FR"></Description>
</Description>
</Root>
Optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents.
Maintain bundle and check maintain bundle operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer is responsible for ensuring reasonable sizes of data for mass operations.
Maintain bundle and check maintain bundle operations support exactly one execution (idem potency). To ensure exactly one execution of web service requests, the web service consumer has to provide unique values for the elements ID or UUID of the BasicMessageHeader node element.
Using change state identifier (element name ChangeStateID), external applications can enforce that a modifying operation is not executed because the state of the business document has changed since the external application last read its data.
The change state ID is an uninterpretable string that is provided by query and read operations and can be utilized by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. If the change state ID is not provided by the web service consumer, the system performs the web service operation without checking the state of the business document.
The web service consumer (external application) is responsible for preventing accidental changes to business documents.
Request node elements with cardinality > 1 contain an object node sender technical identifier to relate response message elements and log items to corresponding node elements in the request message.
The object node sender technical identifiers are provided as ObjectNodeSenderTechnicalID in request message types and referred to as ReferenceObjectNodeSenderTechnicalID in corresponding response message types.
If the object node sender technical ID is initial, the object node sender technical ID of the parent node element in the request is returned as the reference object node sender technical ID. If the object node sender technical IDs of all parent node elements are initial, the reference object node sender technical ID is returned as initial as well.
Note: The values specified in the ObjectNodeSenderTechnicalID are transient values that establish the correspondence between elements for only a single call. The web service consumer is not required to specify them or to use the same values for different calls. Also, the service provider does not interpret these values at all, but returns them to the web service consumer instead in the ReferenceObjectNodeSenderTechnicalID elements.
Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.
Request
<Child> <ObjectNodeSenderTechnicalID>999_A<ObjectNodeSenderTechnicalID> <Content>Child A: Some correct content</Content> </Child> <Child> <ObjectNodeSenderTechnicalID>999_B<ObjectNodeSenderTechnicalID> <Content>Child B: Some erroneous content</Content> </Child>
Response:
<Log> <Item> <ReferenceObjectNodeSenderTechnicalID>999_B </ReferenceObjectNodeSenderTechnicalID> <Note>Error message for Child B</Note> </Item> </Log>
The structure of the response message consists of two parts:
• A business document-specific part containing information about IDs and UUIDs of the created and changed business documents
• Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request
Many external applications consuming web services have special requirements and restrictions regarding the format of WSDLs. Some external applications require service definition WSDLs describing the web service signature. This is normally sufficient for the creation of static client-side proxies. Other external applications, normally those that do not create static client-side proxies, require binding WSDLs including the endpoint definition and authentication policy information.
In both cases, it may be the case that the external application imposes special restrictions on the structure or the size of WSDLs.
Microsoft InfoPath requires binding WSDLs and considers elements with the attribute "minOccurs=0" as "mandatory". However "minOccurs=0" means "optional" in SAP web services. In order to circumvent this problem, the WSDL must be saved locally and an additional attribute "nillable=true" must be added to make a query parameter optional for Microsoft InfoPath.
For very small clients such as mobile devices, the size of the WSDL itself may become a problem. In most cases the client only requires a very small part of the signature, but due to the complexity of the WSDL they may end up with long runtime during serialization of the request or deserialization of the response. In order to circumvent this problem, the WSDL must be saved locally and the optional parts of the signature have to be removed before the WSDL is imported or static client-side proxies are generated.
External applications have to take into account that web service request and response message types can be enhanced with additional elements and attributes. Enhancements can be created by SAP, SAP partners, and key users. Enhancements of request message types are always optional elements or attributes. The SAP system does not require the external application to provide values in the request. Enhancements of response message types can contain mandatory elements or attributes. The external application must be able to process the extended response successfully.
XML element and attribute names are always stable. Technical definitions of data types can be enhanced in a compatible way. This may result in changed data type names. External applications can rely on XML element names and attribute names, but should not rely on data type names.
Note: You can download the WSDL file for any web service here:
• Application and User Management work center -> Input Output Management -> Communication Arrangement.
• User Management work center -> Service Explorer view.
You can find the documentation of the global data types in the SAP Community Network: Go to http://scn.sap.com/docs/DOC-17516 and click View Document.
Maintain Bundle operations enable external applications to create and change business document data. Check Maintain Bundle operations enable external applications to simulate maintain bundle requests without changing business document data.
In particular, Check Maintain Bundle operations have the following functions:
• Return system messages similar to corresponding Maintain_ Bundle operation
• Provide the same message type as the corresponding Maintain_ Bundle operation
• Does not assign internal numbers from a "productive' number range interval (number range status are not increased)
• Does not change business documents
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.Following are the existing action codes and their description.
| Action Code | Description |
|---|---|
| 01 | Create; the system returns an error message if the node element already exists. |
The processing of node elements with cardinality > 1 (for example a list of descriptions in different languages or a list of telephone numbers) can be controlled using List Complete Transmission Indicators (LCTI). The LCTI indicates whether a list of node elements is transmitted completely. The LCTI of a node element with cardinality > 1 is modeled as an attribute of its parent node element (attribute name: <name of child element>ListCompleteTransmissionIndicator).
| LCTI | Description |
|---|---|
| false | The list of node elements is not transmitted completely and hence all node elements that are not transmitted remain unchanged. If transmitted node elements in the list can be identified uniquely, the system processes the node elements according the action code. If transmitted node elements in the list cannot be identified uniquely, the system appends the node element to the corresponding list of node elements in the target business document. |
| true | The list of elements is transmitted completely and hence all node elements that are not transmitted are removed. If no node element is transmitted, the complete list is removed. |
Default list complete transmission indicator: false.
Note: The LCTI refers to the completeness of the list of node elements and does not state completeness of sub-elements.
New description with language code DE (German) is created while an existing description with language code EN (English) is updated. Moreover, an existing description with language code FR (French) remains unchanged and any other description (with language code ES (Spanish), for example) is deleted. An error is raised if there is already a German description or if the English or French description does not exist.
<Root actionCode="04" descriptionListCompleteTransmissionIndicator="true" >
<Description actionCode="01">
<Description languageCode="DE">neuer deutscher Text
</Description>
<Description actionCode="02">
<Description languageCode="EN">changed english text
</Description>
<Description actionCode="06">
<Description languageCode="FR"></Description>
</Description>
</Root>
Optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents.
Maintain bundle and check maintain bundle operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer is responsible for ensuring reasonable sizes of data for mass operations.
Maintain bundle and check maintain bundle operations support exactly one execution (idem potency). To ensure exactly one execution of web service requests, the web service consumer has to provide unique values for the elements ID or UUID of the BasicMessageHeader node element.
Using change state identifier (element name ChangeStateID), external applications can enforce that a modifying operation is not executed because the state of the business document has changed since the external application last read its data.
The change state ID is an uninterpretable string that is provided by query and read operations and can be utilized by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. If the change state ID is not provided by the web service consumer, the system performs the web service operation without checking the state of the business document.
The web service consumer (external application) is responsible for preventing accidental changes to business documents.
Request node elements with cardinality > 1 contain an object node sender technical identifier to relate response message elements and log items to corresponding node elements in the request message.
The object node sender technical identifiers are provided as ObjectNodeSenderTechnicalID in request message types and referred to as ReferenceObjectNodeSenderTechnicalID in corresponding response message types.
If the object node sender technical ID is initial, the object node sender technical ID of the parent node element in the request is returned as the reference object node sender technical ID. If the object node sender technical IDs of all parent node elements are initial, the reference object node sender technical ID is returned as initial as well.
Note: The values specified in the ObjectNodeSenderTechnicalID are transient values that establish the correspondence between elements for only a single call. The web service consumer is not required to specify them or to use the same values for different calls. Also, the service provider does not interpret these values at all, but returns them to the web service consumer instead in the ReferenceObjectNodeSenderTechnicalID elements.
Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.
Request
<Child> <ObjectNodeSenderTechnicalID>999_A<ObjectNodeSenderTechnicalID> <Content>Child A: Some correct content</Content> </Child> <Child> <ObjectNodeSenderTechnicalID>999_B<ObjectNodeSenderTechnicalID> <Content>Child B: Some erroneous content</Content> </Child>
Response:
<Log> <Item> <ReferenceObjectNodeSenderTechnicalID>999_B </ReferenceObjectNodeSenderTechnicalID> <Note>Error message for Child B</Note> </Item> </Log>
The structure of the response message consists of two parts:
• A business document-specific part containing information about IDs and UUIDs of the created and changed business documents
• Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request
Many external applications consuming web services have special requirements and restrictions regarding the format of WSDLs. Some external applications require service definition WSDLs describing the web service signature. This is normally sufficient for the creation of static client-side proxies. Other external applications, normally those that do not create static client-side proxies, require binding WSDLs including the endpoint definition and authentication policy information.
In both cases, it may be the case that the external application imposes special restrictions on the structure or the size of WSDLs.
Microsoft InfoPath requires binding WSDLs and considers elements with the attribute "minOccurs=0" as "mandatory". However "minOccurs=0" means "optional" in SAP web services. In order to circumvent this problem, the WSDL must be saved locally and an additional attribute "nillable=true" must be added to make a query parameter optional for Microsoft InfoPath.
For very small clients such as mobile devices, the size of the WSDL itself may become a problem. In most cases the client only requires a very small part of the signature, but due to the complexity of the WSDL they may end up with long runtime during serialization of the request or deserialization of the response. In order to circumvent this problem, the WSDL must be saved locally and the optional parts of the signature have to be removed before the WSDL is imported or static client-side proxies are generated.
External applications have to take into account that web service request and response message types can be enhanced with additional elements and attributes. Enhancements can be created by SAP, SAP partners, and key users. Enhancements of request message types are always optional elements or attributes. The SAP system does not require the external application to provide values in the request. Enhancements of response message types can contain mandatory elements or attributes. The external application must be able to process the extended response successfully.
XML element and attribute names are always stable. Technical definitions of data types can be enhanced in a compatible way. This may result in changed data type names. External applications can rely on XML element names and attribute names, but should not rely on data type names.
Note: You can download the WSDL file for any web service here:
• Application and User Management work center -> Input Output Management -> Communication Arrangement.
• User Management work center -> Service Explorer view.
You can find the documentation of the global data types in the SAP Community Network: Go to http://scn.sap.com/docs/DOC-17516 and click View Document.
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
Possible scenarios include the following:
• Create one or many of Goods And Service Acknowledgment
• Post one or many numbers of Goods And Service Acknowledgment
| Description | Read goods and service acknowledgement |
| Name | ManageGSAInRead |
| Synchronous | yes |
| Release Status | Released |
To read the data of one or more GSA.
The request message of the operation ReadGSA contains a GSA node element that contains the GSA ID and UUID. The GSA node can occur multiple times in the request message – this means that multiple GSA can be read.
The detailed structure of the GSA node response will be explained in the following sub chapters.
Example: Read Goods and Service Acknowledgment with ID 48
Web service request
<n0:GSAByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <GoodsAndServiceAcknowledgement> <ID>48</ID> </GoodsAndServiceAcknowledgement> </n0:GSAByIDQuery_sync>
Web service response
<n0:GSAByIDResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QCH:/1SAI/TAE4E6439D37DD5DF4A0B07:804"> <GoodsAndServiceAcknowledgement> <GSAID>48</GSAID> <GSAUUID>00163e06-58b8-1ed8-90a4-f28e41679239</GSAUUID> <PostingDate>2018-04-16</PostingDate> <GSAStatus> <LifeCycleStatusCode>5</LifeCycleStatusCode> <ApprovalStatusCode>2</ApprovalStatusCode> <CancellationStatusCode>1</CancellationStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> <GoodsReturnStatusCode>1</GoodsReturnStatusCode> <ReleaseStatusCode>3</ReleaseStatusCode> </GSAStatus> <SupplierParty> <PartyUUID>00163e06-58b8-1ed8-90a4-f28e4167f239</PartyUUID> <PartyTypeCode>266</PartyTypeCode> <PartyKey> <PartyTypeCode>147</PartyTypeCode> <PartyID>MC2000</PartyID> </PartyKey> </SupplierParty> <BuyerParty> <PartyUUID>00145ef5-88e6-02db-b8b3-ac44715e0cc1</PartyUUID> <PartyTypeCode>154</PartyTypeCode> <PartyKey> <PartyTypeCode>200</PartyTypeCode> <PartyID>MC10000</PartyID> </PartyKey> </BuyerParty> <POID>104</POID> <Item> <ItemID>1</ItemID> <ItemUUID>00163e06-58b8-1ed8-90a4-f3717985923a</ItemUUID> <TypeCode>18</TypeCode> <Description>Logitech Keyboard K120</Description> <Quantity unitCode="EA">1.0</Quantity> <QuantityTypeCode>EA</QuantityTypeCode> <NetAmount currencyCode="USD">10.0</NetAmount> <NetUnitPrice> <Amount currencyCode="USD">10.0</Amount> <BaseQuantity unitCode="EA">1.0</BaseQuantity> <BaseQuantityTypeCode>EA</BaseQuantityTypeCode> </NetUnitPrice> <ShipToLocation> <LocationUUID>00163e06-58b8-1ed8-90a4-f3717987523a</LocationUUID> </ShipToLocation> <RequestorParty> <PartyKey> <PartyID>MC0678</PartyID> </PartyKey> </RequestorParty> <ProductRecipientParty> <PartyKey> <PartyID>MC0678</PartyID> </PartyKey> </ProductRecipientParty> <DeliveryPeriod> <StartDateTime timeZoneCode=" ">2018-04-15T04:00:00Z</StartDateTime> <EndDateTime timeZoneCode=" ">2018-04-16T04:00:00Z</EndDateTime> </DeliveryPeriod> <ItemAccountingCodingBlockDistribution> <ValidityDate>2018-04-16</ValidityDate> <CompanyID>MC10000</CompanyID> <TotalAmount currencyCode="USD">10.0</TotalAmount> <TotalQuantity unitCode="EA">1.0</TotalQuantity> <AccountingCodingBlockAssignment> <Percent>100.0</Percent> <Amount currencyCode="USD">10.0</Amount> <Quantity unitCode="EA">1.0</Quantity> <AccountingCodingBlockTypeCode>CC</AccountingCodingBlockTypeCode> <CostCentreID>MC22000</CostCentreID> <CompanyID>MC10000</CompanyID> </AccountingCodingBlockAssignment> </ItemAccountingCodingBlockDistribution> <PurchaseOrderReference> <BusinessTransactionDocumentReference> <ID>104</ID> <ItemID>1</ItemID> </BusinessTransactionDocumentReference> </PurchaseOrderReference> </Item> <ChangeStateID> </ChangeStateID> </GoodsAndServiceAcknowledgement> <Log/> </n0:GSAByIDResponse_sync>
The request message of the Read GSA operation contains the following two elements:
ID: Internal ID of the GSA
UUID: UUID of the GSA
The structure of the response message contains all the data from GSA business object. Following is the structure of response message:
The GSA node elements contain all general information such as ID, names, TypeCode and business partners. The data of this node is related to the General Data on the GSA UI.
TypeCode : The type code determines the business object. GSA is identified with type code 282.
GSA ID is the internal ID with which the GSA can be addressed and found.
CurrencyCode is the currency in which the purchase is made.
Date is the posting date of GSA.
Total Net Value: This is the net value of GSA when the values of all items is added.
At header level of GSA following four types of parties are important:
BuyerParty: This is the buying company
Employee Responsible Party: The Purchaser who is requesting the purchase document.
Delivery note ID: outbound delivery note ID for GSA.
PO reference ID: original PO number which GSA comes from
Seller Party: The supplier to whom the Purchase document is raised.
Following are the common party type codes existing in the system:
| Party Type Code | Description |
|---|---|
| 154 | Company (Buyer Party |
| 410 | Purchasing Unit |
| 266 | Supplier |
| 167 | Employee |
The AttachmentFolder node element can be used to add and remove GSA attachments. Data for this node can be found on the GSA UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:
| Category Code | Description |
|---|---|
| 2 | Document |
| 3 | Link |
The different types of attachments are differentiated by the TypeCode
| TypeCode | Description |
|---|---|
| 10001 | Standard Attachment |
| 10068 | Internal Attachment |
To create link attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 3 |
| TypeCode | None |
| AlternativeName | <Document Title> |
| ExternalLinkWebURI | <link URI> |
| Description | <comment> |
To create file attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 2 |
| TypeCode | None |
| Name | <Document Title> |
| AlternativeName | <Document Title> |
| Description | <comment> |
This node is used to maintain Notes on GSA Header or Item Level. There are different types of notes supported in GSA:
| TypeCode | Description |
|---|---|
| 10011 | Internal comment from the Purchase |
| 10014 | Remark for Supplier |
| 10015 | Remark from Supplier |
| 10029 | Approval Note |
This node has information relevant for the GSA items like the product, quantity, price, various item statuses, quantity delivered, quantity invoiced etc. The attributes here can be seen on the Items view of the Purchase Order UI.
Following are some of the important attributes on Item node:
Item ID: This is the serial no of the items in GSA and is unique.
Delivered Quantity: This attribute provides the actual quantity that is delivered by the supplier. It is stored in the Item Actual Value node of GSA
Delivery Period: This is the time frame in which the goods must be delivered
Customer: Customer which an item should be delivered to.
PurchaseOrderReference:
Original PO number and item number that GSA's item corresponds to.
There are multiple parties that are relevant at item level. Each item can be delivered to a different address and hence the address is derived from the parties or location at item level. Following parties and type codes are important at item level:
| PartyTypeCode | Description| |
|---|---|
| 167 | Requester or Recipient or Service Agent |
| 159 | End Buyer (Customer) |
Location Codes applicable for GSA are
| TypeCode | Description |
|---|---|
| 1 | Ship To Location |
| 2 | Ship From Location |
| 3 | Receiving Location |
The node contains the cost assignment of the GSA item. The cost can be assigned to following types of cost objects:
| TypeCode | Description |
|---|---|
| CC | Cost Center |
| ACC | General Ledger |
| IMAT | Individual Material |
| PRO | Project Task |
| SLS | Sales Order |
| SRV | Service Order |
The GSA IDs should be without leading zeros.
| Release | Change Description | Details |
| 1808 | Documentation change | Service Interfaces and Operation, Structure of request message and response message, Example of payload updates |
| Description | Maintain goods and service acknowledgement |
| Name | ManageGSAInMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To create Goods And Service Acknowledgment in Business ByDesign system.
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a GSA node element that contains the GSA data to be created. The detailed structure of the GSA node will be explained in the following sub-chapters. The GSA node can occur multiple times in the request message – this means that multiple GSA can be created and updated through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a GSA-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as GSA InternalID and UUID.
Example: Create a Goods and Service Acknowledgment refer to Purchase Order 113
Web service request
<n0:GSABundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader/> <GoodsAndServiceAcknowledgement actionCode="01"> <BusinessTransactionDocumentTypeCode>282</BusinessTransactionDocumentTypeCode> <Name languageCode="EN">Test GSA A2X</Name> <Date>2018-04-16</Date> <PostGSAIndicator>true</PostGSAIndicator> <POReferenceID ActionCode="01"> <BusinessTransactionDocumentReference> <ID>113</ID> <TypeCode>001</TypeCode> </BusinessTransactionDocumentReference> </POReferenceID> <Company actionCode="01"> <PartyKey> <PartyTypeCode>200</PartyTypeCode> <PartyID>MC10000</PartyID> </PartyKey> </Company> <Supplier actionCode="01"> <PartyKey> <PartyTypeCode>147</PartyTypeCode> <PartyID>MC2000</PartyID> </PartyKey> </Supplier> <Item> <BusinessTransactionDocumentTypeCode ItemImatListCompleteTransmissionIndicator="true" actionCode="01">19</BusinessTransactionDocumentTypeCode> <Quantity unitCode="EA">1</Quantity> <QuantityTypeCode>EA</QuantityTypeCode> <ShipToLocation actionCode="01"> <LocationID>MC64000</LocationID> </ShipToLocation> <RequestorParty actionCode="01"> <PartyKey> <PartyID>MC0678</PartyID> </PartyKey> </RequestorParty> <ProductRecipientParty actionCode="01"> <PartyKey> <PartyID>MC10000</PartyID> </PartyKey> </ProductRecipientParty> <DeliveryPeriod> <StartDateTime>2018-04-16T03:15:32.0000000Z</StartDateTime> <EndDateTime>2018-04-30T03:15:32.0000000Z</EndDateTime> </DeliveryPeriod> <PurchaseOrderReference ActionCode="01"> <BusinessTransactionDocumentReference> <ID>113</ID> <TypeCode>001</TypeCode> <ItemID>1</ItemID> <ItemTypeCode>18</ItemTypeCode> </BusinessTransactionDocumentReference> </PurchaseOrderReference> </Item> </GoodsAndServiceAcknowledgement> </n0:GSABundleMaintainRequest_sync>
Web service response
<n0:GSABundleMaintainConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QCH:/1SAI/TAEF5329A62AF887EA3E5E0:804"> <GoodsAndServiceAcknowledgement> <ChangeStateID> 20180416033825.0000000</ChangeStateID> <BusinessTransactionDocumentID>48</BusinessTransactionDocumentID> <UUID>00163e06-58b8-1ed8-90a4-f28e41679239</UUID> </GoodsAndServiceAcknowledgement> </n0:GSABundleMaintainConfirmation_sync>
Structure of the request message has the following nodes and elements:
The GSA node elements contain all general information such as ID, names, TypeCode and business partners. The data of this node is related to the General Data on the GSA UI.
Business Transaction TypeCode : The type code determines the business object. GSA is identified with type code 282.
GSA ID is the internal ID with which the GSA can be addressed and found.
PO Reference ID is the PO which GSA is created based on.
CurrencyCode is the currency in which the purchase is made.
Posting Date is the creation date of GSA.
Post GSA is an indicator and should be set to trigger Submit for approval action on GSA
At header level of GSA following four types of parties are important:
BuyerParty: This is the buying company
Employee Responsible Party: The Purchaser
Seller Party: The supplier to whom the original purchase document is raised.
Following are the common party type codes existing in the system:
| Party Type Code | Description |
|---|---|
| 154 | Company (Buyer Party) |
| 410 | Purchasing Unit |
| 266 | Supplier |
| 167 | Employee |
The AttachmentFolder node element can be used to add and remove Purchase GSA attachments. Data for this node can be found on the GSA UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:
| Category Code | Description |
|---|---|
| 2 | Document |
| 3 | Link |
The different types of attachments are differentiated by the TypeCode
| TypeCode | Description |
|---|---|
| 10001 | Standard Attachment |
| 10068 | Internal Attachment |
To create link attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 3 |
| TypeCode | None |
| AlternativeName | <Document Title> |
| ExternalLinkWebURI | <link URI> |
| Description | <comment> |
To create file attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 2 |
| TypeCode | None |
| Name | <Document Title> |
| AlternativeName | <Document Title> |
| Description | <comment> |
This node is used to maintain Notes on GSA Header or Item Level. There are different types of notes supported in GSA:
| TypeCode | Description |
|---|---|
| 10011 | Internal comment from the Purchase |
| 10014 | Remark for Supplier |
| 10015 | Remark from Supplier |
| 10029 | Approval Note |
This node has information relevant for the GSA items like the product, quantity, price, various item statuses. The attributes here can be seen on the Items view of the GSA UI.
Following are some of the important attributes on Item node:
Item ID: This is the serial no of the item in GSA and is unique.
Delivery Quantity: This is the Quantity which the goods must be delivered
There are multiple parties that are relevant at item level. Each item can be delivered to a different address and hence the address is derived from the parties or location at item level. Following parties and type codes are important at item level:
| PartyTypeCode | Description| |
|---|---|
| 167 | Requester or Recipient or Service Agent |
| 159 | End Buyer (Customer) |
Location Codes applicable for GSA are
| TypeCode | Description |
|---|---|
| 1 | Ship To Location |
| 2 | Ship From Location |
| 3 | Receiving Location |
The node contains the cost assignment of the GSA item. The cost can be assigned to following types of cost objects:
| TypeCode | Description |
|---|---|
| CC | Cost Center |
| ACC | General Ledger |
| IMAT | Individual Material |
| PRO | Project Task |
| SLS | Sales Order |
| SRV | Service Order |
GSA ID and UUID
Change State ID and Sender Technical ID
Log: Containing the error messages from the processing of the request.
<n0:GSABundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<GoodsAndServiceAcknowledgement actionCode="01">
<BusinessTransactionDocumentTypeCode>282</BusinessTransactionDocumentTypeCode>
<Name languageCode="EN">Test GSA Z001</Name>
<PostGSAIndicator>true</PostGSAIndicator>
<POReferenceID ActionCode="01">
<BusinessTransactionDocumentReference>
<ID>1032</ID>
</BusinessTransactionDocumentReference>
</POReferenceID>
</GoodsAndServiceAcknowledgement>
</n0:GSABundleMaintainRequest_sync>
<n0:GSABundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<GoodsAndServiceAcknowledgement actionCode="01">
<BusinessTransactionDocumentTypeCode>282</BusinessTransactionDocumentTypeCode>
<Name languageCode="EN">Test GSA Z001</Name>
<PostGSAIndicator>true</PostGSAIndicator>
<Item>
<BusinessTransactionDocumentTypeCode ItemImatListCompleteTransmissionIndicator="true" actionCode="01">18</BusinessTransactionDocumentTypeCode>
<Quantity>2</Quantity>
<QuantityTypeCode>EA</QuantityTypeCode>
<PurchaseOrderReference ActionCode="01">
<BusinessTransactionDocumentReference>
<ID>1081</ID>
<TypeCode>001</TypeCode>
<ItemID>1</ItemID>
<ItemTypeCode>18</ItemTypeCode>
</BusinessTransactionDocumentReference>
</PurchaseOrderReference>
</Item>
<Item>
<BusinessTransactionDocumentTypeCode ItemImatListCompleteTransmissionIndicator="true" actionCode="01">19</BusinessTransactionDocumentTypeCode>
<Quantity>2</Quantity>
<QuantityTypeCode>HUR</QuantityTypeCode>
<PurchaseOrderReference ActionCode="01">
<BusinessTransactionDocumentReference>
<ID>1081</ID>
<TypeCode>001</TypeCode>
<ItemID>2</ItemID>
<ItemTypeCode>19</ItemTypeCode>
</BusinessTransactionDocumentReference>
</PurchaseOrderReference>
</Item>
</GoodsAndServiceAcknowledgement>
</n0:GSABundleMaintainRequest_sync>
| Release | Change Description | Details |
| 1808 | Documentation change | Service Interfaces and Operation, Structure of request message and response message, Example of payload updates |
| Description | Check goods and service acknowledgement |
| Name | ManageGSAInCheckMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To simulate the MAINTAIN_BUNDLE service interface operation of Goods And Service Acknowledgment.
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a GSA node element that contains the GSA data to be created. The detailed structure of the GSA node will be explained in the following sub-chapters. The GSA node can occur multiple times in the request message – this means that multiple GSA can be created and updated through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a GSA-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as GSA InternalID and UUID
Here is an example of a simple web service request:
Web service request
<n0:GSABundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader/> <GoodsAndServiceAcknowledgement actionCode="01"> <BusinessTransactionDocumentTypeCode>282</BusinessTransactionDocumentTypeCode> <Name languageCode="EN">Test GSA A2X</Name> <Date>2018-04-16</Date> <PostGSAIndicator>true</PostGSAIndicator> <POReferenceID ActionCode="01"> <BusinessTransactionDocumentReference> <ID>113</ID> <TypeCode>001</TypeCode> </BusinessTransactionDocumentReference> </POReferenceID> <Company actionCode="01"> <PartyKey> <PartyTypeCode>200</PartyTypeCode> <PartyID>MC10000</PartyID> </PartyKey> </Company> <Supplier actionCode="01"> <PartyKey> <PartyTypeCode>147</PartyTypeCode> <PartyID>MC2000</PartyID> </PartyKey> </Supplier> <Item> <BusinessTransactionDocumentTypeCode ItemImatListCompleteTransmissionIndicator="true" actionCode="01">19</BusinessTransactionDocumentTypeCode> <Quantity unitCode="EA">1</Quantity> <QuantityTypeCode>EA</QuantityTypeCode> <ShipToLocation actionCode="01"> <LocationID>MC64000</LocationID> </ShipToLocation> <RequestorParty actionCode="01"> <PartyKey> <PartyID>MC0678</PartyID> </PartyKey> </RequestorParty> <ProductRecipientParty actionCode="01"> <PartyKey> <PartyID>MC10000</PartyID> </PartyKey> </ProductRecipientParty> <DeliveryPeriod> <StartDateTime>2018-04-16T03:15:32.0000000Z</StartDateTime> <EndDateTime>2018-04-30T03:15:32.0000000Z</EndDateTime> </DeliveryPeriod> <PurchaseOrderReference ActionCode="01"> <BusinessTransactionDocumentReference> <ID>113</ID> <TypeCode>001</TypeCode> <ItemID>1</ItemID> <ItemTypeCode>18</ItemTypeCode> </BusinessTransactionDocumentReference> </PurchaseOrderReference> </Item> </GoodsAndServiceAcknowledgement> </n0:GSABundleMaintainRequest_sync>
Web service response
<n0:GSABundleMaintainConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QCH:/1SAI/TAEF5329A62AF887EA3E5E0:804"> <GoodsAndServiceAcknowledgement> <ChangeStateID> 20180416033825.0000000</ChangeStateID> <BusinessTransactionDocumentID>##1</BusinessTransactionDocumentID> <UUID>00163e06-58b8-1ed8-90a4-f28e41679239</UUID> </GoodsAndServiceAcknowledgement> </n0:GSABundleMaintainConfirmation_sync>
Structure of the request message has the following nodes and elements
The GSA node elements contain all general information such as ID, names, TypeCode and business partners. The data of this node is related to the General Data on the GSA UI.
Business Transaction TypeCode : The type code determines the business object. GSA is identified with type code 282.
GSA ID is the internal ID with which the GSA can be addressed and found.
PO Reference ID is the PO which GSA is created based on.
CurrencyCode is the currency in which the purchase is made.
Posting Date is the creation date of GSA.
Post GSA is an indicator and should be set to trigger Submit for approval action on GSA
At header level of GSA following four types of parties are important:
BuyerParty: This is the buying company
Employee Responsible Party: The Purchaser
Seller Party: The supplier to whom the original purchase document is raised.
Following common party type codes exist in the system:
| Party Type Code | Description |
|---|---|
| 154 | Company (Buyer Party |
| 410 | Purchasing Unit |
| 266 | Supplier |
| 167 | Employee |
The AttachmentFolder node element can be used to add and remove Purchase GSA attachments. Data for this node can be found on the GSA UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:
| Category Code | Description |
|---|---|
| 2 | Document |
| 3 | Link |
The different types of attachments are differentiated by the TypeCode
| TypeCode | Description |
|---|---|
| 10001 | Standard Attachment |
| 10068 | Internal Attachment |
To create link attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 3 |
| TypeCode | None |
| AlternativeName | <Document Title> |
| ExternalLinkWebURI | <link URI> |
| Description | <comment> |
To create file attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 2 |
| TypeCode | None |
| Name | <Document Title> |
| AlternativeName | <Document Title> |
| Description | <comment> |
This node is used to maintain Notes on GSA Header or Item Level. There are different types of notes supported in GSA:
| TypeCode | Description |
|---|---|
| 10011 | Internal comment from the Purchase |
| 10014 | Remark for Supplier |
| 10015 | Remark from Supplier |
| 10029 | Approval Note |
This node has information relevant for the GSA items like the product, quantity, price, various item statuses. The attributes here can be seen on the Items view of the GSA UI.
Following are some of the important attributes on Item node:
Item ID: This is the serial no of the item in GSA and is unique.
Delivery Quantity: This is the Quantity which the goods must be delivered
There are multiple parties that are relevant at item level. Each item can be delivered to a different address and hence the address is derived from the parties or location at item level. Following parties and type codes are important at item level:
| PartyTypeCode | Description| |
|---|---|
| 167 | Requester or Recipient or Service Agent |
| 159 | End Buyer (Customer) |
Location Codes applicable for GSA are
| TypeCode | Description |
|---|---|
| 1 | Ship To Location |
| 2 | Ship From Location |
| 3 | Receiving Location |
The node contains the cost assignment of the GSA item. The cost can be assigned to following types of cost objects:
| TypeCode | Description |
|---|---|
| CC | Cost Center |
| ACC | General Ledger |
| IMAT | Individual Material |
| PRO | Project Task |
| SLS | Sales Order |
| SRV | Service Order |
GSA ID and UUID
Change State ID and Sender Technical ID
Log: Containing the error messages from the processing of the request.
| Release | Change Description | Details |
| 1808 | Documentation change | Service Interfaces and Operation, Structure of request message and response message, Example of payload updates |
| 1808 | Reference Field Bundle | RFB created for extension enablement |