Show full documentation

 Show full documentation

Definition

An interface to query and read goods and activity confirmations.

Business Context and Use

The web service Query Goods And Activity Confirmation In enables you to connect external applications to your SAP Business ByDesign system and query and read goods and activity confirmations in your system.

The web service interface is relevant if your company wants to access goods and activity confirmation data from external applications.

The web service Query Goods And Activity Confirmation In offers the operation FindInventoryChangeItemOverviewSimpleByElements.

Here is an example of a simple web service request.

<n0:GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleSelectionByElements>
  <SelectionByInventoryItemChangeMainInventorySeparatingValuesMaterialKeyProductID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryProductID>MCF-0001</LowerBoundaryProductID>
  </SelectionByInventoryItemChangeMainInventorySeparatingValuesMaterialKeyProductID>
 </GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>200</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
 </ProcessingConditions>
</n0:GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleByElementsQuery_sync>

The above sample request queries the goods and activity confirmation items with Product ID MCF-0001.

Prerequisites

Existence of referenced business documents:

The following business documents are only queried and will not be created by the service operations:

• Goods and activity confirmations

They must already exist in the system when the web service is called.

More Information

Goods and Activity Confirmation

Scenarios

The following example scenarios can be carried out using the goods and activity confirmation query service.

• The following example request returns all goods and activity confirmation items created in the inventory managed locations MC67320 and MC64920. Only a maximum of 20 entries will be returned.

<n0:GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleSelectionByElements>
  <SelectionByInventoryLocationLocationID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryLocationID>MC64920</LowerBoundaryLocationID>
  </SelectionByInventoryLocationLocationID>
  <SelectionByInventoryLocationLocationID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryLocationID>MC67320</LowerBoundaryLocationID>
  </SelectionByInventoryLocationLocationID>
  </GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>20</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
 </ProcessingConditions>
</n0:GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleByElementsQuery_sync>

• The following example request returns all the goods and activity confirmation items with the ID of the document between 1 and 150 and the change reason code 3 (scrapping) (The possible values of the code are: 1 - Initial Balance Setting, 10 - Inventory Alignment, 11 - Third-Party Direct Ship, 12 - Returns of Non-Consumed Goods, 13 - Issue for Point-of-Sale, 14 - Issue for Customer, 15 - Return to Supplier, 16 - Pickup for Service, 17 - Pre-delivery for Service, 18 - Issue to Transit, 19 - Returns for Point-of-Sale, 3 - Scrapping, 4 - Disruptive Sampling, 5 - Inventory Difference, 6 - Consumption, 7 - Transfer, 8 - Issue for Service). All the results fetched will be returned.

<n0:GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleSelectionByElements>
  <SelectionByConfirmationID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>3</IntervalBoundaryTypeCode>
   <LowerBoundaryConfirmationID>1</LowerBoundaryConfirmationID>
   <UpperBoundaryConfirmationID>150</UpperBoundaryConfirmationID>
  </SelectionByConfirmationID>
  <SelectionByChangeReasonCode>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryChangeReasonCode>3</LowerBoundaryChangeReasonCode>
  </SelectionByChangeReasonCode>
  </GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleSelectionByElements>
 <ProcessingConditions>
  <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator>
 </ProcessingConditions>
</n0:GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleByElementsQuery_sync>

• The following example request returns all the goods and activity confirmation items with the confirmations that were created on or after 8th October 2012. Only 10 records will be fetched as specified.

<n0:GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleSelectionByElements>
  <SelectionByConfirmationCreationDateTime>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>9</IntervalBoundaryTypeCode>
   <LowerBoundaryConfirmationCreationDateTime>2012-10-07T12:00:00.0000001Z</LowerBoundaryConfirmationCreationDateTime>
  </SelectionByConfirmationCreationDateTime>
  </GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
 </ProcessingConditions>
</n0:GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleByElementsQuery_sync>

 Show full documentation

 Show full documentation

Definition

To query for one or more instances of the goods and activity confirmation based on the query filter parameters passed.

Business Context and Use

The request message of the QueryByElements operation contains the GoodsAndActivityConfirmationInventoryChangeItemOverviewSimpleSelectionByElements node that groups all possible selection parameters. This node is described in the following sub-chapter.

Structure

Request

Goods and Activity Confirmation Inventory Change Item Overview Simple Selection By Elements

This node groups all selection parameters. The selection parameters are:

Selection Parameter	Description
SelectionByInventoryLocationInventoryTypeCode	Selection by Inventory Type Code
SelectionByInventoryLocationLocationUUID	Selection by Location UUID
SelectionByInventoryLocationLocationID	Selection by ID of the Location
SelectionByInventoryLocationCustodianPartyUUID	Selection by Custodian Party UUID, in case of Custodian Stock
SelectionByInventoryLocationCustodianPartyInternalID	Selection by Custodian Party Internal ID, in case of Custodian Stock
SelectionByInventoryLocationLogisticsAreaUUID	Selection by Logistics Area UUID
SelectionByInventoryLocationLogisticsAreaKeyID	Selection by ID of Logistics Area Key
SelectionByInventoryLocationLogisticsAreaKeySiteID	Selection by ID of Logistics Area Key Site
SelectionByInventoryLocationInventoryManagedLocationUUID	Selection by Inventory Managed Location’s UUID
SelectionByInventoryLocationInventoryManagedLogisticsAreaUUID	Selection by Inventory Managed Logistics Area’s UUID
SelectionByInventoryLocationPermanentEstablishmentUUID	Selection by Permanent Establishment UUID
SelectionByInventoryItemChangeMainInventorySeparatingValuesMaterialUUID	Selection by Material UUID
SelectionByInventoryItemChangeMainInventorySeparatingValuesMaterialKeyProductTypeCode	Selection by Product Type Code
SelectionByInventoryItemChangeMainInventorySeparatingValuesMaterialKeyProductIdentifierTypeCode	Selection by Product Identifier Type code
SelectionByInventoryItemChangeMainInventorySeparatingValuesMaterialKeyProductID	Selection by Material ID
SelectionByInventoryItemChangeMainInventorySeparatingValuesOwnerPartyUUID	Selection by Owner Party UUID
SelectionByInventoryItemChangeMainInventorySeparatingValuesOwnerPartyID	Selection by Owner Party ID
SelectionByInventoryItemChangeMainInventorySeparatingValuesSupplyPlanningAreaUUID	Selection by Supply Planning Area UUID
SelectionByInventoryItemChangeMainInventorySeparatingValuesSupplyPlanningAreaID	Selection by Supply Planning Area ID
SelectionByInventoryItemChangeMainInventorySeparatingValuesInventoryRestrictedUseIndicator	Selection by Inventory Restriction Status indicator
SelectionByInventoryItemChangeIdentifiedStockInventorySeparatingValuesIdentifiedStockUUID	Selection by Identified Stock UUID
SelectionByInventoryItemChangeIdentifiedStockInventorySeparatingValuesIdentifiedStockKeyID	Selection by Identified Stock Key ID
SelectionByInventoryItemChangeSpecialStockSeparatingValuesOutboundDeliveryReferenceID	Selection by Outbound Delivery Reference ID
SelectionByInventoryItemChangeSpecialStockSeparatingValuesOutboundDeliveryReferenceUUID	Selection by Outbound Delivery Reference UUID
SelectionByInventoryItemChangeSpecialStockSeparatingValuesSiteLogisticsLotUUID	Selection by Site Logistics Lot UUID
SelectionByInventoryItemChangeSpecialStockSeparatingValuesSiteLogisticsLotID	Selection by Site Logistics Lot ID
SelectionByInventoryItemChangeDefaultRecordedQuantityUUID	Selection by UUID of the default Inventory Item Change Quantity
SelectionByChangeReasonCode	Selection by Change Reason Code. The possible values of the code are: 1 - Initial Balance Setting, 10 - Inventory Alignment, 11 - Third-Party Direct Ship, 12 - Returns of Non-Consumed Goods, 13 - Issue for Point-of-Sale, 14 - Issue for Customer, 15 - Return to Supplier, 16 - Pickup for Service, 17 - Pre-delivery for Service, 18 - Issue to Transit, 19 - Returns for Point-of-Sale, 3 - Scrapping, 4 - Disruptive Sampling, 5 - Inventory Difference, 6 - Consumption, 7 - Transfer, 8 - Issue for Service
SelectionByID	Selection by ID of Inventory Change Item
SelectionByInventoryMovementDirectionCode	Selection by the direction of the inventory movement. The various values of the code are: 1 - Inventory Issue, 2 - Inventory Receipt
SelectionByInventoryRelevanceIndicator	Selection by the Indicator that indicates whether an Inventory Change Item should be applied to the BO Inventory or not
SelectionByInventoryManagedQuantity	Selection by Inventory Managed Quantity
SelectionByInventoryManagedQuantityTypeCode	Selection by Type Code of Inventory Managed Quantity
SelectionByDefaultRecordedQuantity	Selection by Default Recorded Quantity
SelectionByDefaultRecordedQuantityTypeCode	Selection by Type Code of Default Recorded Quantity
SelectionBySiteUUID	Selection by UUID of the Site
SelectionByTransferGroupID	Selection by Transfer Group ID
SelectionByConfirmationCreationDateTime	Selection by Date and Time of Confirmation Creation
SelectionByConfirmationBusinessTransactionDateTime	Selection by Business Transaction Date and Time
SelectionByConfirmationCancellationStatusCode	Selection by Cancellation Status of the Goods and Activity Confirmation. Allowed values are 1 - Not Cancelled and 4 - Cancelled
SelectionByConfirmationCancellationDocumentIndicator	Selection by an Indicator that indicates if the goods and activity confirmation is a Cancellation Document or not.
SelectionByConfirmationCancelledConfirmationUUID	Selection by UUID of cancelled Goods and Activity Confirmation Document
SelectionByConfirmationCompanyID	Selection by ID of the Confirmation Company
SelectionByConfirmationCompanyUUID	Selection by UUID of the Confirmation Company
SelectionByConfirmationID	Selection by ID of Goods and Activity Confirmation
SelectionByConfirmationUUID	Selection by UUID of Goods and Activity Confirmation

Response

The response contains the list of found goods and activity confirmation items, log items, and processing conditions.

Response Message Attributes:

Response Parameter	Description
UUID01	UUID of Goods And Activity Confirmation document
ID02	Goods And Activity Confirmation ID
UUID03	UUID of Goods And Activity Confirmation Item
INVENTORY_LOCATION	Details of Location, Custodian Party, Logistics Area, Inventory Managed Location, Inventory Managed Logistics Area and Permanent Establishment
INVENTORY_ITEM_CHANGE	Details about Material, Owner Party, Supplier Planning Area, Restricted Indicator, Identified Stock, Outbound Delivery Reference, Site Logistics Lot and Default Recorded Quantity
CFM_ICI_CHANGE_REASON_CODE	Change Reason Code
CFM_ICI_CHANGE_REASON_NAME	Description of Change Reason Code
CFM_ICI_ID	Item ID
CFM_ICI_INV_MOVE_DIR_CODE	Inventory Movement Direction Code
CFM_ICI_INV_MOVE_DIR_CODE_NAME	Description of Inventory Movement Direction
CFM_ICI_INV_RELEVANCE_IND	Inventory Relevance Indicator
CFM_ICI_QUANTITY	Inventory Managed Quantity
CFM_ICI_QUANTITY_TYPE_CODE	Inventory Managed Quantity Type Code
CFM_ICI_QUANTITY_TYPE_NAME	Description of Inventory Managed Quantity Type
CFM_ICI_REC_QUANTITY	Default Recorded Quantity
CFM_ICI_REC_QUANTITY_TYPE_CODE	Default Recorded Quantity Type Code
CFM_ICI_REC_QUANTITY_TYPE_NAME	Description of Default Recorded Quantity Type Code
CFM_ICI_SITE_UUID	Site UUID
CFM_ICI_TRANSFER_GROUP_ID	Transfer Group ID
CFM_ROOT_CREATION_DATE_TIME	Confirmation Creation Date Time
CFM_ROOT_BUS_TRANS_DATE_TIME	Confirmation Business Transaction Date Time
CFM_ROOT_CANCELLATION_STATUS	Confirmation Cancellation Status Code
CFM_ROOT_CANCELLATION_S_NAME	Description of the Confirmation Cancellation Status Code
CFM_ROOT_CANCELLATION_DOC_IND	Confirmation Cancellation Document Indicator
CFM_ROOT_CANCELLED_CFM_UUID	UUID of the cancelled Goods and activity Confirmation document
CFM_ROOT_COMPANY_ID	Confirmation Company ID
CFM_ROOT_COMPANY_UUID	Confirmation Company UUID
CFM_ROOT_ID	Confirmation ID
CFM_ROOT_UUID	Confirmation UUID
ODL_ITEM_ID	Outbound Delivery Item ID
ODL_ITEM_UUID	Outbound Delivery Item UUID
ODL_ROOT_ID	Outbound Delivery ID
ODL_ROOT_UUID	Outbound Delivery UUID
ODL_ROOT_PROC_TYPE_CODE	Outbound Delivery Processing Type Code
ODL_ROOT_PROC_TYPE_CODE_NAME	Description of Outbound Delivery Processing Type Code
ODL_PARTY_PROD_RECIPIENT_KEY	Outbound Delivery Product Recipient Party

Additional Description

Definition

A coded representation of the reason for an inventory change.

Detailed Description

Exactly one static SAP code list is assigned to the code.

The code list and its values are provided in "Appendix - Code List".

Usage

The InventoryChangeReasonCode is used within business objects and messages to specify the business incident that caused a change of Inventory.

Integrity

None specified.

Instance Example

<InventoryChangeReasonCode>1</InventoryChangeReasonCode>

Note

None specified.

Appendix - Code List

InventoryChangeReasonCode

listID = "10516"

listAgencyID = "310"

Definition

Code	Name	Alternative Business Term	Description
1	Initial Balance Setting		The initial inventory balance has been set.
2	Receipt		Inventory has been received.
3	Scrapping		Inventory has been scrapped.
4	Disruptive Sampling		Inventory has been issued for disruptive sampling.
5	Inventory Difference		Inventory difference has been recorded by physical inventory.
6	Consumption		Inventory has been consumed with account assignment.
7	Transfer		Inventory has been moved or has changed its properties.
8	Issue for Service		Inventory has been issued within a service process.
9	Issue for Over-the-Counter Sales		Inventory has been issued within an over-the-counter sales process.
10	Inventory Alignment		Inventory has been aligned with the total of all Logistics Confirmations.
11	Third-Party Order Processing		Goods are shipped from the supplier to the customer. The change of ownership of the goods is directly from the supplier to the customer.
12	Returns of Non-Consumed Goods		Non-consumed inventory has been returned with account assignment.
13	Issue for Point-of-Sale		Inventory has been issued within a point-of-sale process.
14	Issue for Customer		Inventory has been issued to a customer.
15	Return to Supplier		Inventory has been returned to a supplier.
16	Pickup for Service		Inventory has been picked up for a service process.
17	Pre-delivery for Service		Inventory has been pre-delivered for a service process.
18	Issue to Transit		Inventory has been issued to transit stock (intra company stock transfer).
19	Returns for Point Of Sale		Inventory has been returned within a point-of-sale process.
20	Alignment with External Warehouse Stock		Inventory has been reconciled with external warehouse stock.
21	Receipt for Purchase Order		Inventory has been received for a purchase order.
22	Returns from Customer		Inventory has been returned from a customer.
23	Receipt from Transit		Inventory has been received from transit stock.
24	Third-Party Order Processing – Returns		Goods are returned from the customer to the supplier. The returned goods can be temporarily managed in the externally-owned stock of the selling company before being passed on to the original supplier. That is, the change of ownership is directly from the customer to the supplier.
25	Return to Customer		Goods owned by the customer are returned to the customer. Example: If goods have been returned for repair, they remain the property of the customer – here no change of ownership takes place. Once they have been repaired, the goods are returned to the customer.