SAP BusinessHub

1/30/2023
APIs for Sourcing and Procurement

Generated on: 2023-01-30 15:24:19 GMT+0000
SAP S/4HANA Cloud | 2302
PUBLIC
Original content: https://help.sap.com/docs/SAP_S4HANA_CLOUD/bb9f1469daf04bd894ab2167f8132a1a?locale=en-

US&state=PRODUCTION&version=2302.500
Warning
This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
Portal, and may be missing important aspects and/or correlations to other topics. For this reason, it is not for productive use.
For more information, please visit the https://help.sap.com/docs/disclaimer.
This is custom documentation. For more information, please visit the SAP Help Portal 1
1/30/2023
Purchase Order
Purchase Order (OData V2)
Use
Technical name: API_PURCHASEORDER_PROCESS_SRV
Create, update or delete purchase orders using this synchronous service.
The service is based on the OData protocol and can be consumed in SAP Fiori apps and on other user interfaces.
The OData service supports the purchase order type Standard ("NB") and any customer-de ned purchase order type ("ZNB*")
that has been copied with all dependent entries from purchase order type "NB".
The service supports the following purchase order item categories:
Purchase Order Item Category Internal Symbol* External Symbol**
Standard 0 ' ' (=blank)
Subcontracting 3 L
Third- Party 5 S
Enhanced Limits (for materials or lean services) A E
Consignment 2 K
* Enter the required purchase order item category using the internal symbol.
** The external symbol is displayed, for example, in the app Create Purchase Order - Advanced.
This service is published on the SAP API Business Hub. For more information about APIs, see APIs on SAP API Business Hub.
Service Structure
The data model of the OData service contains header, item, account assignment, schedule line (including subcontracting), and
pricing nodes.
The following actions are supported:
Create: The information is sent in the request as a payload. All information is used when creating a purchase order,
including appropriate checks for restricted values and authorizations. Once the purchase order has been created, the
purchase order number is sent in the response with the data included in the purchase order. If there are any issues when
the purchase order is created, the system displays error messages in the response. Note that the action can be
executed to create a purchase order or a purchase order item.
External number assignment is available for the creation of purchase order items. If the number of the purchase order
item is not de ned externally, it is generated automatically.
Update: All information is sent in the request as a payload via a single or batch call, and is updated to the existing
purchase order with the appropriate checks in place for restricted values and authorizations. If the request is a batch call
1/30/2023
which comprises one or more change sets, then each change set must contain information related to one purchase
order. In each change set, use PATCH or MERGE to update an existing service node and POST to create a new service
node, namely a purchase order, purchase order item, schedule line, or an account assignment line.
If account assignment lines or delivery schedule lines are updated, mutual dependencies must be taken into account.
Updates can only be made via a batch call because the quantity or value speci cations must be rebalanced.
 Note
You cannot clear the deletion indicator of a purchase order item by using a PATCH or MERGE call.
If the eld <OrderQuantity> of the item node needs to be updated, the following applies:
If the purchase order item contains only a single schedule line, you can change the quantity on item level.
If the purchase order item contains several schedule lines, you have to change the quantity on schedule line level.
this must be done using the schedule line eld <ScheduleLineOrderQuantity> of the schedule line node.
Once the single or batch call has been submitted, the success response has the status 200 or 202. For a batch call with
an individual change set response, you receive the message Purchase order has been updated, or a failure response with
self-explanatory messages with status 400.
Delete: Deletion in purchase orders does not result in a deletion of the object in the database. Instead, a deletion
indicator is set on the service node. Deletion is handled as part of the update operation in a batch call. Delete is
supported only for the purchase order and purchase order item. Only archiving results in the physical deletion of these
objects.
 Note
Items marked for deletion cannot be read, or changed/updated. They are considered as if they do not exist, as if they
were physically deleted. The DELETE operation is not reversible by the service. If you want to undo a delete operation,
you can use the app Manage Purchase Orders, which supports the UNDO operation by clearing the deletion indicator.
Single and Batch Mode
The Odata service supports operations both in single and in batch. Single mode can be used for creating a purchase order or for
minor changes (that is for changes to data that are not interdependent with other data). Batch mode must be used for complex
changes (that is for changes to data that affect related data).
Single mode is supported for the following OData operations:
Single Request Operations
Entity OData Operations
POST PATCH DELETE

MERGE
A_PurchaseOrder yes yes yes
A_PurchaseOrderNote yes yes yes
A_PurchaseOrderItem yes yes yes
A_PurchaseOrderItemNote yes yes yes
A_PurchaseOrderScheduleLine yes yes yes
A_POSubcontractingComponent yes yes yes
1/30/2023
POST PATCH DELETE

MERGE
A_PurOrdAccountAssignment yes* yes** yes*
A_PurOrdPricingElement yes yes yes
Batch mode is supported for the following OData operations:
Batch Operations*/**
POST PATCH DELETE

MERGE
A_PurchaseOrder yes yes yes
A_PurchaseOrderNote yes yes yes
A_PurchaseOrderItem yes yes yes
A_PurchaseOrderItemNote yes yes yes
A_PurchaseOrderScheduleLine yes yes yes
A_POSubcontractingComponent yes yes yes
A_PurOrdAccountAssignment yes yes yes
A_PurOrdPricingElement yes yes yes
 Note
* Using POST/DELETE in single mode to create or delete an A_PurOrdAccountAssignment entity will most likely lead to an
inconsistent purchase order item, and thus to an error in the purchase order. Therefore, such changes should normally
always be performed in batch mode, where POST/DELETE of A_PurOrdAccountAssignment is accompanied to PATCH or
MERGE of the A_PurchaseOrderItem entity.
** If the quantity or value of an account assignment line is updated, this affects the other account assignment lines. In this
case, the PATCH or MERGE operation should therefore also be executed in batch mode.
Service Message Header
The service message header contains information, for example, on the service, the content type (application/json,
application/xml), the involved sender and receiver as well as date and time.
Entities
The entities contain the business data of the service.
Entity Description Link to details
A_PurchaseOrder Header information for purchase order API_PURCHASEORDER_PROCESS_SRV -

A_PurchaseOrder
A_PurchaseOrderNote Header note information for purchase order Header Notes (A_PurchaseOrderNote)
1/30/2023
A_PurchaseOrderItem Item information for purchase order API_PURCHASEORDER_PROCESS_SRV -

A_PurchaseOrderItem
A_PurchaseOrderItemNote Item note information for purchase order Item Notes (A_PurchaseOrderItemNote)
A_PurchaseOrderScheduleLine Schedule line information for purchase API_PURCHASEORDER_PROCESS_SRV-

order A_PurchaseOrderScheduleLine
A_POSubcontractingComponent Subcontracting component information for Subcontracting Components

purchase order (A_POSubcontractingComponent)
A_PurOrdAccountAssignment Account assignment information for API_PURCHASEORDER_PROCESS_SRV -

purchase order A_PurOrdAccountAssignment
A_PurOrdPricingElement Pricing information for purchase order API_PURCHASEORDER_PROCESS_SRV -

A_PurOrdPricingElement
Input Validation
Static Field Control: The program checks the incoming payload for elds that are de ned as read-only elds in the data
model, for example the currency eld on item level. If such elds are lled, the incoming values are cleared. This applies
to the POST as well as to the PATCH or MERGE scenario.
Dynamic Field Control: A dynamic eld control has been established for elds whose status is dependent on the entry of
other elds or on the con guration settings for the eld control. For example, if a purchase order has several schedule
lines, the Quantity eld on item level is read-only. Another example: If a certain company code has been selected on
header level, only certain assigned plants are allowed on item level. If the service tries to set an invalid value in such a
dependent eld, the system rejects it and informs the user with a warning or an error message depending on the entity
type.
Handling of Info Messages and Warnings: In the sap-message container in the reponse header, the end user receives also
warnings and info messages that occurred when the OData service has been processed, regardless of whether it is in
single mode or in batch mode. The warnings include tolerable warnings as well as such warnings that hinder the creation
or the update of a purchase order.
Determination of Default Values

Inbound/Outbound Data Conversion: The OData standard functionality for quantity and amount elds has been enabled,
by linking amount resp. quantity elds to currency resp. unit of measure elds according to standard business logic. For
example, the schedule line quantity can refer to the unit of measure of the corresponding item.
Default Address Data: Missing address data can be determined or completed by the system according to standard
business logic. The following applies, for example:
The system determines the address data in the purchase order header from the supplier master data.
The system determines the delivery address of the purchase order item from the plant/storage locaction (if
de ned).
Service Response
Parameter Description
Purchase order number Purchase order number which is created by the service is returned
in response to the successful creation
1/30/2023
Purchase order header details Newly created purchase order header details
Message class: APPL_MM_PUR_PO, message no. 011 You are not authorized to create purchase orders
Message class: APPL_MM_PUR_PO, message no. 064 Use purchase order type "Standard" ("NB") or a type copied from
“NB”.
Diagnosis
You have entered a purchase order type that is not supported.
Procedure
Choose purchase order type "Standard" ("NB") or a customer-

de ned purchase order type (for example "ZNB1") that has been
copied with all dependent entries from purchase order type "NB"
(including eld selection key).
As a con guration expert, you can de ne custom purchase order

types in the con guration app Manage Your Solution -> Con gure
Your Solution -> Application Area: Sourcing and Procurement -> Sub
Application Area: Operational Procurement -> Purchase Order
Processing -> De ne Document Types.
Do not change the default eld selection key.
Message class: APPL_MM_PUR_PO, message no. 065 Use a supported purchase order item category for item &. See long
text.
Diagnosis
You have either chosen a purchase order item category that is not
supported, or you have used a wrong symbol.
Procedure
Choose purchase order item category "Standard",

"Subcontracting", "Third-Party", or "Enhanced Limit".
Maintain the required purchase order item category using the

internal symbol:
Standard: 0
Subcontracting: 3
Third-Party: 5
Enhanced Limit: A
Message class: APPL_MM_PUR_PO, message no. 067 Schedule line has been created automatically for item &
Response(Success) Purchase order “Purchase Order number” has been updated with
status 200 at change set level.
Response(Failure) Self-explanatory detailed messages at the change set level with

status 400. Batch response will be status code 200.
Message class: APPL_MM_PUR_PO, message no. 069 Only one request is allowed in change set
Message class: APPL_MM_PUR_PO, message no. 070 Only PATCH or MERGE operation is allowed in batch call
Message class: APPL_MM_PUR_PO, message no. 072 You can only update one purchase order per change set
Constraints
1/30/2023
With this service, it is not possible to:
1. Create:
Purchase orders with a category other than those speci ed for the header and item.
Purchase order items with a category other than Standard, Subcontracting, Third-Party, and Enhanced Limit .
Only authorized roles can be used to create purchase orders through an API call. Authorized objects: M_BEST_BSA.
2. Update:
Use PUT and MERGE or PATCH, and HEAD in the OData call URL. Only POST, PATCH or MERGE, and DELETE are
allowed with the Batch URL. Using other actions will result in an error.
Update more than one purchase order within one change set. Only one purchase order can be updated in a single
change set. If you would like to update multiple purchase orders, provide the update information of one purchase
order per change set.
Create a new service node (except a purchase order item) in an existing document.
Only authorized roles can be used to update purchase orders through an API call.
3. Get:
More than 1000 purchase orders unless
You set the paging size up to 5000 records using the following OData request:
 Example
/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder?$top=5000
/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder?
$expand=to_PurchaseOrderItem&$ lter=CreationDate gt datetime'2021-04-24T00:00:00'&$top=5000
 Note
With release SAP S/4HANA Cloud 2105, <clauses>-limit = 1000 was introduced for performance reasons in
API_PURCHASEORDER_PROCESS_SRV.
The default paging size (D) = 1000 if the client did not provide $top.
The maximum paging size (M) = 5000 if the client offers $top.
4. Post:
To transfer pricing values 1:1 from an external system as some values are calculated automatically and IDs are
generated. Regarding the pricing details, the OData service contains elds with "Necessity": read-only, which are
not lled during a Post request.
If migrating from one system to another, it is recommended to use the same pricing procedure in the source and
the target system, to ensure that pricing results are the same. If rounding pro les are maintained (material
master, MRT1 tab), do not send condition data in the Post request as a payload.
5. Stock Transfer Order (STO) is not supported.
Related Events
Purchase Order Events
Authentication
1/30/2023
The following authentication methods are supported:
Basic Authentication
Authentication with Certi cate
Additional Information
The link to the API on the SAP API Business Hub: Purchase Order
 Note
For more details about Communication Management, see Communication Management.
Note
If you have requirements for the interface that go beyond the current scope of functions, you can submit an improvement
request here:
https://in uence.sap.com/sap/ino/
Here, other customers can also vote for your request. Once your improvement request has reached a de ned voting threshold,
it will be reviewed and evaluated by SAP.
Further information on how to in uence development can be found in 11 .
Operations for Purchase Order

The Purchase Order API (OData) offers the following operations:
Operation HTML Sample URL

Method
Read GET GET <host>/sap/opu/odata/SAP/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder('4500100268')?$expa

purchase
order data
Create POST POST <host>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder

purchase
order
Change PATCH PATCH <host>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrderItem(PurchaseOrder=

purchase or
order item MERGE
Delete DELETE DELETE

pricing <host>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurOrdPricingElement(PurchaseOrder='450
element
of
purchase
order
Get GET GET <host>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/GetOutputBinaryData?PurchaseOrder='4

output
binary
data
1/30/2023
Read Purchase Order with Schedule Line and Subcontracting

Component
Request
You can include the following properties in the URL of the request:
Property Necessity Comment
PurchaseOrder Mandatory -
Response
The operation returns the data of a single purchase order.
Examples
Request
GET <host>/sap/opu/odata/SAP/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder('4500100268')?$expand=to
Content-Type: application/json
Response
 Sample Code
{
"d" : {
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/SAP/API_PURCHASEORDER_PROCESS_SRV
"uri" : "https://host:port/sap/opu/odata/SAP/API_PURCHASEORDER_PROCESS_SR
"type" : "API_PURCHASEORDER_PROCESS_SRV.A_PurchaseOrderType"
},
"PurchaseOrder" : "4500100268",
"CompanyCode" : "0001",
"PurchaseOrderType" : "NB",
"PurchasingDocumentDeletionCode" : "",
"PurchasingProcessingStatus" : "05",
"CreatedByUser" : "YOURNAME",
"CreationDate" : "\/Date(1561420800000)\/",
"LastChangeDateTime" : "\/Date(1561476266788+0000)\/",
"Supplier" : "YOURSUPPLIER",
"PurchaseOrderSubtype" : "",
"Language" : "EN",
"PaymentTerms" : "0002",
"CashDiscount1Days" : "14",
"NetPaymentDays" : "0",
"CashDiscount1Percent" : "2.000",
"PurchasingOrganization" : "0001",
"PurchasingDocumentOrigin" : "9",
"PurchasingGroup" : "001",
"PurchaseOrderDate" : "\/Date(1561420800000)\/",
"DocumentCurrency" : "EUR",
"ExchangeRate" : "1.00000",
"ValidityStartDate" : null,
"ValidityEndDate" : null,
"SupplierQuotationExternalID" : "",
"SupplierRespSalesPersonName" : "",
"SupplierPhoneNumber" : "",
"SupplyingSupplier" : "",
1/30/2023
"SupplyingPlant" : "",
"IncotermsClassification" : "CIF",
"CorrespncExternalReference" : "",
"CorrespncInternalReference" : "",
"InvoicingParty" : "",
"ReleaseIsNotCompleted" : false,
"PurchasingCompletenessStatus" : false,
"IncotermsVersion" : "",
"IncotermsLocation1" : "Hamburg",
"IncotermsLocation2" : "",
"ManualSupplierAddressID" : "",
"IsEndOfPurposeBlocked" : "",
"AddressCityName" : "",
"AddressFaxNumber" : "",
"AddressHouseNumber" : "",
"AddressName" : "",
"AddressPostalCode" : "",
"AddressStreetName" : "",
"AddressPhoneNumber" : "",
"AddressRegion" : "",
"AddressCountry" : "",
"AddressCorrespondenceLanguage" : "",
"to_PurchaseOrderItem" : {
"results" : [
{
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/SAP/API_P
"uri" : "https://host:port/sap/opu/odata/SAP/API_
"type" : "API_PURCHASEORDER_PROCESS_SRV.A_Purchas
},
"PurchaseOrderItem" : "10",
"PurchaseOrderItemText" : "SEMI FINISHED",
"Plant" : "0001",
"StorageLocation" : "",
"MaterialGroup" : "00216",
"PurchasingInfoRecord" : "",
"SupplierMaterialNumber" : "",
"OrderQuantity" : "4",
"PurchaseOrderQuantityUnit" : "CRT",
"OrderPriceUnit" : "CRT",
"OrderPriceUnitToOrderUnitNmrtr" : "1",
"OrdPriceUnitToOrderUnitDnmntr" : "1",
"NetPriceAmount" : "12.00",
"NetPriceQuantity" : "1",
"TaxCode" : "",
"PriceIsToBePrinted" : true,
"OverdelivTolrtdLmtRatioInPct" : "0.0",
"UnlimitedOverdeliveryIsAllowed" : false,
"UnderdelivTolrtdLmtRatioInPct" : "0.0",
"ValuationType" : "",
"IsCompletelyDelivered" : false,
"IsFinallyInvoiced" : false,
"PurchaseOrderItemCategory" : "3",
"AccountAssignmentCategory" : "",
"MultipleAcctAssgmtDistribution" : "",
"PartialInvoiceDistribution" : "",
"GoodsReceiptIsExpected" : true,
"GoodsReceiptIsNonValuated" : false,
"InvoiceIsExpected" : true,
"InvoiceIsGoodsReceiptBased" : true,
"PurchaseContract" : "",
"PurchaseContractItem" : "0",
"Customer" : "",
"ItemNetWeight" : "0.000",
"ItemWeightUnit" : "KG",
"TaxJurisdiction" : "",
"PricingDateControl" : "",
"ItemVolume" : "0.000",
"ItemVolumeUnit" : "",
"SupplierConfirmationControlKey" : "",
1/30/2023
"IncotermsClassification" : "",
"IncotermsTransferLocation" : "",
"EvaldRcptSettlmtIsAllowed" : false,
"PurchaseRequisition" : "",
"PurchaseRequisitionItem" : "0",
"IsReturnsItem" : false,
"RequisitionerName" : "",
"ServicePackage" : "0",
"EarmarkedFunds" : "",
"EarmarkedFundsDocument" : "",
"EarmarkedFundsItem" : "0",
"EarmarkedFundsDocumentItem" : "0",
"Material" : "ZSH_VALSEMI",
"InternationalArticleNumber" : "",
"ManufacturerMaterial" : "ZSH_VALSEMI",
"ServicePerformer" : "",
"ProductType" : "1",
"ExpectedOverallLimitAmount" : "0.00",
"OverallLimitAmount" : "0.00",
"PurContractForOverallLimit" : "",
"DeliveryAddressID" : "",
"DeliveryAddressName" : "",
"DeliveryAddressStreetName" : "",
"DeliveryAddressHouseNumber" : "",
"DeliveryAddressCityName" : "",
"DeliveryAddressPostalCode" : "",
"DeliveryAddressRegion" : "",
"DeliveryAddressCountry" : "",
"BR_MaterialUsage" : "",
"BR_MaterialOrigin" : "",
"BR_CFOPCategory" : "",
"BR_IsProducedInHouse" : false,
"ConsumptionTaxCtrlCode" : "",
"ProductSeasonYear" : "",
"ProductSeason" : "",
"ProductCollection" : "",
"ProductTheme" : "",
"SeasonCompletenessStatus" : "",
"ProductCharacteristic1" : "",
"PurchasingParentItem" : "0",
"SubItemCategory" : ""
"CrossPlantConfigurableProduct" : "",
"DiversionStatus" : "",
"ReferenceDocumentNumber" : "",
"ReferenceDocumentItem" : "0",
"PurchaseOrderReferenceType" : "",
"ReferenceDocumentScheduleLine" : "0",
"ArticleCategory" : "",
"ItemHasValueAddedService" : "",
"ValAddedSrvcParentItmNumber" : "0",
"StockSegment" : "",
"RequirementSegment" : "",
"to_PurchaseOrder" : {
"__deferred" : {
"uri" : "https://host:port/sap/opu/odata/
}
},
"to_AccountAssignment" : {
"__deferred" : {
"uri" : "https://host:port/sap/opu/odata
}
},
"to_PurchaseOrderPricingElement" : {
"__deferred" : {
}
},
"to_ScheduleLine" : {
"results" : [
{
1/30/2023
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/S
"type" : "API_PURCHASEORDER_PROCESS_SRV.A
},
"PurchasingDocument" : "4500100268",
"PurchasingDocumentItem" : "10",
"ScheduleLine" : "1",
"DelivDateCategory" : "1",
"ScheduleLineDeliveryDate" : "\/Date(1561420800000)\/",
"ScheduleLineOrderQuantity" : "4",
"ScheduleLineDeliveryTime" : "PT00H00M00S",
"SchedLineStscDeliveryDate" : "\/Date(1561420800000)\/",
"ScheduleLineCommittedQuantity" : "0",
"PerformancePeriodStartDate" : null,
"PerformancePeriodEndDate" : null,
"to_SubcontractingComponent" : {
"results" : [
{
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/S
},
"ReservationItem" : "1",
"RecordType" : "",
"Material" : "ZSH_VALRAW1",
"BOMItemDescription" : "",
"RequiredQuantity" : "8",
"BaseUnit" : "CRT",
"RequirementDate" : "\/Date(1561420800000)\/",
"QuantityInEntryUnit" : "8",
"EntryUnit" : "CRT",
"WithdrawnQuantity" : "0",
"Plant" : "0001",
"Batch" : ""
},
{
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/
"uri" : "https://host:port/sap/opu/odata
},
"RecordType" : "",
"BaseUnit" : "CRT",
"Plant" : "0001",
"Batch" : ""
}
]
}
}
]
},
"to_ValueAddedService" : {
"__deferred" : {
"uri" : "https://host:port/sap/op
}
1/30/2023
}
}
]
}
}
} }
Create Purchase Order with Schedule Line and Subcontracting

Component
Request
- - -
Response
The operation returns the data of the new purchase order (including the purchase order number) in response to the successful
creation of the purchase order.
Examples
Request
 Sample Code
POST <host>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder
Payload:
{
"to_PurchaseOrderItem" : [
{
"PurchaseOrderItemText" : "Subcontracting item",
"Plant" : "0001",
"to_ScheduleLine" : [
{
"ScheduleLineDeliveryDate" : "2019-07-30T00:00:00",
"to_SubcontractingComponent" : [
{
"RequirementDate" : "2019-07-30T00:00:00",
"QuantityInEntryUnit" : "2.000",
"Plant" : "0001"
},
{
"RequirementDate" : "2019-07-30T00:00:00",
1/30/2023
"QuantityInEntryUnit" : "4.000",
"Plant" : "0001"
}
]
}
]
}
]
}
Response
 Sample Code
{
"d" : {
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder('45001
"uri" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder('4500
"type" : "API_PURCHASEORDER_PROCESS_SRV.A_PurchaseOrderType"
},
"PurchasingProcessingStatus" : "02",
"CreatedByUser" : "YOURNAME",
"CreationDate" : "\/Date(1570320000000)\/",
"LastChangeDateTime" : null,
"PurchaseOrderSubtype" : "",
"Language" : "EN",
"PaymentTerms" : "0002",
"NetPaymentDays" : "0",
"PurchasingDocumentOrigin" : "9",
"PurchaseOrderDate" : "\/Date(1570320000000)\/",
"ExchangeRate" : "",
"ValidityStartDate" : null,
"ValidityEndDate" : null,
"SupplierQuotationExternalID" : "",
"SupplierRespSalesPersonName" : "",
"SupplierPhoneNumber" : "",
"SupplyingSupplier" : "",
"SupplyingPlant" : "",
"IncotermsClassification" : "CIF",
"CorrespncExternalReference" : "",
"CorrespncInternalReference" : "",
"InvoicingParty" : "",
"ReleaseIsNotCompleted" : false,
"PurchasingCompletenessStatus" : false,
"IncotermsVersion" : "",
"IncotermsLocation1" : "Hamburg text",
"ManualSupplierAddressID" : "",
"IsEndOfPurposeBlocked" : "",
"AddressCityName" : "Rocky Beach",
"AddressFaxNumber" : "",
"AddressHouseNumber" : "42",
"AddressName" : "California Sunshine Inc.",
"AddressPostalCode" : "69190",
"AddressStreetName" : "Sunshine Road",
"AddressPhoneNumber" : "",
"AddressRegion" : "",
"AddressCountry" : "DE",
1/30/2023
"AddressCorrespondenceLanguage" : "EN",
"results" : [
{
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrderItem(Pu
"uri" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrderItem(P
"type" : "API_PURCHASEORDER_PROCESS_SRV.A_PurchaseOrderItemType"
},
"PurchaseOrderItemText" : "Subcontracting item",
"Plant" : "0001",
"StorageLocation" : "",
"MaterialGroup" : "00216",
"PurchasingInfoRecord" : "5300078490",
"SupplierMaterialNumber" : "",
"OrderPriceUnit" : "CRT",
"OrderPriceUnitToOrderUnitNmrtr" : "1",
"OrdPriceUnitToOrderUnitDnmntr" : "1",
"TaxCode" : "",
"PriceIsToBePrinted" : true,
"OverdelivTolrtdLmtRatioInPct" : "0.0",
"UnlimitedOverdeliveryIsAllowed" : false,
"UnderdelivTolrtdLmtRatioInPct" : "0.0",
"ValuationType" : "",
"IsCompletelyDelivered" : false,
"IsFinallyInvoiced" : false,
"AccountAssignmentCategory" : "",
"MultipleAcctAssgmtDistribution" : "",
"PartialInvoiceDistribution" : "",
"GoodsReceiptIsExpected" : true,
"GoodsReceiptIsNonValuated" : false,
"InvoiceIsExpected" : true,
"InvoiceIsGoodsReceiptBased" : false,
"PurchaseContract" : "",
"PurchaseContractItem" : "0",
"Customer" : "",
"ItemNetWeight" : "0.000",
"ItemWeightUnit" : "KG",
"TaxJurisdiction" : "",
"PricingDateControl" : "",
"ItemVolume" : "0.000",
"ItemVolumeUnit" : "",
"SupplierConfirmationControlKey" : "",
"IncotermsClassification" : "",
"IncotermsTransferLocation" : "",
"EvaldRcptSettlmtIsAllowed" : false,
"IsReturnsItem" : false,
"RequisitionerName" : "",
"ServicePackage" : "0",
"EarmarkedFunds" : "",
"EarmarkedFundsDocument" : "",
"EarmarkedFundsItem" : "0",
"EarmarkedFundsDocumentItem" : "0",
"InternationalArticleNumber" : "",
"ManufacturerMaterial" : "ZSH_VALSEMI",
"ServicePerformer" : "",
"ProductType" : "1",
"ExpectedOverallLimitAmount" : "0.00",
"OverallLimitAmount" : "0.00",
"PurContractForOverallLimit" : "",
1/30/2023
"DeliveryAddressID" : "",
"DeliveryAddressName" : "John",
"DeliveryAddressStreetName" : "Street",
"DeliveryAddressHouseNumber" : "15",
"DeliveryAddressCityName" : "Beijing",
"DeliveryAddressPostalCode" : "69191",
"DeliveryAddressRegion" : "01",
"DeliveryAddressCountry" : "DE",
"BR_MaterialUsage" : "",
"BR_MaterialOrigin" : "",
"BR_CFOPCategory" : "",
"BR_IsProducedInHouse" : false,
"ConsumptionTaxCtrlCode" : "",
"ProductSeasonYear" : "",
"ProductSeason" : "",
"ProductCollection" : "",
"ProductTheme" : "",
"SeasonCompletenessStatus" : "",
"PurchasingParentItem" : "0",
"SubItemCategory" : "",
"CrossPlantConfigurableProduct" : "",
"DiversionStatus" : "",
"ReferenceDocumentNumber" : "",
"ReferenceDocumentItem" : "0",
"PurchaseOrderReferenceType" : "",
"ReferenceDocumentScheduleLine" : "0",
"ArticleCategory" : "",
"ItemHasValueAddedService" : "",
"ValAddedSrvcParentItmNumber" : "0",
"StockSegment" : "",
"RequirementSegment" : "",
"to_PurchaseOrder" : {
"__deferred" : {
}
},
"to_AccountAssignment" : {
"__deferred" : {
}
},
"to_PurchaseOrderPricingElement" : {
"__deferred" : {
}
},
"to_ScheduleLine" : {
"results" : [
{
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrderSchedul
"uri" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrderSchedu
"type" : "API_PURCHASEORDER_PROCESS_SRV.A_PurchaseOrderScheduleLineType"
},
"PurchasingDocument" : "4500129848",
"PurchasingDocumentItem" : "10",
"DelivDateCategory" : "1",
"ScheduleLineDeliveryDate" : "\/Date(1564444800000)\/",
"ScheduleLineDeliveryTime" : "PT00H00M00S",
"SchedLineStscDeliveryDate" : "\/Date(1564444800000)\/",
"ScheduleLineCommittedQuantity" : "0",
"PerformancePeriodStartDate" : null,
"PerformancePeriodEndDate" : null,
"to_SubcontractingComponent" : {
"results" : [
{
1/30/2023
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_POSubcontractingComp
"uri" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_POSubcontractingCom
"type" : "API_PURCHASEORDER_PROCESS_SRV.A_POSubcontractingComponentType"
},
"RecordType" : "",
"BaseUnit" : "CRT",
"Plant" : "0001",
"Batch" : ""
},
{
"__metadata" : {
"id" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_POSubcontractingComp
"uri" : "https://host:port/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_POSubcontractingCom
"type" : "API_PURCHASEORDER_PROCESS_SRV.A_POSubcontractingComponentType"
},
"RecordType" : "",
"BaseUnit" : "CRT",
"Plant" : "0001",
"Batch" : ""
}
]
}
}
]
},
"to_ValueAddedService" : {
"__deferred" : {
}
}
}
]
}
}
}
Change Purchase Order with Schedule Line
Request
1/30/2023
PurchaseOrderItem
ScheduleLine
Response
The operation returns success message "200 (OK)".
Examples
Request
 Sample Code
PATCH <host>/sap/opu/odata/SAP/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrderScheduleLine(Purchasi
Payload:
{
"ScheduleLineDeliveryDate" : "2020-12-16T00:00:00"
}
Response
 Sample Code
Status-Code:
200 (OK) and an update of the property as appropriate.
Delete a Pricing Element of a Purchase Order
Request
PurchaseOrderItem
PricingDocument
PricingDocumentItem
Pricing ProcedureStep
PricingProcedureCounter
Response
If the operation has been executed successfully, the servers should return 200 (OK) with no response body.
1/30/2023
Examples
Request
 Sample Code
DELETE <host>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurOrdPricingElement(PurchaseOrde
Payload: none
Response
 Sample Code
Status-Code: 200 (OK)
Get Output Binary Data

This operation retrieves a speci c output document from the system in PDF format, that shows what the purchase order looks
like after the output. The consumer must specify the purchase order number.
To retrieve the PDF of a purchase order in the system, you use the HTTP method GET to invoke the GetOutputBinaryData
action on the document number of the target purchase order.
 Note
If several PDF documents of the same purchase order exist (for example, due to a changed output form template),
the service always chooses the newest one.
Request
You can include the following properties in the request's URL:
purchase order Mandatory -
 Example
To get the PDF for purchase oder 4500000000:
 Sample Code
GET <host>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/GetOutputBinaryData?PurchaseOrder='450
Response
When you successfully use the GetOutputBinaryData action on a purchase order document in the system, the service returns a
speci c purchase order in PDF format.
1/30/2023
If you request the PDF for a purchase order that does not exist, an error structure containing an appropriate message is
returned.
Examples
Request
 Sample Code
<host>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/GetOutputBinaryData?PurchaseOrder='4500000
X-CSRF-Token: abc
Accept: application/json
Response
 Sample Code
Status: 200 ok
content-type: application/json; charset=utf-8
dataserviceversion: 1.0
The server response contains a Base64 string that always ends with two equal characters: ==
You can easily convert it to a PDF le using javascript or free tooling.
The following code sample shows the corresponding response, which includes the PDF le:
Example by javascript using Node.js:
 Sample Code
const Service = require("@sap_oss/odata-library/lib/Service.js");
const fs = require('fs');
const serviceSuffix = "/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/";
const defaultSystem = "<replace with your SAP system ID >";
const defaultClient = "< replace with your client number>";
const defaultPO = '<replace with your test purchase order>';
const user = "<replace with your API user>";
const password = "< replace with the password of your API user>";
this.assembleUrl = function (system, client) {
return https:// + system + "-" + client + ".wdf.sap.corp" + serviceSuffix;
}
this.init = async function (url, username, password, loggingEnabled = false, params = {}) {
const logger = {
"trace": () => { },
"debug": console.debug,
"info": console.info,
"warn": console.warn,
"error": console.error
};
const parameters = {
"client": "100",
"documentation": ["heading", "quickinfo"],
"language": "EN"
};
if (params) {
Object.keys(params).forEach((key) => parameters[key] = params[key]);
}
const srv = new Service({
1/30/2023
"logger": loggingEnabled ? logger : "",
"url": url,
"auth": {
"username": username,
"password": password
},
"parameters": parameters, //Define initial request by $metadata?sap-client=<client-number
"strict": false // ignore non critical errors, e.g. orphaned annotations
});
await srv.init;
return srv;
};
this.fetchPDF = async function (url, purchaseOrder) {

console.log("Fetching...");
let srv = await this.init(url, user, password, false);
let res = await srv.GetOutputBinaryData({ PurchaseOrder: purchaseOrder });
let fileContents = res["GetOutputBinaryDataF"]["PurchaseOrderBinary"];
var buf = Buffer.from(fileContents, 'base64');
fs.writeFile('PurchaseOrder.pdf', buf, error => {
if (error) {
throw error;
} else {
return;
}
});
};
Example of how to convert Base64 to PDF using web tooling:
Save the response as a text le, for example, using notepad.
Open the free Base64 website and choose Convert application.
Click inside the le drop area to upload Base64 les or drag & drop Base64 les.
Click on the Convert button.
A link to download the converted results will be available shortly after the conversion.
Purchase Order (A_PurchaseOrder)
Use
Header node that contains the purchase order header elds.
Parameters
 Note
Read-only in the Necessity column below means the following behavior of the OData API. Entries for the respective elds in
the payload can neither be added nor changed:
POST: Any data for the eld in the payload will be ignored.
PATCH or MERGE: Any data that is different from the existing data triggers an error message; matching data will be
ignored.
Property Description Necessity
1/30/2023
AddressCityName Address city name Optional
Used here: default address for supplier or

ManualSupplierAddressID
AddressCorrespondenceLanguage Address correspondence language Optional
AddressCountry Address country key Optional

AddressFaxNumber Address fax number Optional

AddressFullName Address full name Optional

AddressHouseNumber Address house number Optional

AddressName Address name Optional

AddressName2 Address name 2 Optional

AddressPhoneNumber Telephone no.: Dialing code and number Optional

AddressPostalCode Address postal code Optional

AddressRegion Region (State, province, county) Optional

AddressStreetName Address street name Optional

CashDiscount1Days Days for cash discount 1 Optional
CashDiscount1Percent Cash discount percentage 1 Optional
CompanyCode Company code Mandatory
1/30/2023
CorrespncExternalReference The reference ID that is provided by the Optional

external party and that is used in
correspondence
CorrespncInternalReference The reference ID that is provided by the Optional

internal party and that is used in
correspondence
CreatedByUser User ID of creator Read-only
CreationDate Creation date Read-only
DocumentCurrency Document currency key Recommendation
 Note
DocumentCurrency is derived from the
supplier master data.
It is recommended, however, to still add

the DocumentCurrency in the payload
explicitly
to ensure coherent database records

and better performance of the service.
ExchangeRate Exchange rate used for the translation Optional

between foreign currency and local currency
ExchangeRateIsFixed Indicator for Fixed Exchange Rate Optional
IsEndOfPurposeBlocked Business Purpose Completed Read-only
IncotermsClassi cation Incoterms (Part 1) Optional
IncotermsLocation1 Incoterms location 1 Optional
IncotermsVersion Incoterms version Optional
InvoicingParty Account of invoicing party Optional
Language Language Optional
LastChangeDateTime Change Time Stamp Read-only
ManualSupplierAddressID Manually entered document address of a Read-only

supplier
NetPaymentDays Net payment terms period. Optional
Standard settlement period (in days)
PaymentTerms Payment terms Optional
1/30/2023
PurchaseOrder Request from a buyer to a seller to deliver a POST (new purchase order) and internal
speci ed quantity of material, or perform a number assignment: Not required
speci ed service
POST (new purchase order) and external
number assignment (if allowed by your
con guration settings): Optional
DELETE: Mandatory
PATCH or MERGE operation:
 Note
Be aware that request url and body of
request must be treated differently!
Key elds are to be provided with the url

only and are not allowed as part of the
payload (body of request)!
PurchaseOrderDate The date on which a purchase order has Optional

been placed.
PurchaseOrderSubtype Control indicator for purchasing document Read-only

type
PurchaseOrderType Purchase order type Mandatory
PurchasingCollectiveNumber Number or code facilitating the collective Optional

management of a number of individual
RFQs (or inquieries) or purchase orders.
PurchasingCompletenessStatus Purchasing document not yet complete Optional
PurchasingDocumentDeletionCode Deletion indicator in purchasing document Read-only
PurchasingDocumentOrigin Origin of purchasing document Read-only
PurchasingGroup Purchasing group Mandatory
PurchasingOrganization Purchasing organization Mandatory
PurchasingProcessingStatus Processing status of a purchasing Optional

document
PurgAggrgdProdCmplncSuplrSts Summary of the product compliance status Read-only

of the supplier validation with regards to the
whole purchase order
PurgAggrgdProdMarketabilitySts Summary of the product compliance status Read-only

of the marketability status validation with
regards to the whole purchase order
PurgAggrgdSftyDataSheetStatus Summary of the product compliance status Read-only

of the safety data sheet validation with
PurgProdCmplncTotDngrsGoodsSts Summary of the product compliance status Read-only

of the dangerous goood validation with
ReleaseIsNotCompleted Release not yet completely effected Optional
1/30/2023
Supplier Business partner who offers or provides Mandatory

materials or services
SupplierPhoneNumber Supplier’s telephone number Optional
SupplierQuotationExternalID External quotation ID on supplier’s side Optional
SupplierRespSalesPersonName Responsible Sales Person at supplier’s Optional

office
SupplyingPlant Supplying plant Optional
SupplyingSupplier Supplying supplier Optional
ValidityEndDate Validity end date Optional
ValidityStartDate Validity start date Optional
Header Notes (A_PurchaseOrderNote)

Purchase order node that contains the note elds of the purchase order header.
Properties
 Note
No validation is performed for the Text Object Type parameter.
If you add a new text to an existing text in a POST operation, the two texts are merged.
DocumentText Text ID (Text Object Type) Optional
Language Language Key Optional
NoteDescription Long Text Optional
PurchaseOrder Purchasing Document Number Optional
 Note
To display more information about the properties on the SAP API Business Hub, open an operation of the entity and select
Model.
Item (A_PurchaseOrderItem)
Use
Item node that contains the purchase order item elds.
Parameters
1/30/2023
 Note
ignored.
 Note
Address handling
Consider the following dependencies for the delivery address elds.
You have, for example, the following situation:
For some of the delivery address elds an input is provided in the payload in addition to the ReferenceDeliveryAddressID, the
Subcontractor, and the Customer.
If a referene delivery address ID is entered in the payload, the address maintained under the reference delivery address ID is
used. If you enter, for example, a delivery address street and house number in the payload in addition to the reference
delivery address ID, the system generates a new delivery address ID. The address saved for this new delivery address ID
consists of a combination of the address of the reference delivery address ID and the address details given explicitly in the
payload for the respective delivery address elds (in our example for the delivery address street and house number).
 Note
GET request and paging
The GET statement is quite powerful as it could possibly retrieve huge amounts of data – if not restricted, all data on the
database could be returned. To have a safety net and keep performance up, paging was introduced for the data in the result.
This means that if no URI Option $top is given in the URI, 1000 records are retrieved. If, however, the $top option is given,
max. 5000 records can be retrieved.
In addition, the $skiptoken option can be used to retrieve the data from all so-called pages: one page is a result set of 1000
records. To get all records in the result set, all pages can be read. To do this, the skiptoken at the bottom of the response can
be used to get to the next page with the next 1000 records, for example:
<link rel="next" href="A_PurchaseOrder?$skiptoken=1000"/>
If this skiptoken is added to the URI, for example:
/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder?$skiptoken=1000
The next page is retrieved, starting with the next purchase order after the last one in the rst result set.
At the end of this page, the skiptoken allows further "navigation" by giving both skiptokens, the current one and the next one:
<link rel="next" href="A_PurchaseOrder?%24skiptoken=1000&$skiptoken=2000"/>
This can be continued until the end of all pages.
1/30/2023
AccountAssignmentCategory Account assignment category Optional
Batch Assigns a material that is manufactured in Optional

batches or production lots to a speci c
batch.
Customer Number of the customer for whom a Optional

material is to be delivered.
Please see Note: Address handling on top

of this table and consider the described
dependencies.
DeliveryAddressCityName Delivery address city name Optional
Used here: default address for plant or

default address for storage location, if this
is maintained
DeliveryAddressCountry Country key Optional

is maintained
DeliveryAddressDistrictName District is part of a city Optional
DeliveryAddressFullname Delivery address fullname Optional

is maintained
DeliveryAddressHouseNumber Delivery address house number Optional

is maintained
DeliveryAddressID Delivery address Read-only
Automatically generated number for the

details given in the payload for the delivery
address elds. Please see Note: Address
handling on top of this table and consider
the described dependencies.
DeliveryAddressName Delivery address name Optional

is maintained
DeliveryAddressName2 Delivery address name 2 Optional

is maintained
DeliveryAddressPostalCode Delivery address postal code Optional

is maintained
1/30/2023
DeliveryAddressRegion Delivery address region (state, province, Optional

county)
is maintained
DeliveryAddressStreetName Delivery address street name Optional

is maintained
DocumentCurrency Document currency key Read-only
DownPaymentAmount Down payment amount in document Optional

currency
DownPaymentDueDate Due date for down payment Optional
DownPaymentPercentageOfTotAmt Down payment percentage Optional
DownPaymentType Down payment indicator Optional
EarmarkedFunds Earmarked funds document Optional
EarmarkedFundsItem Earmarked funds line item Optional
EvaldRcptSettlmtIsAllowed Evaluated receipt settlement (ERS) Optional
ExpectedOverallLimitAmount Expected value of overall limit Optional
GoodsReceiptIsExpected Indicates that a goods receipt is allowed Optional

and expected
GoodsReceiptIsNonValuated Goods receipt, non-valuated Optional
IncotermsTransferLocation Incoterms (Part 2) Optional
InternationalArticleNumber International Article Number (EAN/UPC) Optional
InvoiceIsExpected Invoice receipt indicator Optional
InvoiceIsGoodsReceiptBased Indicator: Goods receipt-based invoice Optional

veri cation
IsCompletelyDelivered Indicator for status “Completely delivered” Optional
IsFinallyInvoiced Final invoice indicator Optional
IsReturnsItem Speci es whether or not the item is a Optional

returns item
ItemNetWeight Net weight on item level Optional
ItemVolume Item volume Optional
ItemVolumeUnit Volume unit Optional
ItemWeightUnit Unit of weight on item level Optional
1/30/2023
ManufacturerMaterial Material number corresponding to Optional

manufacturer part number
Material Material Optional
MaterialGroup Material group Optional
MultipleAcctAssgmtDistribution Distribution indicator for multiple account Optional

assignment
NetPriceAmount Net price Optional
NetPriceQuantity Price unit Optional
OrderPriceUnit Order price unit (Purchasing) Optional
OrderPriceUnitToOrderUnitNmrtr Numerator for conversion of order price unit Optional

into order unit
OrderQuantity Order quantity Optional
OrdPriceUnitToOrderUnitDnmntr Denominator for conversion of order price Optional

unit into order unit
OverallLimitAmount Overall Limit Optional
OverdelivTolrtdLmtRatioInPct Overdelivery tolerance limit Read-only
PartialInvoiceDistribution Determines how invoice amounts in partial Optional

invoices are to be distributed
Plant Plant POST: Mandatory
Alll other operations: Optional
PriceIsToBePrinted Price printout Optional
PricingDateControl Price determination (Pricing) data control Optional
ProductType Product type Optional
PurchaseContract Purchase contract Optional
PurchaseContractItem Purchase contract item Optional
PurchaseOrder Purchase order Optional
PurchaseOrderItem Purchase order item Optional
PurchaseOrderItemCategory Purchase order item category Optional
PurchaseOrderItemText Short text for purchase order item Optional
 Note
When working with item hierarchies, it is
Mandatory to enter a short text for item
sets.
PurchaseOrderQuantityUnit Purchase order unit of measure. Speci es Optional

the unit of measure in which the item is
ordered.
PurchaseRequisition Purchase requisition Optional
1/30/2023
PurchaseRequisitionItem Item number of purchase requisition Optional

[To delete a purchase order or a purchase
order item, use the DELETE operation.]
PurchasingInfoRecord Purchasing info record Optional
PurchasingItemIsFreeOfCharge This eld stores Free of Charge information. Optional

It is a calculated eld with the values
true/false sent in a payload  Note
Patch is not supported
PurchasingParentItem Item number of the parent item set Optional
PurgCon gurableItemNumber Number indicating the position in the Read-only

hierarchy that is generated automatically
PurgDocAggrgdSubitemCategory Hierarchy item indicator that determines an Optional

item set (C = item set)
PurgDocSubitemCategory Sub item category is generated Read-only

automatically
PurgExternalSortNumber External sort number is generated Read-only

automatically
PurgProdCmplncSupplierStatus Product compliance status with regards to Read-only

the supplier validation of an item
PurgProductMarketabilityStatus Product compliance status with regards to Read-only

the product marketability validation of an
item
PurgSafetyDataSheetStatus Product compliance status with regards to Read-only

the safety data sheet validation of an item
PurgProdCmplncDngrsGoodsStatus Product compliance status with regards to Read-only

the dangerous goods validation of an item
ReferenceDeliveryAddressID Number of delivery address Optional
Please see Note: Address handling on top Used here: default Reference ID for existing
of this table and consider the described address. No new address can be created.
dependencies.
RequisitionerName Name of requisitioner/requester Optional
ServicePackage Package number Optional
ServicePerformer Service performer Optional
ShippingInsruction Key of shipping instruction according to Optional

customizing
StorageLocation Storage location Optional
Subcontractor Supplier to be supplied/Who is to receive Optional

delivery

dependencies.
1/30/2023
SupplierCon rmationControlKey Determines which con rmation categories Optional

are expected for a purchase order item
SupplierIsSubcontractor Subcontracting supplier Optional
SupplierMaterialNumber Supplier material number Optional
TaxCode Tax on sales and purchases code Optional
TaxCountry Tax country Optional
TaxDeterminationDate Tax determination date Optional
 Note
You must ll the eld only if
time-dependant taxes are
activated. Otherwise you must
not ll the eld.
TaxJurisdiction Tax jurisdiction Optional
UnderdelivTolrtdLmtRatioInPct Underdelivery tolerance limit Optional
UnlimitedOverdeliveryIsAllowed Indicates that an unlimited overdelivery is Optional

allowed for this item
ValuationType Valuation type Optional
BR_MaterialOrigin Material Origin Optional in Brazil
BR_MaterialUsage Material Usage Optional in Brazil
BR_CFOPCategory Material CFOP Category Optional in Brazil
BR_NCM NCM Code for Item Optional in Brazil
BR_IsProducedInHouse Produced in-House Optional in Brazil
Item Notes (A_PurchaseOrderItemNote)

Purchase order node that contains the note elds of the purchase order items.
Properties
 Note
Inforecord texts cannot be retrieved by the GET request.
1/30/2023
TextObjectType Text ID (Document Text) Optional
No validation is performed for the Text

Object Type eld.
PlainLongText Long Text Optional
 Note
Filtering by PlainLongText is not
supported for purchase orderItem Notes
PurchaseOrderItem Item Number of Purchasing Document Optional
 Note
Model.
Schedule Line (A_PurchaseOrderScheduleLine)
Use
Schedule line node that contains purchase order item corresponding schedule line elds.
Parameters
 Note
ignored.
Note Regarding Delivery Date:
Relevant for POST operation with a single schedule line: If you order a material for which the system can determine the delivery
date from an info record or from the material master data, the system copies the date determined and ignores any date
entered in the payload.
If you want to de ne a different delivery date, please either create several schedule lines or change the delivery date in a PATCH
or MERGE operation.
DelivDateCategory Category of delivery date Optional
1/30/2023
PerformancePeriodStartDate Start date for period of performance Optional
PerformancePeriodEndDate End date for period of performance Optional
PurchaseOrderQuantityUnit Purchase order unit Read-only
PurchaseRequisition Purchase requisition number Optional
PurchaseRequisitionItem Purchase requisition item number Optional
PurchasingDocument Purchasing document number Mandatory
PurchasingDocumentItem Purchasing document item number Mandatory
SchedLineStscDeliveryDate Statistic relevant schedule line delivery Optional

date
ScheduleLine Delivery schedule line number Mandatory
ScheduleLineCommittedQuantity Committed quantity of a purchase order Optional

schedule line
ScheduleLineDeliveryDate Schedule line delivery date Optional - please see note above
ScheduleLineDeliveryTime Schedule line delivery time Optional
ScheduleLineOrderQuantity Order quantity in sales unit Optional
Subcontracting Components (A_POSubcontractingComponent)

Node that contains the subcontracting component elds per schedule line.
Properties
 Note
ignored.
BaseUnit Base Unit of Measure Read-only
Batch Batch Number Read-only
BOMItemDescription BOM Item Text (Line 1) Read-only
EntryUnit Unit of Entry Optional
Material Material Number Optional
Plant Plant Optional
1/30/2023
PurchaseOrder Purchase Order Number Mandatory: in case of PATCH or MERGE

and DELETE operation
PurchaseOrderItem Number of Purchase Order Item Mandatory: in case of PATCH or MERGE

QuantityInEntryUnit Quantity in Unit of Entry Optional
RequiredQuantity Requirement Quantity Read-only
RequirementDate Requirements Date for the Component Optional
ReservationItem Item Number of Reservation Mandatory: in case of PATCH or MERGE

ScheduleLine Delivery Schedule Line Counter Mandatory in case of PATCH or MERGE

operation
WithdrawnQuantity Quantity Withdrawn Read-only
 Note
Model.
Account Assignment (A_PurOrdAccountAssignment)
Use
Account assignment node that contains the account assignment elds that correspond to the purchase order item.
Parameters
 Note
ignored.
AccountAssignmentNumber Sequential number of account assignment Mandatory
BudgetPeriod Timeframe of available budget authority Optional
BusinessArea Business area Optional
BusinessProcess Business process Optional
CommitmentItem Functional grouping of expenditures and Optional

revenues with a FM area
1/30/2023
ControllingArea Controlling area Optional
CostCenter Cost center Optional
CostCtrActivityType Cost center activity type Optional
CostObject Cost object Optional
EarmarkedFundsDocument Business transaction in FM which claims Optional

already allocated budget for expected
revenues or expenditures
FixedAsset ID which, together with the main asset ID, Optional

uniquely identi es a xed asset in Asset
Accounting
FunctionalArea Functional area Optional
Fund Fund Optional
FundsCenter Structural grouping into departments, areas Optional

of responsibility, projects, and so on.
GLAccount Stores changes in values relating to assets, Optional

payables, stockholders, equity, revenues or
expenses of a company
GoodsRecipientName Person or company that receives goods Optional
GrantID Grant Optional
IsDeleted Is deleted Read-only
JointVentureRecoveryCode Joint venture recovery code Optional
MasterFixedAsset Main asset number Optional
MultipleAcctAssgmtDistrPercent Distribution percentage in case of multiple Optional

account assignment
NetworkActivity Single activity within a project Optional
OrderID Order number Optional
PartnerAccountNumber Partner account number Optional
Pro tCenter Pro t center Optional
ProjectNetwork Sequence of activities in a project or the Optional

sequence of a single activity within a
project.
PurchaseOrder Purchase order Mandatory
PurchaseOrderItem Purchase order item Mandatory
PurchaseOrderQuantity Purchase Order Quantity Read-only
PurgDocNetAmount Net order value in transaction currency Optional
Quantity Quantity Optional
RealEstateObject Internal key for real estate object Optional
1/30/2023
SalesOrder Sales order Optional
SalesOrderItem Sales order item Optional
SalesOrderScheduleLine Sales order schedule line number Optional
SettlementReferenceDate Reference date for settlement Optional
TaxCode Tax on sales and purchase code Optional
UnloadingPointName Name of a point at which a material is to be Optional

unloaded
WBSElement Work breakdown structure element (WBS Optional

element)
WBSElementExternalID Work breakdown structure element (WBS Optional

element) - external ID
WBSElementInternalID Work breakdown structure element (WBS Obsolete

element) - internal ID [Please do not use.]
Pricing Element (A_PurOrdPricingElement)
Use
Pricing element node that contains the pricing element elds of the purchase order items.
Parameters
 Note
ignored.
 Note
It is not possible to transfer pricing values 1:1 from an external system as some values are calculated automatically and IDs
are generated. Regarding the pricing details, the OData service contains elds with "Necessity": read-only, which are not
lled during a Post request.
If migrating from one system to another, it is recommended to use the same pricing procedure in the source and the target
system, to ensure that pricing results are the same. If rounding pro les are maintained (material master, MRT1 tab), do not
send condition data in the Post request as a payload.
1/30/2023
AccessNumberOfAccessSequence Number of the access within the access Read-only

sequence
CndnIsRelevantForIntcoBilling Condition is relevant for intercompany Read-only

billing
CndnIsRelevantForInvoiceList Condition is relevant for invoice list Read-only
CndnIsRelevantForLimitValue Controls whether the condition is relevant Read-only

for limit values
ConditionAmount Condition value Read-only
ConditionApplication Application Read-only
ConditionBaseValue Value that is used as a basis for calculating, Read-only

for example, percentage conditions
ConditionCalculationType Calculation type for condition Read-only
ConditionCategory Condition category (examples: tax, freight, Read-only

price, cost)
ConditionClass Condition class Read-only
ConditionControl Condition control Read-only
ConditionCurrency Condition currency Mandatory
ConditionInactiveReason Condition is inactive Read-only
ConditionIsForCon guration Condition is for con guration Read-only
ConditionIsForStatistics Condition is used for statistics Read-only
ConditionIsManuallyChanged Condition has been manually or Read-only

automatically changed or created
ConditionOrigin Origin of the condition Read-only
ConditionQuantity Condition quantity Optional
ConditionQuantityUnit Condition quantity unit Optional
ConditionRateValue Value (amount or percentage) that is used Optional

for price conditions
ConditionRecord Condition record number Read-only
ConditionScaleBasisCurrency Currency of the applied scale Read-only
ConditionScaleBasisUnit Unit of measure of the applied scale Read-only
ConditionScaleBasisValue Basis of the scale is used to determine the Read-only

applicable scale step
ConditionSequentialNumber Sequential number of the condition Read-only
ConditionToBaseQtyDnmntr Denominator for converting condition units Optional

to base units
ConditionToBaseQtyNmrtr Numerator for converting condition units to Optional

base units
ConditionType Condition type Optional
1/30/2023
FactorForConditionBasisValue Factor for condition basis value Read-only
IsGroupCondition Group condition Read-only
IsRelevantForAccrual Document or item is relevant for accrual Read-only
PriceDetnExchangeRate Exchange rate for price determination Read-only
PricingDateTime Pricing date time Read-only
PricingDocument Pricing document Mandatory
PricingDocumentItem Pricing document item Mandatory
PricingProcedureCounter Pricing procedure counter Mandatory
PricingProcedureStep Pricing procedure step Mandatory
PricingScaleBasis Scale basis indicator Read-only
PricingScaleType Scale type Read-only
TransactionCurrency Transaction currency Read-only
Extensibility: Purchase Order - Read, Create, Update, Delete

You can extend the OData Service API_PURCHASEORDER_PROCESS_SRV according to your business needs.
Features
Key users can extend the OData Service in the Custom Fields app using the following business contexts:
Procurement: Purchasing Document
Procurement: Purchasing Document Item
You can add elds to the following entities:
Entity Business Context
Header Procurement: Purchasing Document
Item Procurement: Purchasing Document Item
See Also
For more information, see the SAP API Business Hub (https://api.sap.com/ ).
Related Information
Custom Fields App and Custom Logic App
1/30/2023
Attachments within Communication Scenario SAP_COM_0053

Within the communication scenario SAP_COM_0053 the following services are available:
Purchase Order - Create, Read, Update, Delete
Attachment - Create, Read, Update, Delete
Attachments can be added on purchase order header level as well as on purchase order item level.
To enable the service Attachment - Create, Read, Update, Delete (API_CV_ATTACHMENT_SRV) for purchase orders, you need
the following header parameter:
Parameter Description Value
Cookie Validates that the Request and Post You request the cookie value about the
functions belong to the same purchase HTTP-GET request.
order.
BusinessObjectTypeName De nes the business object for the

BUS2012 (purchase order)
purchase order or purchase order item.
EKPO (purchase order items)
LinkedSAPObjectKey De nes the business object instance key to

In case BusinessObjectTypeName
which the attachment will be linked to.
is BUS2012, purchase order
 Note number has to be added, for
Enter key without space between example 1234567809.
purchase order number and item
In case BusinessObjectTypeName
number.
is EKPO, the purchase order number
has to be concatinated with the
item number, for example
123456780900010 (item number is
10 including 3 leading zeros).
1/30/2023
Parameter Description Value
X-CSRF-Token Validates together with the cookie that the You get the token value together with the
user is an authenticated communication cookie value about the HTTP-GET request.
user for the communication scenario
SAP_COM_0053.
 Note
In the app Create
Communication User, you
create the communication user.
In the app Communication

System, you create a system ID
pointing to the system in which
the attachment is to be created.
For the new system, enter the
communication user name as
one of the Users for Inbound
Communication.
In the app Communication

Arrangement, you enter your
communication user name and
the system for the scenario ID
SAP_COM_0053. In the
Inbound Services section, you
can copy the Service URL /
Service Interface for the
attachment service and use it as
url.
Slug De nes the le name and le type. Example: saptest.txt
Content-Type De nes the mime type of the attachment. Example: Text/plain
Related Information
Attachments
Purchase Order (Inbound, Asynchronous)

Technical name: PurchaseOrderRequest_In
This asynchronous inbound SOAP service enables you to create a purchase order, using an API call from a source system
outside of SAP S/4HANA Cloud. You can also use this service to update and delete existing purchase order data from the SAP
S/4HANA Cloudsystem.
 Note
In this service, various eld combinations are possible, depending on the con guration settings.
The following item categories are supported:
1/30/2023
“ ” (standard), allowing you to order material items (product type group “1”) and lean services (product type group “2”)
“E” (enhanced limit), allowing you to do the following:
De ne a limit amount against which invoices can be posted (using product type group “1”)
De ne a limit amount for unplanned services that must be con rmed in a service entry sheet (using product type
group “2”)
“S ” (third-party), allowing you to order materials and having them delivered to a delivery address outside your company,
for example, to your customer
Service Request
The service message header contains information on the service, the involved sender and receiver, as well as date and time. The
following elds are mandatory:
Node or Field Description Necessity
CreationDateTime Date and time of message creation Mandatory
SenderBusinessSystemID ID of the external system sending the Mandatory

message; must be unique in SAP S/4HANA
Service Nodes
The service node “PurchaseOrder” and its sub nodes contain the business data of the service.
 Note
In the following table, attributes are marked in blue.
ActionCode Identi es the action performed by the service (1: Mandatory

create, 2: update, 3: delete)
PurchaseOrderID Alphanumeric key uniquely identifying the Mandatory for updating and deleting
document; this ID is generated when the purchase orders
purchase order is created. It is communicated to
the service consumer with the service Purchase
Order - Send Status Update Noti cation
PurchaseOrderStatusNotification_Out
service.
PurchaseOrderExternalReferenceID If purchase order was created on the basis of a Mandatory for creating purchase
purchase order from an external system, this is orders
the ID in the external system.
The eld where this ID is used is case-sensitive.

Together with the SenderBusinessSystemID,
this eld must uniquely identify the source
document.
1/30/2023
DocumentType Identi er allowing to differentiate between the Mandatory

various kinds of purchasing documents in the
SAP system. On the basis of the purchasing
document type, you can, for example,
distinguish between a purchase order, an RFQ,
and a scheduling agreement. The purchasing
document type controls, for instance, the
number assignment of a purchase order, as well
as the selection of the elds to be maintained.
Prerequisite for using the DocumentType eld

is that in the con guration of the document type,
the following elds are empty:
Control indicator for purchasing

document type
Stock transfer: Take supplier data into

account
Cross-system transit
Store return with inbound and outbound

delivery
Advanced returns management active
PurchasingGroup Group of purchasers who are responsible for Mandatory

certain purchasing activities.
CompanyCode An organizational unit within nancial accounting. Mandatory
DocumentCurrency Currency key for amounts in the system. Must Mandatory

be provided in ISO format.
SupplierParty PurchaseOrderRequest_In - SupplierParty Mandatory
InvoicingParty Alphanumeric key denoting the supplier Optional

(creditor) invoicing the ordered material or
services performed, to whom the amount due is
payable. When the invoice is received, the
number of the invoicing party is inserted in the
invoice in place of the actual supplier.
ExchangeRate PurchaseOrderRequest_In - ExchangeRate Optional
PaymentTerms PurchaseOrderRequest_In - PaymentTerms Optional
HeaderIncoterms PurchaseOrderRequest_In - HeaderIncoTerms Optional
IsIntrastatReportingRelevant Indicates that the document is relevant for Optional

Intrastat reporting
IsIntrastatReportingExluded Indicates that the document Is excluded from Optional

Intrastat reporting
CorrespncExternalReference The internal reference number of the supplier. It Optional

usually identi es the individual who is
responsible for the document at the supplier
site. It can, for example, be the person's initials.
1/30/2023
CorrespncInternalReference Your company's internal reference number or Optional

code. It usually identi es the person responsible
for the purchasing document in your company.
The reference number/code often consists of the
relevant person's initials.
PurchaseOrderItem PurchaseOrderRequest_In - PurchaseOrderItem Mandatory
Attachment Optional
FileName
MimeType
FileSize
Sample Payload
 Sample Code
<n0:PurchaseOrderRequest xmlns:n0="http://sap.com/xi/Procurement">
<MessageHeader>
<CreationDateTime>2018-02-27T12:00:00.1234567Z</CreationDateTime>
<SenderBusinessSystemID>AUNIT</SenderBusinessSystemID>
</MessageHeader>
<PurchaseOrder>
<ActionCode>1</ActionCode>
<PurchaseOrderID/>
<PurchaseOrderExternalReferenceID>1</PurchaseOrderExternalReferenceID>
<DocumentType>NB</DocumentType>
<PurchasingOrganization>0001</PurchasingOrganization>
<PurchasingGroup>001</PurchasingGroup>
<CompanyCode>0001</CompanyCode>
<DocumentCurrency>EUR</DocumentCurrency>
<SupplierParty>
<Supplier>4171</Supplier>
<SupplierAddress>
<AddressName>P U Company</AddressName>
<Street>Ottostr.</Street>
<Dummy>asdf asdfsdf</Dummy>
<HouseNumber>33</HouseNumber>
<PostalCode>74918</PostalCode>
<City>Angelbachtal</City>
<CountryKey>DE</CountryKey>
<Region>08</Region>
<Phone>
<CountryCode>DE</CountryCode>
<PhoneNumber>07265</PhoneNumber>
<PhoneNumberExtension>2255</PhoneNumberExtension>
</Phone>
<Fax>
<CountryCode>DE</CountryCode>
<FaxNumber>07265</FaxNumber>
<FaxNumberExtension>2266</FaxNumberExtension>
</Fax>
</SupplierAddress>
</SupplierParty>
<InvoicingParty>4171</InvoicingParty>

<PurchaseOrderItem>
<PurchaseOrderItemExternalRefID>MAT1</PurchaseOrderItemExternalRefID>
<ItemCategory> </ItemCategory>
<ProductType>1</ProductType>
<Material/>
<MaterialGroup>L001</MaterialGroup>
<ItemDescription>Sideboard, white</ItemDescription>
<Plant>0001</Plant>
<DeliveryDate>2018-04-01</DeliveryDate>
1/30/2023
<RequestedQuantity unitCode="PCE">3</RequestedQuantity>
<ItemPrice>
<Amount currencyCode="EUR">65.00</Amount>
<BaseQuantity unitCode="PCE">1</BaseQuantity>
</ItemPrice>
<AccountAssignment>
<AccountAssignmentCategory>K</AccountAssignmentCategory>
<MultipleAcctAssgmtDistribution> </MultipleAcctAssgmtDistribution
<PartialInvoiceDistribution> </PartialInvoiceDistribution>
<AccountAssignmentLine>
<CostCenter>SAP-DUMMY</CostCenter>
<GLAccount>400000</GLAccount>
</AccountAssignmentLine>
</AccountAssignment>
<ProcessFlow>
<GoodsReceiptIsExpected>true</GoodsReceiptIsExpected>
<InvoiceIsExpected>true</InvoiceIsExpected>
<InvoiceIsGoodsReceiptBased>true</InvoiceIsGoodsReceiptBased>
</ProcessFlow>
</PurchaseOrderItem>

<PurchaseOrderItem>
<PurchaseOrderItemExternalRefID>MAT2</PurchaseOrderItemExternalRefID>
<Material>CM_HAWA</Material>
<MaterialGroup/>
<ItemDescription/>
<Plant>0001</Plant>
<ItemPrice>
</ItemPrice>
<ProcessFlow>
</ProcessFlow>
<DeliveryDetails>
<StorageLocation>0001</StorageLocation>
</DeliveryDetails>

<PurchaseOrderItem>
<PurchaseOrderItemExternalRefID>SRV1</PurchaseOrderItemExternalRefID>
<Material/>
<MaterialGroup>P001</MaterialGroup>
<ItemDescription>Software Hotline Service</ItemDescription>
<Plant>0001</Plant>
<PerformancePeriod>
<StartDate>2018-04-01</StartDate>
<EndDate>2018-04-04</EndDate>
</PerformancePeriod>
<RequestedQuantity unitCode="HUR">12</RequestedQuantity>
<ItemPrice>
<BaseQuantity unitCode="HUR">1</BaseQuantity>
</ItemPrice>
<AccountAssignment>
<ProcessFlow>
1/30/2023
</ProcessFlow>

<PurchaseOrderItem>
<PurchaseOrderItemExternalRefID>SRV2</PurchaseOrderItemExternalRefID>
<Material>CM_SERV</Material>
<ItemDescription>Gardening - Spring</ItemDescription>
<Plant>0001</Plant>
<PerformancePeriod>
<RequestedQuantity unitCode="HUR">6</RequestedQuantity>
<ItemPrice>
<BaseQuantity unitCode="HUR">1</BaseQuantity>
</ItemPrice>
<AccountAssignment>
<ProcessFlow>
</ProcessFlow>

<PurchaseOrderItem>
<PurchaseOrderItemExternalRefID>LIMIT1</PurchaseOrderItemExternalRefID>
<ItemCategory>E</ItemCategory>
<Material/>
<ItemDescription>Hardware Repair</ItemDescription>
<Plant>0001</Plant>
<PerformancePeriod>
<CostUpperLimit>
<OverallLimitAmount currencyCode="EUR">50</OverallLimitAmount>
<ExpectedOverallLimitAmount currencyCode="EUR">45</ExpectedOveral
<PriceChangeAllowedIndicator>true</PriceChangeAllowedIndicator>
<OverallLimitAmountIsUnlimited>false</OverallLimitAmountIsUnlimit
</CostUpperLimit>
<AccountAssignment>
<AccountAssignmentCategory>U</AccountAssignmentCategory>
<ProcessFlow>
</ProcessFlow>

<PurchaseOrderItem>
<PurchaseOrderItemExternalRefID>LIMIT2</PurchaseOrderItemExternalRefID>
1/30/2023
<ItemCategory>E</ItemCategory>
<Material/>
<ItemDescription>Office Supply</ItemDescription>
<Plant>0001</Plant>
<PerformancePeriod>
<CostUpperLimit>
<OverallLimitAmount currencyCode="EUR">5</OverallLimitAmount>
<ExpectedOverallLimitAmount currencyCode="EUR">2</ExpectedOverall
<PriceChangeAllowedIndicator>true</PriceChangeAllowedIndicator>
<OverallLimitAmountIsUnlimited>false</OverallLimitAmountIsUnlimit
</CostUpperLimit>
<AccountAssignment>
<AccountAssignmentCategory>U</AccountAssignmentCategory>
<ProcessFlow>
<GoodsReceiptIsExpected>false</GoodsReceiptIsExpected>
<InvoiceIsGoodsReceiptBased>false</InvoiceIsGoodsReceiptBased>
</ProcessFlow>

<PurchaseOrderItem>
<PurchaseOrderItemExternalRefID>THPA</PurchaseOrderItemExternalRefID>
<ItemCategory>S</ItemCategory>
<ProductType/>
<Material>CM_HAWA</Material>
<MaterialGroup/>
<ItemDescription/>
<Plant>0001</Plant>
<ItemPrice>
</ItemPrice>
<AccountAssignment>
<AccountAssignmentCategory>S</AccountAssignmentCategory>

<ProcessFlow>
</ProcessFlow>
<DeliveryAddress>
<AddressName>Kunde A</AddressName>
<Street>Hammerweg</Street>
<City>Buxtehude</City>
<CountryKey>DE</CountryKey>
<District/>
<Region/>
</DeliveryAddress>
</PurchaseOrder>
</n0:PurchaseOrderRequest>
Required Communication Scenario

1/30/2023
To be able to use this service, you have to con gure communication scenario SAP_COM_0238.
Message Monitoring and Error Handling

To be able to monitor messages transferred by this service, you need to assign the following recipient to the users:
Namespace: /MMPUR
Recipient Name: MMPUR_PURCH_ORDER_IN
Interface: PO_IN
To assign users to recipients, use the Assign Recipients to Users app from the Communication Management – Message
Monitoring Con guration (SAP_CA_BC_COM_CONF_PC) business catalog.
For message monitoring, use the Message Dashboard app from the Communication Management - Message Monitoring and
Error Handling (SAP_CA_BC_COM_ERR_PC) business catalog.
Both business catalogs are contained in the business role template Con guration Expert – Business Network Integration
(SAP_BR_CONF_EXPERT_BUS_NET_INT).
Authentication Method
For this service, use your user ID and password to sign on.
Extensibility
This service can be extended at header and at item level, using the app Custom Logic. The business contexts are:
Procurement: Purchasing Document (MM_PURDOC_HEADER)
Procurement: Purchasing Document Item (MM_PURDOC_ITEM)
PurchaseOrderRequest_In - SupplierParty
Nodes and Fields of the Supplier Party Node
Supplier Supplier ID Mandatory
SupplierAddress Optional
AddressName Name of the supplier

company
Street Street name as part of

the address.
HouseNumber House number as part of

an address. It is printed
in the Street line.
1/30/2023
PostalCode Postal code as part of

the address. If different
postal codes are
maintained for the PO
Box and street address
of an address, this eld
contains the street
address postal code.
City City name as part of the

address.
CountryKey The country key contains

information which the
system uses to check
entries such as the
length of the postal code
or bank account number.
District
Region In some countries, the

region forms part of the
address. The meaning
depends on the country.
Phone
CountryCode The country for the

telephone number.
PhoneNumber Telephone number,

consisting of dialing
code and number, but
without country dialing
code.
PhoneNumberExtension Telephone extension

number.
Fax
CountryCode The country for the fax

number.
FaxNumber Fax number, consisting

of dialing code and
number, but without
country dialing code. If
the fax number consists
of a company number
and an extension
number, enter the
extension number in the
Extension eld.
FaxNumberExtension Fax extension number.
 Note
1/30/2023
To display more information about the service node, select the operation. This works best in Mozilla Firefox or Google
Chrome.
PurchaseOrderRequest_In - ExchangeRate
Fields of the ExchangeRate Node
Field Description
Rate Rate used by the system when translating gures from a foreign
currency into the local currency.
ExchangeRateFixedIndicator Determines that the exchange rate that is used for currency
translation in the document is xed.
 Note
Chrome.
PurchaseOrderRequest_In - PaymentTerms
Fields of the PaymentTerms Node
Field Description
PaymentTermsID Key for de ning payment terms composed of cash discount

percentages and payment periods.
CashDiscount1Percent Cash discount percentage rate applied to the shortest payment

period.
CashDiscount1Days Number of days for the shortest payment period. In conjunction

with the baseline date for payment, this number represents a
payment period or period of quali cation for discount.
CashDiscount2Percent Cash discount percentage rate applied to the second payment

period.
CashDiscount2Days Number of days for the second payment period. In conjunction with
the baseline date for payment, this number represents a payment
period or period of quali cation for discount.
CashDiscount3Days Number of days. In conjunction with the baseline date for payment,
this number represents a payment period or period of quali cation
for discount.
 Note
Chrome.
1/30/2023
PurchaseOrderRequest_In - HeaderIncoTerms
Fields of the HeaderIncoTerms Node
Field Description
IncotermsClassi cation Commonly used trading terms that comply with the standards
established by the International Chamber of Commerce (ICC).
IncotermsVersion An incoterms version is an edition of the international terms for

transportation that is de ned by the International Chamber of
Commerce (ICC).
IncotermsLocation1 Provides additional information for the primary Incoterm.
IncotermsLocation2 Provides additional information for the Incoterms.
 Note
Chrome.
PurchaseOrderRequest_In - PurchaseOrderItem
Service Nodes and Fields
 Note
ActionCode Identi es the action performed for the item (1: create, 2: Mandatory for updati
update, 3: delete)
PurchaseOrderItemID Speci es the number that uniquely identi es an item in a Optional

purchasing document. When a purchase order is created
 Note and no PurchaseOrderItemID is speci ed in the request, an
internal number from the item number interval is used in the
For any purchase order item, either the
purchase order item.
PurchaseOrderItemID or the
This number can be used as the reference ID in the update
PurchaseOrderItemExternalRefID must
case.
be provided.
PurchaseOrderItemExternalRefID This number can be used as the reference ID in the update Mandatory when crea
case. order.
 Note Optional when updati
purchase order and if
For any purchase order item, either the
PurchaseOrderIt
PurchaseOrderItemID or the
is available.
PurchaseOrderItemExternalRefID must
be provided.
1/30/2023
ItemCategory Indicator which shows the item features. Mandatory

The item category controls whether the following entries and
procedures are necessary or permitted for the item:
Material number
Additional account assignment
Inventory management in the SAP System
Goods receipt
Invoice receipt
Supported categories are Standard (' '), Third party ('S'),

Enhanced limit ('E')
IsReturnsItem Speci es whether or not the item is a returns item. A returns

item is a returned good from a customer to an internal or
external supplier.
ProductType Superordinate term that covers products that can be Mandatory

procured.In the product type group you choose to either
procure a material (by entering 1) or a service (by entering
2). The procurement process is different for materials and
services.
Material Uniquely identi es a material. Optional
MaterialGroup Key that you use to group several materials or services with Mandatory, except fo
the same attributes, and to assign them to a particular items (item category
material group.
ItemDescription Short description of the material. Mandatory
Plant Speci es the key for a production facility or branch office Mandatory
within the company (that is, the company code). You use the
plant key to determine, for instance, which plant is to
receive ordered goods.
DeliveryDate Date on which an item is to be delivered or the service Mandatory for materi
provided.
PerformancePeriod Mandatory for service
StartDate Mandatory for service
EndDate Mandatory for service
ServicePerformer A person who performs a service. Optional
Customer Number of the customer to whom a material is to be Optional

delivered or for whom a service is to be rendered. This entry
is used in third-party order processing (triangular business
arrangements). When you enter a customer number, the
delivery address is taken from the customer master record.
If you do not enter a customer number, you must enter a
delivery address.
1/30/2023
InternationalArticleNumber The International Article Number (EAN) is a standardized Optional

unit that uniquely identi es a material relating to a unit of
measure or type of packaging.
The International Article Number is assigned by the

manufacturer of the material. In this case, the EAN identi es
the manufacturer uniquely. A company can assign EANs
using "in-store" numbering techniques known only to the
company.
The equivalent of the EAN in America is the Universal

Product Code (UPC).
EvaluatedReceiptSettlementIsAllowed Indicator that speci es that evaluated receipt settlement Optional

(ERS) or the automatic generation of invoices according to
an invoicing plan is to be possible for this document item.
Prerequisite is that the supplier is enabled for ERS in your
SAP S/4HANA Cloud system.
 Note
If the supplier is enabled for ERS and the eld
EvaluatedReceiptSettlementIsAllowed
is not included in the message you send to SAP
S/4HANA Cloud, then the system determines
that the purchase order item is enabled for ERS.
If the supplier is enabled for ERS and you want

to avoid that the system determines that the
purchase order item is enabled for ERS, you
have to include the eld
EvaluatedReceiptSettlementIsAllowed
in your message and ll it with a blank value.
RequestedQuantity Quantity ordered by the buyer, to be supplied by the N/A for limit items, m
supplier. The purchase order quantity relates to the order materials and service
unit.
unitCode Unit of measure in which the material is ordered.
ItemPrice PurchaseOrderRequest_In - ItemPrice N/A for limit items, m

materials and service
CostUpperLimit Mandatory for limit it
OverallLimitAmount Maximum value that the total of all unplanned services (or Mandatory
the value of the material) covered by this document item
may not exceed.
currencyCode Currency of OverallLimitAmount Mandatory
ExpectedOverallLimitAmount Value that the unplanned services (or the material) covered Mandatory
by this item are not expected to exceed.
currencyCode Currency of ExpectedOverallLimitAmount Mandatory
AccountAssignment PurchaseOrderRequest_In - AccountAssignment Mandatory
ItemIncoterms Optional
1/30/2023
IncotermsClassification Commonly used trading terms that comply with the Optional
standards established by the International Chamber of
Commerce (ICC).
IncotermsLocation1 Provides additional information for the primary Incoterm. Optional
IncotermsLocation2 Provides additional information for the Incoterms. Optional
ItemTax Optional
TaxCode The tax code represents a tax category which must be taken Optional
into consideration when making a tax return to the tax
authorities. Tax codes are unique per country. The tax rate
calculation rules and further features are stored in a table
for each tax code.
TaxJurisdiction The tax jurisdiction is used for determining the tax rates in Optional
the USA. It de nes to which tax authorities you must pay
your taxes. It is always the city to which the goods are
supplied.
PurchaseRequisitionReference Optional
PurchaseRequisitionID Alphanumeric key uniquely identifying the document. Optional
PurchaseRequisitionItemID Number that uniquely identi es an item in a purchase Optional

requisition.
ProcessFlow Optional
GoodsReceiptIsExpected Speci es whether the item involves a goods receipt. In case Optional
of service items, this indicator is used for service entry
sheets.
GoodsReceiptIsNonValuated Speci es that the goods receipt for this item is not to be Optional
valuated. If the indicator is set, the valuation of the
purchase order item will take place at the time of invoice
veri cation.
InvoiceIsExpected Speci es whether an invoice receipt is linked to the Optional

InvoiceIsGoodsReceiptBased Indicator specifying that goods-receipt-based invoice Optional

veri cation will be performed for a purchase order item or
invoice item.
IsCompletelyDelivered Indicates that the item is to be regarded as closed. Optional
IsFinalIyInvoiced Indicates that the last invoice from a supplier has been Optional
received for an item and/or that no further invoice is
expected.
DeliveryDetails Optional
OverdeliveryToleranceInPercent Percentage (based on the order quantity) up to which an Optional

overdelivery of this item will be accepted.
UnderdeliveryToleranceInPercent Percentage (based on the order quantity) up to which an Optional

underdelivery of this item will be accepted.
UnlimitedOverdeliveryAllowed Indicator that speci es whether unlimited overdelivery can Optional

be accepted for the item.
1/30/2023
StorageLocation Number of the storage location in which the material is Optional

stored. A plant may contain one or more storage locations.
DeliveryAddress Optional
AddressName Name within an address. Optional
Street Street name as part of the address. Optional
HouseNumber House number as part of an address. Optional
PostalCode Postal code as part of the address. If different postal codes Optional
are maintained for the PO Box and Street address of an
address, this eld contains the Street address postal code.
City City name as part of the address. Optional
CountryKey The country key contains information which the system uses Optional
to check entries such as the length of the postal code or
bank account number.
District Optional
Region In some countries, the region forms part of the address. The Optional
meaning depends on the country.
Phone Optional
CountryCode The country for the telephone number. Optional
PhoneNumber Telephone number, consisting of dialing code and number, Optional

but without country dialing code. If the telephone number
consists of a company number and an extension, the
extension must be entered in the eld extension.
PhoneNumberExtension Telephone extension number. Optional
Fax Optional
CountryCode The country for the fax number. Optional
FaxNumber Fax number, consisting of dialing code and number, but Optional
without country dialing code. If the fax number consists of a
company number and an extension number, enter the
extension number in the Extension eld.
FaxNumberExtension Fax extension number. Optional
 Note
Chrome.
PurchaseOrderRequest_In - AccountAssignment
Nodes and Fields of the AccountAssignment Node

The list below includes all elds that can be used for the different account assigment categories. Which elds are mandatory
depends on the account assignment categories that are used.
1/30/2023
 Note
Node or Field Description
AccountAssignmentCategory The account assignment category

determines which account assignment
details are required for the item (for
example, cost center or account number).
MultipleAcctAssgmtDistribution Distribution indicator for multiple account

assignment. The following values are
supported:
“1” - Distribution on Quantity
Basis
“2” - Distribution by Percentage
“3” - Distribution by Amount
PartialInvoiceDistribution Determines how invoice amounts in

partial invoices are to be distributed. The
following values are supported:
“ ” - Derive from Account

Assignment Category
“1” - Distribute in Sequence
“2” - Distribute Proportionally
AccountAssignmentLine Line belonging to the purchase order item

that contains the account assignment
data
POAccountAssigmentEntity MultipleAcctAssgmtDistrQty Quantity assigned to one account

assignment line (in case of multiple
account assignment)
unitCode Unit of measure of

MultipleAcctAssgmtDistrQty
MultipleAcctAssgmtDistrPercent Percentage of the total order quantity that

you want to allocate to this account
assignment item. The percentage entered
determines what percentage of the costs
is to be distributed to this account
assignment item. The total of the
percentages must equal 100%.
This value is mandatory if
MultipleAcctAssgmtDistribution
is “2” - Distribution by Percentage.
NetValueAmount Value of the purchase order (including

discounts and surcharges).
This value is mandatory if
MultipleAcctAssgmtDistribution
is “3” - Distribution by Amount.
currencyCode Currency code of the NetValueAmount
1/30/2023
BusinessArea Key that uniquely identi es a business

area.
CommitmentItem Alphanumeric code of the commitment

item you are creating, changing,
displaying, or to which you are assigning
budget.
ControllingArea The controlling area is the highest

organizational unit in Controlling.
CostCenter Cost center
CostObject Cost objects are the activity units of

businesses whose costs are assigned
based on the cost origins. The SAP
system distinguishes between the
following types of cost objects:
Cost objects represented by a

cost object ID
Cost objects represented by

objects from other components,
such as production orders or
sales order items
EarmarkedFundsDocument Document within Funds Management that

can reserve budget already distributed
for revenues or expenditures to be
expected.
FixedAsset This is the number which, together with

the main asset number, uniquely
identi es a xed asset in Asset
Accounting.
Fund Key which uniquely identi es the fund.

Funds represent nancial resources that
are provided for a speci c purpose by a
sponsor and managed separately. This
enables the exact source of the funds to
be determined.
FundsCenter Alphanumeric code for the funds center.

Within the organizational unit, the funds
centers represent the structural grouping
into departments, areas of responsibility,
projects, and so on.
GLAccount G/L Account Number. A G/L account

stores changes in value relating to assets,
payables, stockholders' equity, revenues,
or expenses of a company.
MasterFixedAsset This is the number which, together with

the asset sub-number, identi es a xed
asset in Asset Accounting.
1/30/2023
NetworkActivity A network can structure an entire project

or a task within a project. Numbers are
used to differentiate these project
structures. A network activity can be, for
example, planning, analyzing, controlling
and monitoring schedules, dates, and
resources.
NetworkActivityInternalID Network Activity Internal ID
OrderID Key that uniquely identi es an order

within a client.
ProfitabilitySegment An object within Pro tability Analysis to

which costs and revenues are assigned.
ProfitCenter An organizational center that represents

an area of a company for which a separate
period-based pro t is determined and
used for pro t-oriented analysis and
management of the area´s activities.
ProjectNetwork A project network represents the

sequence of activities in a project or the
project.
ProjectNetworkInternalID Routing number of operations in the order.
RealEstateObject Internal key for real estate object.
SalesOrder Number that uniquely identi es the sales,

delivery, or billing document. A sales
order is an agreement between a seller
and a customer concerning the sale and
delivery of goods, as well as any services
that are associated with these processes,
on a speci c date, for a speci c quantity,
and for a speci c price.
SalesOrderItem Number that uniquely identi es the item

in the sales document.
SalesOrderScheduleLine Number that uniquely identi es the

schedule line in the sales document.
When an item has more than one schedule
line, the system automatically assigns a
unique number to each line. The number
is displayed in the details screens for
schedule lines.
The schedule line number serves internal
purposes and does not, for example,
determine the sequence of schedule lines
in the overview screen. The schedule lines
on the overview screen are sorted by
date.
WBSElementInternalID Key that identi es a WBS element (work

breakdown structure element).
 Note
1/30/2023
Chrome.
PurchaseOrderRequest_In - ItemPrice
 Note
Nodes and Fields of ItemPrice
Amount Net price per price unit. Mandatory
currencyCode Currency of Amount
BaseQuantity Speci es how many Mandatory

units of the purchase
order price unit the price
is valid for.
unitCode Unit of measure of

BaseQuantity
PriceCondition Price condition Optional
ConditionType Fix amount discounts Mandatory, if price

and surcharges are conditions are used
supported.
ConditionAmount Condition amount Mandatory, if price

conditions are used
currencyCode Currency code of Mandatory, if price

ConditionAmount conditions are used
Purchase Order – Send, Update, Cancel

Technical name: OrderRequest_Out
This asynchronous outbound service enables you to transfer purchase order messages between your SAP S/4HANA buyer
system and an external supplier system. A purchase order is created in the SAP S/4HANA buyer system which is relevant for
XML message exchange processing with a supplier system. Whenever such a purchase order is saved in the system, a
corresponding XML message is created and is transferred to the corresponding buyer system.
Automating the document exchange of purchase orders between suppliers and buyers saves time and effort.
Purchase order sends XML message through this API during create and update operations. Purchase order for goods
purchasing of material items can be exchanged through this API. Purchase orders for drop shipment scenario that is created
from purchase requisiotion generated from Third Party Sales orders is supported. This API is relevant for the scope items 2EJ
(Integration of Procurement with External Suppliers) and 42K (Automation of Source-to-Pay with Ariba Network).
Service Structure
1/30/2023
The service contains a message header and a payload, containing the header and item information.

The service message header contains information about the service, the involved sender and receiver as well as date and time.
Service Nodes
The service nodes contain the business data of the service.
Service Node Descriptions Link to details
MessageHeader Message header information OrderRequest_Out - MessageHeader
Order Order header information OrderRequest_Out - Order
Party Business partner information OrderRequest_Out - Party
PaymentTerms Payment terms OrderRequest_Out - PaymentTerms
PaymentCard Payment card information OrderRequest_Out - PaymentCard
Text Long text on the order header and Item OrderRequest_Out - Text
OrderItem Order item information OrderRequest_Out - OrderItem
Product Product information OrderRequest_Out - Product
ScheduleLine Schedule line OrderRequest_Out - ScheduleLine

Namespace: /MMEDI
Recipient Name: EDI_MM_ORDER_RECIPIENT
Interface: ORDREQOUT
Constraints
Transferring attachments is not supported between SAP S/4HANA buyer system and an external supplier system.
Please note that the following elds related to attachments are not in use:
FileType
MimeType
1/30/2023
FileSize
Supplier address is not re ected in the purchase order output if it is added after the purchase order is created (in SAP
S/4HANA Cloud).
See SAP Note 3037036 to know about disruption in integration with third-party system due to change in sequence of
nodes in outgoing XML data.
OrderRequest_Out - MessageHeader
MessageHeader node contains information about the message such as date and time when it was created or ID of the sender
system.
Parameters
Parameters Description
ID ID of the SOAP message
ReferenceID Reference ID of the SOAP message
CreationDateTime Date and time at which the message was created. This information
is used to check for duplicate incoming messages and to avoid that
the same message is processed again.
ReconciliationIndicator Reconciliation Indicator
SenderBusinessSystemID Unique identi er of the external system that sends the message.
This information is used to send back response messages or
follow-on messages to the sender system.
RecipientBusinessSystemID Unique identi er of the external system that receives the message.
This information is used to receive messages or follow-on
messages from the sender system.
SenderParty ID of the business partner that sends the message to your SAP
S/4HANA Cloud system. The ID must be identical to the business
partner's ID in your SAP S/4HANA Cloud system.
RecipientParty ID of the business partner that receives the message from your
SAP S/4HANA Cloud system. The ID must be identical to the
business partner's ID in your SAP S/4HANA Cloud system.
BusinessScope Business scope
OrderRequest_Out - Order
Header node that contains the Order header elds.
Parameters
Parameter Description Necessity
ActionCode Action code Optional
PurchaseOrderID Purchase order number Mandatory
PurchasingDocumentType Purchase order document type Optional
CompanyCode Company code used in the purchase order Optional
1/30/2023
CompanyCodeName Company code name used in the purchase Optional

order
PurchasingOrganization Purchasing organization Optional
PurchasingOrganizationName Purchasing organization name used in the Optional

purchase order
PurchasingGroup Purchasing group Optional
PurchasingGroupName Purchasing group name used in the Optional

purchase order
PurchaseOrderCreationDate Creation date Mandatory
PurchaseOrderDocumentDateTime Creation Time Mandatory
PurchaseOrderLastChangeDate Last change date Optional
SalesOrderID Sales order ID Optional
SalesDocumentType Sales document type Optional
SalesOrganization Sales organization Optional
DistributionChannel Distribution channel Optional
OrganizationDivision Organization division Optional
SalesGroup Sales group Optional
SalesOffice Sales office Optional
TransactionCurrency Transaction currency Optional
BuyerCompanyCodeCurrency Currency code Optional
BuyerExchangeRate Exchange rate Optional
BuyerVATRegistration This eld carries the VAT number as Optional

maintained in the company code associated
with the purchase order.
CorrespondenceExternalReference Reference Optional
BuyrCorrExternalReference This eld carries the data of the eld Your Optional
Reference maintained in the purchase
order.
BuyrCorrOwnReference This eld carries the data of the eld Our Optional
Reference maintained in the purchase
order.
ItemListIsCompletelyTransferred Indicator Optional
RetsMgmtIsActive Optional
Party Party Optional
RequestedDeliveryDate DO NOT USE Optional
RequestedDeliveryTime DO NOT USE Optional
RequestedDeliveryTimeZone DO NOT USE Optional
1/30/2023
RequestedDeliveryDateTime DO NOT USE Optional
UnloadingPointName Unloading location Optional
ReceivingPoint Receiving point Optional
DeliveryBlockReason Delivery block reason code Optional
CompleteDeliveryIsDefined Indicator Optional
OrderCombinationIsAllowed Indicator Optional
HeaderIncoterms
IncotermsClassification Incoterms classi cation Optional
PaymentCard Payment card Optional
Text Long text on order header Optional
OrderItem Order item Optional
Attachment Carries the name, type, and size of the Optional

attachment
 Note
Company details for example company code name, and purchasing organization name are untranslatable.
OrderRequest_Out - Party
Order node that contains the order party elds. This service node is a sub node of Order Item and Order Header.
Parameters
GlobalLocationNumber Standard ID Optional
BuyerPartyID Value depends on the attribute PartyType. See PartyType below for Optional
details.
SupplierPartyID Value depends on the attribute PartyType. See PartyType below for Optional
details.
Address This node carries details of the party address
FormOfAddress Form of address Optional
FormOfAddressName Expanded form of the address text Optional
1/30/2023
AddressName Address name 1 Optional
AddressAdditionalName Address name 2 Optional
StreetName Street name Optional
HouseNumber House number Optional
StreetAddressName This eld is a combination of the elds StreetName and HouseNumber. Optional
PostalCode Postal code Optional
CityName City Optional
Country Country Optional
District District Optional
Region Region (State, Province, Country) Optional
PhoneNumber Telephone number Optional
FaxNumber Fax number Optional
FaxExtension DO NOT USE
FaxCountryDialingCode DO NOT USE
FaxCountry DO NOT USE
EmailAddress This eld contains the email address of the supplier party as maintained
in the purchase order.
CorrespondenceLanguage Language key Optional
AddressTimeZone This eld is applicable only for the party type, ShipTo. This eld
carries the data of the eld Time Zone maintained in the delivery
address of the purchase order item.
ExternalAddressParserCode This eld is applicable only for the party type, SoldTo. If value of this
eld is 'B', then address carried in the API is buyer's company address,
and it is an external address for the supplier.
PartyType Describes type of the party.
Following party types are supported:
PartyType Use Case BuyerPartyID SupplierPartyID Address
1/30/2023
Sold-to Details Purchasing Supplier code in Company

contain organization the buyer code
value for number in system address,
the party to the buyer use the
whom the system custom
items are logic BAdI:
sold. Modify
Address
for SoldTo
Party Type
for the API
Purchase
Order -
Send,
Update,
Cancel to
modify this
address.
Ship-to Details Plant ID in Blank Plant

contain the buyer Address
information system
about the
plant.
Details Plant ID in Blank Default

contain the buyer Plant
information system Storage
about the Address
plant, but
plant
address is
not
maintained.
Details Plant ID in Blank Storage

contain the buyer Location
information system Address
about the (for the
plant and items)
storage
location is
assigned
separately
to items.
Details Blank Blank Address

contain (as entered
manual by the
address user)
entered by
the user
(purchase
order item
delivery
address).
1/30/2023
Details Blank Blank Address

contain the (as
address key maintained
as entered in the
by the user. address
key)
Bill-to Details Company Blank Company

contain Code in the Code
value for buyer system Address
the party to
whom the
items are
billed.
Supplier Details Supplier Blank Supplier

contain Code in the Business
supplier buyer system Partner
address. Address
Invoicing Details Invoicing Blank Invoicing

Party contain party ID in party
invoicing the buyer address
party system
addess.
Goods Details Goods Blank Goods

Supplier contain supplier supplier
goods Code in the address
supplier buyer system
address.
Copy Details Copy Blank Copy

Supplier contain supplier supplier
copy Code in the address
supplier buyer system
address.
OrderRequest_Out - PaymentTerms
Order node that contains the order payment terms elds. This service node is a sub node of Order Header.
Parameters
BuyerPaymentTermsID Buyer payment terms ID Optional
SupplierPaymentTermsID Supplier payment terms ID Optional
FixedValueDate Date Optional
CashDiscount1Percent Percentage of cash discount Optional
CashDiscount1Days Cash discount days Optional
1/30/2023
CashDiscount1Description Cash discount description Optional
CashDiscount2Percent Percentage of cash discount Optional
CashDiscount2Days Cash discount days Optional
CashDiscount2Description Cash discount description Optional
NetPaymentDays Net payment days Optional
NetPaymentDescription Net payment description Optional
OrderRequest_Out - PaymentCard
Order node that contains the order payment card elds.
Parameters
PaymentCardType Payment card type Optional
PaymentCardID Payment card ID Optional
PaymentCardValidityEndDate Payment card validity end date Optional
PaymentCardHolderName Payment card holder name Optional
PaymentCardBillingAmount Amount Optional
OrderRequest_Out - Text
Order node that contains the order text elds. This service node is a sub node of Order Item and Order Header.
Parameters
BuyerTextElementID Text ID Optional
SupplierTextElementID Text ID Optional
TextElementLanguage Text language Optional
TextElementText Text line Optional
TextElementTextFormat Tag column Optional
Type Text element type Mandatory
OrderRequest_Out - OrderItem
This service node contains the Order Item information.
1/30/2023
Parameters
IsChanged If this eld is marked as true, then it denotes Mandatory

that the changes are done in current purchase
order change. If this eld is marked as false,
then it denotes that the changes are done in
older purchase order change.
PurchaseOrderItemID Item ID Mandatory
PurgConfigurableItemNumber Con gurable item number Optional
PurchasingParentItem Parent item ID Optional
PurchasingIsItemSet If set is an item set Optional
PurgExternalSortNumber Sort number for the purchase order item Optional
PurchaseOrderItemCategory Item category Optional
SalesOrderItemID Sales order item ID Optional
SalesOrderItemCategory Sales order item category Optional
OrderItemText Item short text Optional
Limits Limit items Optional
ExpectedOverallLimitAmount Amount that the buying company plans to Optional

spend on the limit item
OverallLimitAmount Maximum amount that the buying company Optional

intends to spend on the limit item
ReturnInformation Information about returns. The information in Optional

these eld tells you whether a returned item
has to be replaced and why the order was
returned.
ReferenceDocument References to related documents, for example, Optional

the order ID in an external system.
RequestedQuantity Requested quantity Optional
UnitCode Requested quantity unit code Optional
Product Product Optional
GlobalTradeItemNumber Global trade item number Optional
BuyerProductId Product Id maintained in the buyer system. Optional
SupplierProductId Product Id maintained in the supplier system. Optional
ManufacturerPartNumber This eld carries the data of the eld Mfr Part Optional
Number maintained in the tab Material Data of
the purchase order item.
Manufacturer This eld carries the data of the eld Optional

Manufacturer maintained in the tab Material
Data of the purchase order item.
1/30/2023
ManufacturerName This eld carries the data of the eld Optional

manufacturer name maintained in the tab
Material Data of the purchase order item.
ExpectedNetPrice Net price Optional
Amount Amount Optional
CurrencyCode Currency for net price Optional
BaseQuantity Quantity Optional
UnitCode Unit for quantity Optional
PurchasingPriceIsEstimated This eld carries the value of estimated price Optional

indicator as maintained in the purchase order
item.
PriceIsToBePrinted This eld carries the value of the print price Optional
indicator as maintained in the purchase order
item.
POPriceUnitToPOUnitNumerator This eld carries the numerator data of the Optional

eld Over Unit ↔ Order Price Unit maintained
in the purchase order.
POPriceUnitToPOUnitDenominator This eld carries the denominator data of the Optional

eld Over Unit ↔ Order Price Unit maintained
in the purchase order item.
ExpectedNetAmount Amount Optional
CurrencyCode Currency for net price Optional
MaximumNumberOfPartialDelivery Maximum number of partial delivery Optional
UnloadingPointName Indicator Optional
ReceivingPoint Receiving point Optional
Batch Batch details on supplier and buyer systems Optional
BuyerPartyBatch Batch details on the buyer system Optional
SupplierPartyBatch Batch details on the supplier system Optional
Party Party Optional
ItemIncoterms
IncotermsClassification Incoterms classi cation Optional
Text Long text on order item Optional
BuyerTextElementID Text element id on the buyer system Optional
SupplierTextElementID Text element id on the supplier system Optional
TextElementLanguage Language of the text element Optional
TextElementText Text of the text element Optional
1/30/2023
TextElementTextFormat Format of the text element Optional
SubcontrgCompIsRealTmeCnsmpn This eld is not in use. NA
ScheduleLine Schedule line Optional
PurchaseOrderScheduleLine Purchase order schedule line number Optional
RequestedDeliveryDate Requested delivery date Optional
RequestedDeliveryTime Requested delivery time Optional
RequestedDeliveryTimeZone Contains time zone de ned in the delivery Optional

address of the purchase order, if the time zone
is not de ned in the purchase order, then the
system time zone is used in this eld.
 Note
A business add-in Determine Time Zone of
Delivery Address for Purchase Order
Items:
(BADI_ORDREQOUT_DLVADDR_TIMZONE)
is available, this business add-in can be
used to determine time zone of a purchase
order item.
RequestedDeliveryDateTime Contains date, time, and time zone offset Optional

de ned in the purchase order.
ScheduleLineOrderQuantity Schedule line order quantity Optional
ConfirmedDeliveryDate Con rmed delivery date Optional
ConfirmedDeliveryTime Con rmed delivered time Optional
ConfirmedDeliveryTimeZone Con rmed delivery time zone Optional
ConfirmedDeliveryDateTime Con rmed delivery date time Optional
ConfirmedOrderQuantityByMaterialAvailableCheck Con med order quantity by material available Optional

check
VariantConfiguration This node enables you to send variant Optional

con guration data for a purchase order item.
Con gurable materials are complex products
that can be produced in different variants.
Refer VariantCon guration to know about
variant con guration attributes. Also, refer
Advanced Variant Con guration to know more
about advanced variant con guration.
OrderAcknowledgementRequired Indicator to show if order acknowledgement is Optional

mandatory or not.
Con rmationControlKey Contains the con rmation key id. A Optional

con rmation control key can be de ned with
just one or more con rmation categories (e.g.
shipping noti cation) and a con rmation
control key covering several con rmation
categories (order acknowledgment, loading
con rmation, shipping noti cation).
1/30/2023
ExpectedCon rmations > Con rmationSequence: Contains the sequence in which the individual Optional
Con rmationCategory con rmations de ned in a con rmation control
key are expected.
sequenceNumber
Con rmationCategory: Contains the
internal con rmation category key that
matches the supplier con rmation
document (expected by the buyer).
sequenceNumber: Contains the

con rmation category ID. The
con rmation category IDs are:
Order Acknowledgment: 1
Shipping Noti cation: 2
Rough Goods Receipt: 3
Purchase Order Change: 4
ExpectedConfirmations > ConfirmationSequence > Optional

Tolerance PermittedPriceOverrunInPct:
This eld carries the data of the eld
Permitted Price Overrun in %
maintained in the con guration step Set
up Con rmation Control.
PermittedPriceShortFallInPct:
Permitted Price Shortfall in %
maintained in the con guration step Set
up Con rmation Control.
UpperConfDateToleranceInDays:
Tol2Early maintained in the
con guration step Set up Con rmation
Control.
LowerConfDateToleranceInDays:
Tol2Late Tolerance Limit maintained in
the con guration step Set up
Con rmation Control.
PurgOvrdelivTolLmtRatioInPct This eld carries the data of the eld Optional

Overdelivery Tolerance Limit maintained in the
PurgUnderdelivTolLmtRatioInPct This eld carries the data of the eld Optional

Underdelivery Tolerance Limit maintained in
the purchase order item.
UnlimitedOverdeliveryIsAllowed This eld carries the data of the eld Unlimited Optional
Overdelivery Allowed maintained in the
IsCompletelyDelivered This eld carries the data of the eld Delivery Optional
Completed maintained in the purchase order
item.
1/30/2023
IsFinallyInvoiced This eld carries the data of the eld Inv. Optional
Receipt maintained in the tab Invoice of the
EvaldRcptSettlmtIsAllowed This eld carries the data of the eld Eval. Optional
Receipt Settlement maintained in the purchase
order item.
IsBlocked This eld carries the ag that states if the Optional

purchase order item is blocked or not.
PurchaseContract Carries the purchase contract ID that is Optional

associated to the purchase order.
PurchaseContractItem Carries the purchase contract item ID that is Optional

associated to the purchase order.
PurContractForOverallLimit Carried the purchase contract number that is Optional

associated with the purchase order for limit
items.
BuyerVATRegistration This eld carries the VAT number as Optional

maintained in the purchase order. This VAT
value can be updated using the custom logic
BAdI: Determine VAT Number for Purchase
Order Items.
Plant Carries the plant number as maintained in the Optional

purchase order item.carries the plant number
as maintained in the purchase order item.
PlantName Carries the plant name as maintained in the Optional

StorageLocation Carries the storage location number as Optional

maintained in the purchase order item.
StorageLocationName Carries the storage location name as Optional

ShippingInstruction Carries the shipping instruction as maintained Optional

in the purchase order item.
ShippingInstructionName Carries the shipping instruction name as Optional

TaxDetails Refer Optional
ExternalReferences External references of the purchase order Optional
PurgDocExternalReference External reference for the purchase order Optional
PurgDocExternalSystem System of the external system for the purchase Optional

order
SerialNumber Serial number Optional
Attachment This sub-note carries the elds related to Optional

purchase order item attachments.
FileName This eld carries the name of the purchase Optional

order item attachment.
1/30/2023
MimeType This eld carries the media type of the Optional

purchase order item attachment.
FileSize This eld carries the le size of the purchase Optional

order item attachment.
VariantCon guration
The following table provides information for variours attributes available in variant con guration.
Node or Field De
VariantConfiguration VarConfignStatus Se
co
Cardinality: 0..1 yo
is
co
CharacteristicValuation Characteristic Sp
na
Cardinality: 0..unbounded
CharcValue Sp
va
CharcValueTo Sp
int
int
CharcValueIntervalType Sp
ex
low
up
Ap
de
CharcValueAssignmentType In
ch
co
VariantConditionFactor Sp
if
va
VarConfignStructureNode VarConfignStructureNodeID Sp
su
Cardinality: 0..unbounded co
yo
You can use this node for multi-
level variant con guration. For
VarConfignStrucParentNodeID Sp
single-level variant
pa
con gurations, leave the node
co
empty.
ro
em
1/30/2023
Node or Field De
IdentifierBOMItem Sp
re
Va
Th
ite
CharacteristicValuation Characteristic Sp
na
Cardinality: 0..unbounded
CharcValue Sp
va
CharcValueIntervalType Sp
ex
low
up
Ap
de
ch
co
ch
co
VariantConditionFactor Sp
if
va
Source So
OrderRequest_Out - Product
This service node contains the batch characteristics information. This service node is a sub node of Order Item.
Parameters
GlobalTradeItemNumber International article number (EAN/UPC) Optional
BuyerProductID Buyer product ID Optional
SupplierProductID Supplier product ID Optional
ManufacturerPartNumber This eld carries the data of the eld Mfr Optional
Part Number maintained in the tab Material
Data of the purchase order item.
Manufacturer This eld carries the data of the eld Optional

Manufacturer maintained in the tab
ManufacturerName This eld carries the data of the eld Optional

manufacturer name maintained in the tab
1/30/2023
OrderRequest_Out - ScheduleLine
This service node contains the hierarchy information regarding the batch split items. This service node is a sub node of service
node Order Item.
 Note
Parameters
Parameter Parameter/Attribute Description
RequestedDeliveryDate Requested delivery date
RequestedDeliveryTime Requested delivery time
ScheduleLineOrderQuantity Line quantity
RequestedDeliveryTimeZone Contains time zone de ned in the delivery

address of the purchase order, if the time zone
is not de ned in the purchase order, then the
system time zone is used in this eld.
 Note
A business add-in Determine Time Zone
of Delivery Address for Purchase Order
Items:
(BADI_ORDREQOUT_DLVADDR_TIMZONE)
is available, this business add-in can be
used to determine time zone of a purchase
order item.
RequestedDeliveryDateTime Contains date, time, and time zone offset

de ned in the purchase order.
UnitCode Unit for quantity
Con rmedDeliveryDate Delivery date
Con rmedDeliveryTime Delivery time
Con rmedOrderQuantityByMaterialAvailableCheck Con rmed quantity
UnitCode Unit for con rmed quantity
Service Lean service item
PerformancePeriodStartDate Start date of period of performance for the

lean service item
PerformancePeriodEndDate End date of period of performance for the lean

service item
Con rmedExpectedOverallLmtAmt DO NOT USE THIS FIELD

DO NOT USE THIS FIELD
UnitCode Unit for currency used for expected value
1/30/2023
Parameter Parameter/Attribute Description
SubcontractingComponentDetails This eld contains the information related to

subcontracting in the purchase order.
Information such as bill of material,
requirement date, and batch details is carried
with this eld.
BillOfMaterialItemNumber Item number for the bill of material item
SubcontractingComponentProduct Product code
QuantityInEntryUnit Quantity for item
RequirementDate Requirement date
BOMItemDescription Description of the bill of material item
Batch Batch number of the bill of material item
BOMItemCategory Category of the bill of material item
Batch, BuyerPartyBatch, DO NOT USE

SupplierPartyBatch
Purchase Order - Send Status Update Noti cation

Technical name: PurchaseOrderStatusNotification_Out
This asynchronous outbound service enables you to send status noti cations to an external system from the SAP S/4HANA
Cloud system if certain changes that are relevant for the business process have been made to a purchase order. This includes
noti cations upon creation, blocking and deletion of the purchase orders, as well as changes performed during the approval
process. Furthermore, messages are sent to notify the external consumer about completion and release status changes. You
can use this SOAP-based service only for purchase orders that were created via the inbound web service for purchase order
creation Purchase Order (PurchaseOrderRequest_In).
Service Structure
The request contains a MessageHeader node element and a PurchaseOrderHeader node element.
The PurchaseOrderHeader node element contains information on the purchase order ID, its reference ID, date and time of
the last change, and spreadsheets containing purchase order item list details and purchase order status list details.
This service covers the following purchase order item types:
0 (Material)
1 (Limit)
9 (Service)
 Note
You need to make sure that beside the general mandatory purchase order elds the elds SenderBusinessSystemID and
ReferenceID are lled in the XML structure. If you don't maintain these elds, no outbound message will be called.
This services sends a noti cation message with the following status information to the external consumer:
1/30/2023
Purchase Order Status Field Description
PROCSTAT This is the processing status of the purchase order. The following
statuses are available:
02 (Active)
03 (In Release)
05 (Release Completed)
08 (Rejected)
FRGRL This is the release status of the purchase order that indicates
whether the purchase order has already been released.
MEMORY This is the completion status of the purchase order that indicates
whether the purchase order has been completed.
LOEKZ This is the deletion indicator of the purchase order. The following
values are available:
S (Blocked)
L (Deleted)
The service message header contains information on the service, the involved sender and receiver as well as date and time.
Entities
MessageHeader Contains information about the message PurchaseOrderStatusNoti cation_Out -

such as date and time when it was created MessageHeader
or ID of the sender system.
PurchaseOrderHeader Contains information about purchase order PurchaseOrderStatusNoti cation_Out -

such as status of purchase order or item PurchaseOrderHeader
information.
Service Response
Field Name Value Description
PROCSTAT 02 Active
Purchase order is in status Active.
03 In Release
Purchase order is in status In Release.
05 Release Completed
Purchase order has been released.
1/30/2023
Field Name Value Description
08 Rejected
Purchase order has been rejected.
LOEKZ S Blocked
Purchase order is blocked.
L Deleted
Purchase order has been deleted.
MEMORY X Purchase order has been completed.
'' Purchase order has not yet been completed.
FRGL X Purchase order has already been released.
'' Purchase order has not yet been released.
Prerequisites
Mapping of external system and a logical port must exist to provide communication of the external consumer via this service
with the SAP S/4HANA system. You must create a communication user, a communication system and set up a communication
arrangement. To do so, you can use the following applications:
Maintain Communication Users
Maintain Communication Systems
Communication Arrangements
Please note, that an administrator role must be assigned to your user to enable you to perform this con guration.
PurchaseOrderStatusNoti cation_Out - MessageHeader
Parameters
ID ID of the message
UUID UUID of the message
ReferenceID Reference ID of the message
ReferenceUUID Reference UUID of the message
CreationDateTime Date and time when the message wwas created
SenderBusinessSystemID ID of the system that sent the message
RecipientBusinessSystemID ID of the system to which the message was sent
SenderParty Sender party
RecipientParty Recipient party
BusinessScope Business scope of the message
1/30/2023
PurchaseOrderStatusNoti cation_Out - PurchaseOrderHeader
Parameters
Parameter Subnodes Description
ID ID of the purchase order
ReferenceID Reference ID of the purchase

order
PurchaseOrderStatusList PurchaseOrderStatus Status of the purchase order
PurchaseOrderStatusType Status type of the purchase

order
PurchaseOrderStatusCode Status code of the purchase

order
PurchaseOrderItemList PurchaseOrderItem Purchase order item
ID ID of the item in the purchase

order
ReferenceID Reference ID of the item in the

purchase order
LastChangedDateTime Date and time of the last change

of the purchase order
Purchase Order – Send Noti cations for Item History Updates

Technical name: PurchaseOrderItemHistoryNotification_Out
This outbound service enables you to send noti cations from an SAP S/4HANA Cloud system to an external system when
changes to the purchase order history of an item have occurred. This is the case when a goods receipt or a supplier invoice has
been created for the purchase order item.
Prerequisite
The purchase requisitions on which the purchase order items are based must be created using the OData service Purchase
Requisitions - Read, Create, Update, Delete (API_PURCHASEREQ_PROCESS_SRV). The reason for this prerequisite is that the
noti cations are sent to the external system that called the API API_PURCHASEREQ_PROCESS_SRV to create the purchase
requisitions.
Restrictions
With this service, you cannot transfer information about of service entry sheets that are referenced in the purchase order
history.
Namespace
http://sap.com/xi/Procurement
Service Structure
1/30/2023
The service contains a message header and a payload containing the data of a single purchase order item and the schedule
lines of this item.
The service message header contains information on the service, the involved sender and receiver as well as date and time. The
following elds are always transferred:
UUID UUID of the SOAP message
ReferenceID Reference ID of the SOAP

message
ReferenceUUID Reference UUID of the SOAP

message
CreationDateTime Date and time at which the

message was created
TestDataIndicator Test data indicator
ReconciliationIndicator Reconciliation indicator
SenderBusinessSystemID ID of the SAP S/4HANA system

that sends the message
RecipientBusinessSystemID ID of the external system that

will receive the message
SenderParty
InternalID Internal ID of the sender
StandardID Standard ID of the sender
ContactPerson Contact person of the sender

party
InternalID Internal ID of the contact person
schemeID
schemeAgencyID
OrganisationFormattedName Organisation name of the

contact person
PersonFormattedName Name of the contact person
PhoneNumber Phone number of the contact

person
AreaID
SubscriberID
ExtensionID
CountryCode
CountryDiallingCode
1/30/2023
CountryName
languageCode
FaxNumber Fax number of the contact

person
AreaID
SubscriberID
ExtensionID
CountryCode
CountryDiallingCode
CountryName
languageCode
EmailURI Email of the contact person
schemeID
RecipientParty
InternalID Internal ID of the recipient
StandardID Standard ID of the sender
ContactPerson Contact person of the recipient

party
InternalID Internal ID of the contact person
schemeID
schemeAgencyID
OrganisationFormattedName Organisation name of the

contact person
PersonFormattedName Name of the contact person
PhoneNumber Phone number of the contact

person
AreaID
SubscriberID
ExtensionID
CountryCode
CountryDiallingCode
CountryName
languageCode
FaxNumber Fax number of the contact

person
AreaID
1/30/2023
SubscriberID
ExtensionID
CountryCode
CountryDiallingCode
CountryName
languageCode
EmailURI Email of the contact person
schemeID
BusinessScope
TypeCode Type code if the business

scope
listID
listVersionID
listAgencyID
listAgencySchemeID
listAgencySchemeAgencyID
InstanceID Instance ID of the business

scope
schemeID
schemeAgencyID
ID ID of the business scope
schemeID
schemeAgencyID
Purchase Order Item (PurchaseOrderItem)
The PurchaseOrderItem node contains the business data of the service, that is, the history information of a purchase order
item.
Node or Field Description When Is Data Cardinality

Transferred
PurchaseOrderID ID of the purchase order always 1
PurchaseOrderItemID ID of the purchase order always 1

item
IsDeleted Deleted ag of the purchase always, if 0..1

order available
IsCompletelyDelivered Delivery ag of the purchase always, if 0..1

order available
1/30/2023

Transferred
GoodsReceiptIsExpected Contains value of the always, if 0..1

indicator that shows if goods available
receipt is expected or not
ScheduleLine Schedule Line always 1..n
ScheduleLineID ID of the delivery schedule always 1

line within the purchase
order item
PurchaseRequisitionID ID of the referenced always, if 0..1

purchase requisition available
PurchaseRequisitionItemID ID of an item referenced always, if 0..1

purchase requisition available
PurReqnExternalReferenceID If purchase requisition was always, if 0..1

created on the basis of a available
requisition from an external
system, this is the
requisition ID in the external
system
PurReqnItemExternalReferenceID If purchase requisition was always, if 0..1

system, this is the
requisition item ID in the
external system
PurReqnExternalSystemID If purchase requisition was always, if 0..1

system, this is the ID of the
external system
ScheduleLineOrderQuantity Quantity of goods in always, if 1

schedule line available
unitCode
ScheduleLineDeliveryDate Delivery date of goods in always, if 1

schedule line available
ScheduleLineOrderDate Order date in schedule line always, if 1

available
PurchaseOrderExternalSystemID If purchase order was always, if 0..1

purchase order from an
external system, this is the
ID of the external system
PurchaseOrderExternalReferenceID If purchase order was always, if 0..1

ID in the external system
1/30/2023

Transferred
PurchaseOrderItemExternalRefID If purchase order was always, if 0..1

purchase order item ID in
the external system
MaterialDocumentItem Goods receipt item Always if goods 0..n

receipt has been
created in SAP
S/4HANA system
MaterialDocumentID ID of the goods receipt in the Always if goods 1

purchase order history receipt has been
created in SAP
S/4HANA system
MaterialDocumentItemID ID of the goods receipt item Always if goods 1

receipt has been
created in SAP
S/4HANA system
FiscalYear Fiscal year when the goods Possible if goods 1

receipt was created receipt has been
created in SAP
S/4HANA system
PurchasingHistoryDocumentType SAP internal code of Always if goods 1

material document in the receipt has been
purchase order history (1 for created in SAP
goods receipts) S/4HANA system
PostingDate Date when the goods receipt Possible if goods 1

was posted in SAP S/4HANA receipt has been
created in SAP
S/4HANA system
QuantityInBaseUnit Quantity of received goods, Possible if goods 1

speci ed in the base unit of receipt has been
measure for the material. created in SAP
(The base unit of measure is S/4HANA system
the unit of measure in which
the stocks of the material
are managed.)
unitCode
QtyInPurchaseOrderPriceUnit Quantity of received goods, Possible if goods 1

speci ed in the unit of receipt has been
measure on which the created in SAP
purchase order price is S/4HANA system
based.
unitCode
TotalGoodsMvtAmtInCCCrcy Total amount of the received Possible if goods 1

goods, based on the net receipt has been
price in the goods receipt created in SAP
(speci ed in the document S/4HANA system
currency)
1/30/2023

Transferred
currencyCode
IsCompletelyDelivered An indicator denoting a Possible if goods 1

closed purchase order item receipt has been
for which no more goods created in SAP
receipts are expected. S/4HANA system
ReferenceMaterialDocumentID A reference ID for the goods Only if goods 0..1

receipt. This can be, for receipt has been
example, an ID used by your created in SAP
business partner, or any S/4HANA system
other reference document.
DocumentDate Date when the goods receipt Possible if goods 1

was created. receipt has been
created in SAP
S/4HANA system
CreationDate Creation date that was Possible if goods 1

automatically assigned by receipt has been
the SAP S/4HANA system. created in SAP
S/4HANA system
CreationTime Creation time that was Possible if goods 1

S/4HANA system
ReferenceDocumentID If the creation of the goods Possible if goods 0..1

receipt was triggered by a receipt has been
service entry sheet, this ID created in SAP
denotes the service entry S/4HANA system
sheet.
 Note
Transfer of service entry
sheet data is currently
not supported. See below
"ServiceEntrySheetItem".
ReferenceDocumentItemID If the creation of the goods Possible if goods 0..1

denotes an item in the S/4HANA system
service entry sheet.
 Note
1/30/2023

Transferred
ReferenceDocumentFiscalYear If the creation of the goods Possible if goods 0..1

service entry sheet, this created in SAP
entry refers to the scal year S/4HANA system
when the service entry sheet
was created.
 Note
ServiceEntrySheetItem Item of the service entry Possible if service 0..n

sheet entry sheet has
been created in
SAP S/4HANA
system.
ServiceEntrySheetID ID of the service entry sheet Possible if service 1

entry sheet has
been created in
SAP S/4HANA
system.
ServiceEntrySheetItemID ID of an item in the service Possible if service 1

entry sheet entry sheet has
been created in
SAP S/4HANA
system.
PurchasingHistoryDocumentType SAP internal code of service Possible if service 1

entry sheet in the purchase entry sheet has
order history (9 for service been created in
entry sheets) SAP S/4HANA
system.
PostingDate Date when the service entry Possible if service 1

sheet was posted in SAP entry sheet has
S/4HANA been created in
SAP S/4HANA
system.
Con rmedQuantity Quantity of service that was Possible if service 1

provided and con rmed, for entry sheet has
example number of hours or been created in
days SAP S/4HANA
system.
unitCode
NetAmount Net amount of the con rmed Possible if service 1

service quantity entry sheet has
been created in
SAP S/4HANA
system.
currencyCode
1/30/2023

Transferred
PurgDocItemExternalReference This eld is currently not Possible if service 0..1

used. entry sheet has
been created in
SAP S/4HANA
system.
ServiceEntrySheetName Name of the service entry Possible if service 1

been created in
SAP S/4HANA
system.
CreationDate Creation date that was Possible if service 1

automatically assigned by entry sheet has
the SAP S/4HANA system. been created in
SAP S/4HANA
system.
CreationTime Creation time that was Possible if service 1

SAP S/4HANA
system.
SupplierInvoiceItem Item in the supplier invoice Possible if 0..n

supplier invoice
has been created
in SAP S/4HANA
system.
SupplierInvoiceID ID of the supplier invoice Possible if 1

supplier invoice
has been created
in SAP S/4HANA
system.
SupplierInvoiceItemID ID of an item in the supplier Possible if 1

invoice supplier invoice
has been created
in SAP S/4HANA
system.
FiscalYear Fiscal year when the Possible if 1

supplier invoice was created supplier invoice
has been created
in SAP S/4HANA
system.
PurchasingHistoryDocumentType SAP internal code of Possible if 1

supplier invoices in the supplier invoice
purchase order history (2 for has been created
supplier invoices) in SAP S/4HANA
system.
PostingDate Date when the supplier Possible if 1

invoice was posted supplier invoice
has been created
in SAP S/4HANA
system.
1/30/2023

Transferred
QuantityInPurchaseOrderUnit Quantity of invoiced goods, Possible if 1

speci ed in the order unit of supplier invoice
measure used in the has been created
purchase order. in SAP S/4HANA
system.
unitCode
QtyInPurchaseOrderPriceUnit Quantity of invoiced goods, Possible if 1

speci ed in the unit of supplier invoice
measure on which the has been created
purchase order price is in SAP S/4HANA
based. system.
unitCode
SupplierInvoiceItemAmount Total amount of an item in Possible if 1

the supplier invoice supplier invoice
has been created
in SAP S/4HANA
system.
currencyCode
SupplierInvoiceIDByInvcgParty The ID that is used by the Possible if 0..1

supplier (that is, the supplier invoice
invoicing party) for the has been created
supplier invoice in SAP S/4HANA
system.
DocumentDate Date when the supplier Possible if 1

invoice was created. supplier invoice
has been created
in SAP S/4HANA
system.
CreationDate Creation date that was Possible if 1

automatically assigned by supplier invoice
the SAP S/4HANA system. has been created
in SAP S/4HANA
system.
CreationTime Creation time that was Possible if 1

automatically assigned by supplier invoice
the SAP S/4HANA system. has been created
in SAP S/4HANA
system.
1/30/2023

Transferred
ReferenceDocumentID If the creation of the goods Possible if 0..1

receipt linked from the supplier invoice
invoice was triggered by a has been created
service entry sheet, this ID in SAP S/4HANA
denotes the service entry system.
sheet.
 Note
not supported. See
above
ReferenceDocumentItemID If the creation of the goods Possible if 0..1

service entry sheet, this ID in SAP S/4HANA
denotes an item in the system.
 Note
not supported. See
above
ReferenceDocumentFiscalYear If the creation of the goods Possible if 0..1

service entry sheet, this in SAP S/4HANA
entry refers to the scal year system.
was created.
 Note
not supported. See
above
ContractCallOff CancelledIndicator Cancelled indicator for the Possible if 0..1

linked purchase contract purchase contract
has been created
in SAP S/4HANA
system.
Quantity Quantity for the linked Possible if 1

purchase contract purchase contract
has been created
in SAP S/4HANA
system.
Unit Code Unit Code for quantity
1/30/2023

Transferred
FormattedName Formatted name for the Possible if 1

has been created
in SAP S/4HANA
system.
LastChangedDate Last changed date for the Possible if 1

has been created
in SAP S/4HANA
system.
Price Price for the linked purchase Possible if 1

contract purchase contract
has been created
in SAP S/4HANA
system.
NetAmount currencyCode Net amount for the linked Possible if 1

has been created
in SAP S/4HANA
system.
ReceivingPlantId schemeAgencyID Receiving plant Id for the Possible if 1

has been created
in SAP S/4HANA
system.
PurchaseContractReference Purchase contract reference Possible if 1

for the linked purchase purchase contract
contract has been created
in SAP S/4HANA
system.
ContractId Id of the linked purchase Possible if 1

contract purchase contract
has been created
in SAP S/4HANA
system.
ContractItem Id of the linked purchase Possible if 1

contract item purchase contract
has been created
in SAP S/4HANA
system.
ReceiverID Receiver Id of the linked Possible if 1

has been created
in SAP S/4HANA
system.
ReceiverItemId Receiver item Id of the Possible if 1

has been created
in SAP S/4HANA
system.
1/30/2023

Transferred
ReceiverItemFormattedName Formatted name for the Possible if 1

linked receiver item purchase contract
has been created
in SAP S/4HANA
system.
Implementation
Con gure Logical Port
In SAP SOA Manager (SOAMANAGER), de ne the endpoint of the receiving system. To do this, con gure a logical port for
consumer proxy Purchase Order Item History Noti cation (Follow On Documents)
(PurchaseOrderItemHistoryNotification_Out).
Assign External System to Logical Port
In Customizing for Integration with Other SAP Components under Integration for Purchasing Basic Settings De ne
Communication Systems for Outbound Messages , you have to assign the receiving external system to a logical port. When
doing this, specify the proxy class CO_MMPUR_PO_ITEM_HIST_NOTIF.

To be able to monitor messages transferred by this service, you need to do the following:
1. Unpack the content for the SAP Application Interface Framework (AIF). You do this using transaction AIF Content
Transport - Deploy /AIF/CONTENT_EXTRACT. Use the deployment scenario ID SAP_COM_0238.
2. In Customizing for Cross-Application components under General Application Functions SAP Application Interface
Framework System Con guration Recipients Assign Recipients , assign the following recipient to the users:
Namespace: /MMPUR
Recipient Name: MMPUR_PO_HST_OUT (Purchase Order Item History Noti cation Outbound)
3. For message monitoring, use transaction Monitoring and Error Handling (/AIF/ERR)
Purchase Order – Receive Noti cations for Item History Updates

Technical name: PurchaseOrderItemHistoryNotification_In
This inbound service enables you to receive noti cations from an SAP S/4HANA system to an external system when changes to
the purchase order history of an item have occurred. This is the case when a goods receipt or a supplier invoice has been
created for the purchase order item.
Prerequisites
The following prerequisites apply:
On the satellite system, the SAP Central Procurement add-on must be installed.
1/30/2023
The purchase requisitions on which the purchase order items are based were created locally in the connected system.
The reason for this prerequisite is... To use this service, you must implement the communication scenario Purchase
Requisition Integration (SAP_COM_0102).
The administrator must set up the communication scenario Purchase Order Process Integration (SAP_COM_0238).
Namespace
http://sap.com/xi/Procurement
Restrictions
With this service, you cannot transfer information about of service entry sheets that are referenced in the purchase order
history.
Service Structure
CreationDateTime Date and time at which the message was

created
SenderBusinessSystemID ID of the SAP S/4HANA system that sends

the message
RecipientBusinessSystemID ID of the external system that will receive

the message
Service Node: PurchaseOrderItem

Transferred
PurchaseOrderID ID of the purchase order always 1
PurchaseOrderItemID ID of the purchase order always 1

item
ScheduleLine Schedule Line always 1..n
ScheduleLineID ID of the delivery schedule always 1

line within the purchase
order item
PurchaseRequisitionID ID of the referenced always, if available 0..1

purchase requisition
PurchaseRequisitionItemID ID of an item referenced always, if available 0..1

purchase requisition
1/30/2023

Transferred
PurReqnExternalReferenceID If purchase requisition was always, if available 0..1

created on the basis of a
system, this is the
requisition ID in the external
system
PurReqnItemExternalReferenceID If purchase requisition was always, if available 0..1

system, this is the
requisition item ID in the
external system
PurReqnExternalSystemID If purchase requisition was always, if available 0..1

system, this is the ID of the
external system
ScheduleLineOrderQuantity Quantity of goods in always, if available 1

schedule line
unitCode
ScheduleLineDeliveryDate Delivery date of goods in always, if available 1

schedule line
ScheduleLineOrderDate Order date in schedule line always, if available 1
PurchaseOrderExternalSystemID If purchase order was always, if available 0..1

ID of the external system
PurchaseOrderExternalReferenceID If purchase order was always, if available 0..1

ID in the external system
PurchaseOrderItemExternalRefID If purchase order was always, if available 0..1

purchase order item ID in
the external system
MaterialDocumentItem Goods receipt item Always if goods 0..n

receipt has been
created in SAP
S/4HANA system
MaterialDocumentID ID of the goods receipt in the Always if goods 1

purchase order history receipt has been
created in SAP
S/4HANA system
1/30/2023

Transferred
MaterialDocumentItemID ID of the goods receipt item Always if goods 1

receipt has been
created in SAP
S/4HANA system
FiscalYear Fiscal year when the goods Possible if goods 1

receipt was created receipt has been
created in SAP
S/4HANA system
PurchasingHistoryDocumentType SAP internal code of Always if goods 1

material document in the receipt has been
goods receipts) S/4HANA system
PostingDate Date when the goods receipt Possible if goods 1

was posted in SAP S/4HANA receipt has been
created in SAP
S/4HANA system
QuantityInBaseUnit Quantity of received goods, Possible if goods 1

speci ed in the base unit of receipt has been
measure for the material. created in SAP
(The base unit of measure is S/4HANA system
the unit of measure in which
the stocks of the material
are managed.)
unitCode
QtyInPurchaseOrderPriceUnit Quantity of received goods, Possible if goods 1

speci ed in the unit of receipt has been
purchase order price is S/4HANA system
based.
unitCode
TotalGoodsMvtAmtInCCCrcy Total amount of the received Possible if goods 1

goods, based on the net receipt has been
price in the goods receipt created in SAP
(speci ed in the document S/4HANA system
currency)
currencyCode
IsCompletelyDelivered An indicator denoting a Possible if goods 1

closed purchase order item receipt has been
for which no more goods created in SAP
receipts are expected. S/4HANA system
ReferenceMaterialDocumentID A reference ID for the goods Only if goods 0..1

receipt. This can be, for receipt has been
example, an ID used by your created in SAP
business partner, or any S/4HANA system
other reference document.
1/30/2023

Transferred
DocumentDate Date when the goods receipt Possible if goods 1

was created. receipt has been
created in SAP
S/4HANA system
CreationDate Creation date that was Possible if goods 1

S/4HANA system
CreationTime Creation time that was Possible if goods 1

S/4HANA system
ReferenceDocumentID If the creation of the goods Possible if goods 0..1

denotes the service entry S/4HANA system
sheet.
 Note
ReferenceDocumentItemID If the creation of the goods Possible if goods 0..1

denotes an item in the S/4HANA system
 Note
ReferenceDocumentFiscalYear If the creation of the goods Possible if goods 0..1

service entry sheet, this created in SAP
entry refers to the scal year S/4HANA system
was created.
 Note
ServiceEntrySheetItem Item of the service entry Possible if service 0..n

 Note
been created in
This node is currently not supported. SAP S/4HANA
system.
1/30/2023

Transferred
ServiceEntrySheetID ID of the service entry sheet Possible if service 1

entry sheet has
been created in
SAP S/4HANA
system.
ServiceEntrySheetItemID ID of an item in the service Possible if service 1

entry sheet entry sheet has
been created in
SAP S/4HANA
system.
PurchasingHistoryDocumentType SAP internal code of service Possible if service 1

entry sheet in the purchase entry sheet has
order history (9 for service been created in
entry sheets) SAP S/4HANA
system.
PostingDate Date when the service entry Possible if service 1

sheet was posted in SAP entry sheet has
S/4HANA been created in
SAP S/4HANA
system.
Con rmedQuantity Quantity of service that was Possible if service 1

provided and con rmed, for entry sheet has
example number of hours or been created in
days SAP S/4HANA
system.
unitCode
NetAmount Net amount of the con rmed Possible if service 1

service quantity entry sheet has
been created in
SAP S/4HANA
system.
currencyCode
PurgDocItemExternalReference This eld is currently not Possible if service 0..1

used. entry sheet has
been created in
SAP S/4HANA
system.
ServiceEntrySheetName Name of the service entry Possible if service 1

been created in
SAP S/4HANA
system.
CreationDate Creation date that was Possible if service 1

SAP S/4HANA
system.
1/30/2023

Transferred
CreationTime Creation time that was Possible if service 1

SAP S/4HANA
system.
SupplierInvoiceItem Item in the supplier invoice Possible if supplier 0..n

invoice has been
created in SAP
S/4HANA system.
SupplierInvoiceID ID of the supplier invoice Possible if supplier 1

invoice has been
created in SAP
S/4HANA system.
SupplierInvoiceItemID ID of an item in the supplier Possible if supplier 1

invoice invoice has been
created in SAP
S/4HANA system.
FiscalYear Fiscal year when the Possible if supplier 1

supplier invoice was created invoice has been
created in SAP
S/4HANA system.
PurchasingHistoryDocumentType SAP internal code of Possible if supplier 1

supplier invoices in the invoice has been
supplier invoices) S/4HANA system.
PostingDate Date when the supplier Possible if supplier 1

invoice was posted invoice has been
created in SAP
S/4HANA system.
QuantityInPurchaseOrderUnit Quantity of invoiced goods, Possible if supplier 1

speci ed in the order unit of invoice has been
measure used in the created in SAP
purchase order. S/4HANA system.
unitCode
QtyInPurchaseOrderPriceUnit Quantity of invoiced goods, Possible if supplier 1

speci ed in the unit of invoice has been
purchase order price is S/4HANA system.
based.
unitCode
SupplierInvoiceItemAmount Total amount of an item in Possible if supplier 1

the supplier invoice invoice has been
created in SAP
S/4HANA system.
currencyCode
1/30/2023

Transferred
SupplierInvoiceIDByInvcgParty The ID that is used by the Possible if supplier 0..1

supplier (that is, the invoice has been
invoicing party) for the created in SAP
supplier invoice S/4HANA system.
DocumentDate Date when the supplier Possible if supplier 1

invoice was created. invoice has been
created in SAP
S/4HANA system.
CreationDate Creation date that was Possible if supplier 1

automatically assigned by invoice has been
S/4HANA system.
CreationTime Creation time that was Possible if supplier 1

automatically assigned by invoice has been
S/4HANA system.
ReferenceDocumentID If the creation of the goods Possible if supplier 0..1

receipt linked from the invoice has been
invoice was triggered by a created in SAP
service entry sheet, this ID S/4HANA system.
denotes the service entry
sheet.
 Note
not supported. See
above
ReferenceDocumentItemID If the creation of the goods Possible if supplier 0..1

service entry sheet, this ID S/4HANA system.
denotes an item in the
 Note
not supported. See
above
1/30/2023

Transferred
ReferenceDocumentFiscalYear If the creation of the goods Possible if supplier 0..1

service entry sheet, this S/4HANA system.
entry refers to the scal year
was created.
 Note
not supported. See
above
Purchase Order (OData V4)

Service name: PurchaseOrder
This service enables you to create, update, or delete purchase orders.
The service is based on the OData protocol and can be consumed in SAP Fiori apps and on other user interfaces.
The OData service supports the purchase order type Standard ("NB") and any customer-de ned purchase order type ("ZNB*")
that has been copied with all dependent entries from purchase order type "NB".
The service supports the following purchase order item categories:
Purchase Order Item Category Internal Symbol* External Symbol**
Standard 0 ' ' (=blank)
Subcontracting 3 L
Third- Party 5 S
Enhanced Limits (for materials or lean services) A E
Consignment 2 K
* Enter the required purchase order item category using the internal symbol.
** The external symbol is displayed, for example, in the app Create Purchase Order - Advanced.
This is an OData version 4 service. This version aims to improve processing time and resource consumption of clients and
servers and to re ect the complexity of the underlying business model. This includes a lightweight JSON format that reduces
the size of every response. Business data can be retrieved in the exact amount, at the right time, and in appropriate mode by
using new synchronization mechanisms. Calculations are made and data is aggregated by using the tiers best suited for this
task. Sophisticated metadata artifacts enable a true-to-life modeling of business models.
Technical Details
1/30/2023
A service group contains services belonging to the same business object model and so it shares similar environment conditions.
This means the con guration and administration of a service group apply to all services in a service group, that is, routing,
authorization, and so on, so you only have to do them once.
In the OData version 4 (V4) runtime implementation of the SAP Gateway Foundation, framework services originate from
repositories.
Service Group (incl. Repository ID Service Name (incl. Namespace Version

Namespace if Existent) if Existent)
API_PURCHASEORDER_2 srvd_a2x PurchaseOrder 0001
Service Structure
Service Header (optional)
The service header contains information about the header data, such as the Supplier, Purchasing Group, Purchasing
Organization, Company Code , and Currency .
Entities
Entity Description Link to Details
PurchaseOrder Header information for purchase order Purchase Order
PurchaseOrderNote Header note information for purchase order Header Notes
PurchaseOrderItem Item information for purchase order Item
PurchaseOrderItemNote Item note information for purchase order Item Notes
PurchaseOrderScheduleLine Schedule line information for purchase Schedule Line

order
POSubcontractingComponent Subcontracting component information for Subcontracting Components

purchase order
PurchaseOrderAccountAssignment Account assignment information for Account Assignment

purchase order
PurOrderItemPricingElement Pricing information for purchase order Pricing Element
PurchaseOrderPartner Partner details Partner
PurchaseOrderInvoicingPlan Information on the used invoicing plan Invoicing Plan
PurchaseOrderInvoicingPlanItem Invoicing plan item details Invoicing Plan Item
PurchaseOrderSupplierAddress Supplier address details Supplier Address
PurOrderItemDeliveryAddress Delivery address of a purchase order item Item Delivery Address
Service Response
Entity Description
1/30/2023
Entity Description
Purchase order number Purchase order number which is created by the service is returned
in response to the successful creation of the purchase order
Purchase order header details Newly created purchase order header details
Error Codes
Error Code Description
Message class: APPL_MM_PUR_PO, message no. 011 You are not authorized to create purchase orders
Message class: APPL_MM_PUR_PO, message no. 064 Use purchase order type "Standard" ("NB") or a type copied from
“NB”.
Diagnosis
You have entered a purchase order type that is not supported.
Procedure
Choose purchase order type "Standard" ("NB") or a customer-

de ned purchase order type (for example "ZNB1") that has been
copied with all dependent entries from purchase order type "NB"
(including eld selection key).
As a con guration expert, you can de ne custom purchase order

types in the con guration app Manage Your Solution -> Con gure
Your Solution -> Application Area: Sourcing and Procurement -> Sub
Application Area: Operational Procurement -> Purchase Order
Processing -> De ne Document Types.
Do not change the default eld selection key.
Message class: APPL_MM_PUR_PO, message no. 065 Use a supported purchase order item category for item &. See long
text.
Diagnosis
You have either chosen a purchase order item category that is not
supported, or you have used a wrong symbol.
Procedure
Choose purchase order item category "Standard",

"Subcontracting", "Third-Party", or "Enhanced Limit".
Maintain the required purchase order item category using the

internal symbol:
Standard: 0
Subcontracting: 3
Third-Party: 5
Enhanced Limit: A
Message class: APPL_MM_PUR_PO, message no. 067 Schedule line has been created automatically for item &
Response(Success) Purchase order “Purchase Order number” has been updated with
status 200 at change set level.
Response(Failure) Self-explanatory detailed messages at the change set level with

status 400. Batch response will be status code 200.
1/30/2023
Error Code Description
Message class: APPL_MM_PUR_PO, message no. 069 Only one request is allowed in change set
Message class: APPL_MM_PUR_PO, message no. 070 Only PATCH or MERGE operation is allowed in batch call
Message class: APPL_MM_PUR_PO, message no. 072 You can only update one purchase order per change set
Constraints
1. Create:
Purchase orders with a category other than those speci ed for the header and item.
Purchase order items with a category other than Standard, Subcontracting, Third-Party, and Enhanced Limit .
Only authorized roles can be used to create purchase orders through an API call. Authorized objects: M_BEST_BSA.
2. Update:
Use PUT and MERGE or PATCH, and HEAD in the OData call URL. Only POST, PATCH or MERGE, and DELETE are
allowed with the Batch URL. Using other actions will result in an error.
Update more than one purchase order within one change set. Only one purchase order can be updated in a single
change set. If you would like to update multiple purchase orders, provide the update information of one purchase
order per change set.
Create a new service node (except a purchase order item) in an existing document.
Only authorized roles can be used to update purchase orders through an API call.
3. Get:
More than 1000 purchase orders unless
You set the paging size up to 5000 records using the following OData request:
 Example
/sap/opu/odata/sap/API_PURCHASEORDER_2/R_PurchaseOrder?$top=5000
/sap/opu/odata/sap/API_PURCHASEORDER_2/R_PurchaseOrder?
$expand=to_PurchaseOrderItem&$ lter=CreationDate gt datetime'2021-04-24T00:00:00'&$top=5000
 Note
For performance reasons in API_PURCHASEORDER_2 the following is valid: <clauses>-limit = 1000
The default paging size (D) = 1000 if the client did not provide $top.
The maximum paging size (M) = 5000 if the client offers $top.
4. Post:
To transfer pricing values 1:1 from an external system as some values are calculated automatically and IDs are
generated. Regarding the pricing details, the OData service contains elds with "Necessity": read-only, which are
not lled during a Post request.
If migrating from one system to another, it is recommended to use the same pricing procedure in the source and
the target system, to ensure that pricing results are the same. If rounding pro les are maintained (material
master, MRT1 tab), do not send condition data in the Post request as a payload.
1/30/2023
5. Stock Transfer Order (STO) is not supported.
Authentication
The following authentication methods are supported:
Basic Authentication
Authentication with Certi cate
Related Events
Purchase Order Events
The link to the API on the SAP API Business Hub:
https://api.sap.com/api/CE_PURCHASEORDER_0001/overview
 Note
Purchase Order
Technical name: PurchaseOrder
Properties
 Note
the payload can neither be added nor changed.
ignored.
CompanyCode Company code Mandatory
1/30/2023
CorrespncExternalReference The reference ID that is provided by the Optional

external party and that is used in
correspondence
CorrespncInternalReference The reference ID that is provided by the Optional

internal party and that is used in
correspondence
CreatedByUser User ID of creator Read-only
CorrespncExternalReference Your reference Optional
CorrespncInternalReference Our reference Optional
Customer Custoemr number Optional

curency
DownPaymentType Donw payment indicator Optional
DocumentCurrency Document currency key Recommendation
 Note
DocumentCurrency is derived from the
supplier master data.
It is recommended, however, to still add

the DocumentCurrency in the payload
explicitly
to ensure coherent database records

and better performance of the service.
ExchangeRate Exchange rate used for the translation Optional

between foreign currency and local currency
ExchangeRateIsFixed Indicator for Fixed Exchange Rate Optional
IsEndOfPurposeBlocked Business Purpose Completed Read-only
InvoicingParty Account of invoicing party Optional
IncotermsTransferLocation Incoterms (part 2) Optional
IsIntrastatReportingExcluded Exclude from Intrastat reporting Optional
IsIntrastatReportingRelevant Relevant for Intrastat reporting Optional
ItemNumberIntervalForSubItems Item number intervall for subitems Optional
1/30/2023
LastChangeDateTime Change Time Stamp Read-only
ManualSupplierAddressID Address number Optional
NetPaymentDays Net payment terms period. Optional
Standard settlement period (in days)
PurchaseContract Number of principal purchase agreement Optional
PurchaseOrder Request from a buyer to a seller to deliver a POST (new purchase order) and internal
speci ed quantity of material, or perform a number assignment: Not required
speci ed service
POST (new purchase order) and external
number assignment (if allowed by your
con guration settings): Optional
DELETE: Mandatory
PATCH or MERGE operation:
 Note
Be aware that request url and body of
request must be treated differently!
Key elds are to be provided with the url

only and are not allowed as part of the
payload (body of request)!
PurchaseOrderDate The date on which a purchase order has Optional

been placed.
PurchaseOrderDeletionCode Purchase order deletion code Optional
PurchaseOrderSubtype Control indicator for purchasing document Read-only

type
PurchaseOrderType Purchase order type Mandatory
PurchasingCollectiveNumber Number or code facilitating the collective Optional

management of a number of individual
RFQs (or inquieries) or purchase orders.
PurchasingCompletenessStatus Purchasing document not yet complete Optional
PurchasingDocumentOrigin Origin of purchasing document Read-only
PurchasingProcessingStatus Processing status of a purchasing Optional

document
PurchasingReleaseStrategy Release strategy Optional
1/30/2023
PurgAggrgdProdCmplncSuplrSts Summary of the product compliance status Read-only

of the supplier validation with regards to the
whole purchase order
PurgAggrgdProdMarketabilitySts Summary of the product compliance status Read-only

of the marketability status validation with
PurgAggrgdSftyDataSheetStatus Summary of the product compliance status Read-only

of the safety data sheet validation with
PurgProdCmplncTotDngrsGoodsSts Summary of the product compliance status Read-only

of the dangerous goood validation with
PurgReasonForDocCancellation Reason for cancelation Optional
PurgReleaseSequenceStatus Release status Optional
PricingDocument Number of the document condition Optional
PricingProcedure Procedure (for example, pricing, output Optional

control, and so on)
QuotationSubmissionDate Quotation submission date Optional
ReleaseCode Release indicato: purchasing document Optional
ReleaseIsNotCompleted Release not yet completely effected Optional
Supplier Business partner who offers or provides Mandatory

SupplierAddressID Address number Optional
SupplierPhoneNumber Supplier’s telephone number Optional
SupplierQuotationExternalID External quotation ID on supplier’s side Optional
SupplierRespSalesPersonName Responsible Sales Person at supplier’s Optional

office
SupplyingSupplier Supplying supplier Optional
TaxReturnCountry Country/region for tax report Optional
ValidityEndDate Validity end date Optional
ValidityStartDate Validity start date Optional
VATRegistrationCountry Country/region of sales tax id number Optional
 Note
To display more information about the properties on the SAP API Business Hub, choose Schema View.
Supported Operations
The following operations are supported:
1/30/2023
Create
Read
Update
Delete
Header Notes
Technical name: PurchaseOrderNote
Properties
 Note
TextObjectType Text ID (Text Object Type) Optional
 Note
Create
Read
Update
Delete
Item
Technical name: PurchaseOrderItem
Properties
 Note
1/30/2023
ignored.
 Note
Address handling
Consider the following dependencies for the delivery address elds.
You have, for example, the following situation:
For some of the delivery address elds an input is provided in the payload in addition to the ReferenceDeliveryAddressID, the
Subcontractor, and the Customer.
If a reference delivery address ID is entered in the payload, the address maintained under the reference delivery address ID
is used. If you enter, for example, a delivery address street and house number in the payload in addition to the reference
delivery address ID, the system generates a new delivery address ID. The address saved for this new delivery address ID
consists of a combination of the address of the reference delivery address ID and the address details given explicitly in the
payload for the respective delivery address elds (in our example for the delivery address street and house number).
 Note
GET request and paging
The GET statement is quite powerful as it could possibly retrieve huge amounts of data – if not restricted, all data on the
database could be returned. To have a safety net and keep performance up, paging was introduced for the data in the result.
This means that if no URI Option $top is given in the URI, 1000 records are retrieved. If, however, the $top option is given,
max. 5000 records can be retrieved.
In addition, the $skiptoken option can be used to retrieve the data from all so-called pages: one page is a result set of 1000
records. To get all records in the result set, all pages can be read. To do this, the skiptoken at the bottom of the response can
be used to get to the next page with the next 1000 records, for example:
<link rel="next" href="R_PurchaseOrder?$skiptoken=1000"/>
If this skiptoken is added to the URI, for example:
/sap/opu/odata/sap/API_PURCHASEORDER_2/R_PurchaseOrder?$skiptoken=1000
The next page is retrieved, starting with the next purchase order after the last one in the rst result set.
At the end of this page, the skiptoken allows further "navigation" by giving both skiptokens, the current one and the next one:
<link rel="next" href="R_PurchaseOrder?%24skiptoken=1000&$skiptoken=2000"/>
This can be continued until the end of all pages.
1/30/2023
AllocationTable, Allocation table Optional
AllocationTableItem Allocation table item Optional
ArticleCategory Article category Optional
Batch Assigns a material that is manufactured in Optional

batches or production lots to a speci c
batch.
BR_CFOPCategory Material CFOP category Optional
BR_IsProducedInHouse Produced in-house
BR_MaterialOrigin Origin of the material Optional
BR_MaterialUsage Usage of the material Optional
BR_NCM Brazilian NCM code Optional
CompanyCode Company code Optional
ConsumptionTaxCtrlCode HSN or SAC code Optional
CrossPlantCon gurableProduct Cross plant con gurable material Optional
Customer Number of the customer for whom a Optional

material is to be delivered.

dependencies.
DeliveryAddressCityName Delivery address city name Optional

is maintained
DeliveryAddressCountry Country key Optional

is maintained
DeliveryAddressDistrictName District is part of a city Optional
DeliveryAddressFullname Delivery address fullname Optional

is maintained
DeliveryAddressHouseNumber Delivery address house number Optional

is maintained
1/30/2023
DeliveryAddressID Delivery address Read-only
Automatically generated number for the

details given in the payload for the delivery
address elds. Please see Note: Address
handling on top of this table and consider
the described dependencies.
DeliveryAddressName Delivery address name Optional

is maintained
DeliveryAddressName2 Delivery address name 2 Optional

is maintained
DeliveryAddressPostalCode Delivery address postal code Optional

is maintained
DeliveryAddressRegion Delivery address region (state, province, Optional

county)
is maintained
DeliveryAddressStreetName Delivery address street name Optional

is maintained
DeliveryDocumentType Delivery type for returns to supplier Optional
DiversionStatus Status of diversion process Optional

currency
DownPaymentType Down payment indicator Optional
EarmarkedFunds Earmarked funds document Optional
EarmarkedFundsItem Earmarked funds line item Optional
EvaldRcptSettlmtIsAllowed Evaluated receipt settlement (ERS) Optional
ExpectedOverallLimitAmount Expected value of overall limit Optional
GoodsReceiptIsExpected Indicates that a goods receipt is allowed Optional

and expected
GoodsReceiptIsNonValuated Goods receipt, non-valuated Optional
1/30/2023
GrossAmount Gross order value in purchase order Optional

currency
IncotermsTransferLocation Incoterms (Part 2) Optional
InternationalArticleNumber International Article Number (EAN/UPC) Optional
InventorySpecialStockType Special stock indicator Optional
InvoiceIsGoodsReceiptBased Indicator: Goods receipt-based invoice Optional

veri cation
IsCompletelyDelivered Indicator for status “Completely delivered” Optional
IsReturnsItem Speci es whether or not the item is a Optional

returns item
IssuingStorageLocation Issuing storage location for stock transport Optional

order
ItemGrossWeight Gross weight Optional
ItemIsRejectedBySupplier Rejection indicator Optional
ItemHasValueAddedService VAS relevant Optional
ItemNetWeight Net weight on item level Optional
ItemVolume Item volume Optional
ItemVolumeUnit Volume unit Optional
ItemWeightUnit Unit of weight on item level Optional
ManualDeliveryAddressID Manual address number in purchasing Optional

document item
Manufacturer Number of manufacturer Optional
ManufacturerMaterial Material number corresponding to Optional

manufacturer part number
ManufacturerPartNmb Manufacturer part number Optional
MaterialType Material type

assignment
NetPriceAmount Net price in purchasing document (in Optional

document currency)
1/30/2023
NonDeductibleInputTaxAmount, Non-deductible input tax Optional
NetPriceQuantity Price unit Optional
OrderPriceUnit Order price unit (Purchasing) Optional
OrderPriceUnitToOrderUnitNmrtr Numerator for conversion of order price unit Optional

into order unit
OrderQuantity Purchase order quantity Optional
OrdPriceUnitToOrderUnitDnmntr Denominator for conversion of order price Optional

unit into order unit
OverallLimitAmount Overall Limit Optional
OverdelivTolrtdLmtRatioInPct Overdelivery tolerance limit Read-only
PartialInvoiceDistribution Determines how invoice amounts in partial Optional

invoices are to be distributed
Alll other operations: Optional
PlndOrderReplnmtElmntType Kanban indicator Optional
PriceIsToBePrinted Price printout Optional
PricingDateControl Price determination (Pricing) data control Optional
ProductCollection Fashion collection Optional
ProductPurchasePointsQtyUnit Points unit Optional
ProductSeason Season Optional
ProductSeasonYear Season year Optional
ProductTheme Fashion theme Optional
ProductType Product type Optional
ProductTypeCode Prduct type code Optional
PurchaseContract Purchase contract Optional
PurchaseOrder Purchase order Optional
PurchaseOrderCategory Purchase order category Optional
PurchaseOrderItem Purchase order item Optional
PurchaseOrderItemCategory Purchase order item category Optional
PurchaseOrderItemText Short text for purchase order item Optional
 Note
When working with item hierarchies, it is
Mandatory to enter a short text for item
sets.
1/30/2023
PurchaseOrderReferenceType, Action for tracebility in purchase orders Optional
PurchaseOrderQuantityUnit Purchase order unit of measure. Speci es Optional

the unit of measure in which the item is
ordered.
PurchaseRequisition Purchase requisition Optional
PurchaseRequisitionItem Item number of purchase requisition Optional

[To delete a purchase order or a purchase
order item, use the DELETE operation.]
PurchasingInfoRecord Purchasing info record Optional
PurchasingInfoRecordUpdateCode Indicator: update info record Optional
PurchasingitemIsFreeOfCharge This eld stores Free of Charge information. Optional

It is a calculated eld with the values
true/false sent in a payload.  Note
Patch is not supported
PurchasingParentItem Item number of the parent itemset Optional
PurContractForOverallLimit Purchase contract for enhanced limit Optional
PurgCon gurableItemNumber Number indicating the position in the Read-only

hierarchy
Optionaln in case of POST operation
PurgDocAggrgdSubitemCategory Hierarchy item indicator that determines an Optional

item set (C = item set)
PurgDocPriceDate, Date of price determination Optional
PurgDocSubitemCategory Sub item category is generated Read-only

automatically
PurgExternalSortNumber External sort number is generated Read-only

automatically
PurgProdCmplncSupplierStatus Product compliance status with regards to Read-only

the supplier validation of an item
PurgProductMarketabilityStatus Product compliance status with regards to Read-only

the product marketability validation of an
item
PurgSafetyDataSheetStatus Product compliance status with regards to Read-only

the safety data sheet validation of an item
PurgProdCmplncDngrsGoodsStatus Product compliance status with regards to Read-only

the dangerous goods validation of an item
ProductCharacteristic1 Characteristic value 1 Optional
1/30/2023
ReferenceDeliveryAddressID Number of delivery address Optional
Please see Note: Address handling on top Used here: default Reference ID for existing
of this table and consider the described address. No new address can be created.
dependencies.
ReferenceDocumentItem Reference item number for purchase order Optional

tracebility
ReferenceDocumentNumber Reference document number for purchase Optional

order tracebility
RetailPromotion Retail promotion Optional
SeasonCompletenessStatus Season completeness indicator Optional
ServicePackage Package number Optional
ShippingGroupNumber PSST group Optional
ShippingGroupRule PSST grouping rule Optional
ShippingInsruction Key of shipping instructions according to Optional

customizing
StockType Stock type Optional
StockSegment Stock segment Optional
Subcontractor Supplier to be supplied/Who is to receive Optional

delivery

dependencies.
SupplierCon rmationControlKey Determines which con rmation categories Optional

are expected for a purchase order item
Subtotal1Amount Subtotal 1 from pricing procedure for price Optional

element

element

element

element

element

element
SupplierIsSubcontractor Subcontracting supplier Optional
1/30/2023
SupplierSubrange Optional
TaxCode Tax on sales / purchases code Optional
TaxCountry Tax country Optional
TaxDeterminationDate Tax determination date Optional
 Note
You must ll the eld only if
time-dependant taxes are
activated. Otherwise you must
not ll the eld.
UnderdelivTolrtdLmtRatioInPct Underdelivery tolerance limit Optional
UnlimitedOverdeliveryIsAllowed Indicates that an unlimited overdelivery is Optional

allowed for this item
ValAddedSrvcParentItmNumber Item number of purchasing document Optional
ValuationCategory Valuation category Optional
ValuationType Valuation type Optional
BR_MaterialOrigin Material Origin Optional in Brazil
BR_MaterialUsage Material Usage Optional in Brazil
BR_CFOPCategory Material CFOP Category Optional in Brazil
BR_NCM NCM Code for Item Optional in Brazil
BR_IsProducedInHouse Produced in-House Optional in Brazil
 Note
Create
Read
Update
Delete
Item Notes
1/30/2023
Technical name: PurchaseOrderItemNote
Properties
 Note
Inforecord texts cannot be retrieved by the GET request.
TextObjectType Text ID (Document Text) Optional
No validation is performed for the Text

Object Type eld.
 Note
Filtering by PlainLongText is not
supported for purchase orderItem Notes
PurchaseOrderItem Item Number of Purchasing Document Optional
 Note
Create
Read
Update
Delete
Schedule Line
Technical name: PurchaseOrderScheduleLine
Properties
 Note
1/30/2023
ignored.
 Note
Regarding Delivery Date:
Relevant for POST operation with a single schedule line: If you order a material for which the system can determine the
delivery date from an info record or from the material master data, the system copies the date determined and ignores any
date entered in the payload. If you want to de ne a different delivery date, please either create several schedule lines or
change the delivery date in a PATCH or MERGE operation.
Batch Batch number Optional
BatchBySupplier Supplier batch number Optional
Currency Currency key Optional
GoodsIssueDate Goods issue date Optional
GoodsIssueTime Time of goods issue (local, relating to a Optional

plant)
LoadingDate Loading date Optional
LoadingTime Loading time Optional
ProductAvailabilityDate Material staging/availability date Optional
ProductAvailabilityTime Material staging time (local, relating to a Optional

plant)
PurchaseOrder Purchasing document number Mandatory
PurchaseOrderItem Purchase order item number Mandatory
OpenPurchaseOrderQuantity Open purchase order quantity Optional
PurchaseOrderQuantityUnit Purchase order unit Read-only
PurchaseRequisition Purchase requisition number Optional
PurchaseRequisitionItem Purchase requisition item number Optional
PurchasingDocument Purchasing document number Mandatory
PurchasingDocumentItem Purchasing document item number Mandatory
RouteSchedule Route schedule Optional
1/30/2023
SchedLineStscDeliveryDate Statistic relevant schedule line delivery Optional

date
ScheduleLine Delivery schedule line number Mandatory
ScheduleLineCommittedQuantity Committed quantity of a purchase order Optional

schedule line
ScheduleLineDeliveryDate Schedule line delivery date Optional - please see note above
ScheduleLineDeliveryTime Schedule line delivery time Optional
ScheduleLineOrderDate Order date of schedule line Optional
ScheduleLineOrderQuantity Order quantity in sales unit Optional
TransportationPlanningDate Transportation planning date Optional
TransportationPlanningTime Transportation planning time (local, relating Optional

to a shipping point)
 Note
Create
Read
Update
Delete
Subcontracting Components
Technical name: POSubcontractingComponent
Properties
 Note
ignored.
1/30/2023
BaseUnit Base unit of measure Read-only
Batch Batch number Read-only
BillOfMaterialItemNumber Bill of material item number Optional
BOMItemCategory Bill of material item category Optional
BOMItemDescription BOM item text line 1) Read-only
BOMItemText2 BOM item text (line2) Optional
ChangeNumber Change number Optional
ComponentScrapInPercent Component scap in percent Optional
ConsumptionPosting Consumption posting Optional
DebitCreditCode Debit/credit code Optional
EntryUnit Unit of Entry Optional
FormulaKey Formula key for variable-size items Optional
InventorySpecialStockType Inventory special stock type Optional
InventorySpecialStockValnType Inventory special stock valuation type Optional
IsBulkMaterialComponent Indicator: bulk material Optional
IsNetScrap Net scrap indicator Optional
IsMaterialProvision Material provision indicator Optional
LatestRequirementDate Latest requirement date Optional
LeadTimeOffset Lead-time offset Optional
Material Material Number Optional
MaterialCompIsVariableSized Variable-sized item indicator Optional
MaterialComponentIsPhantomItem Phantom item indicator Optional
MaterialProvisionType Material provision type Optional
MaterialQtyToBaseQtyDnmntr Denominator for conversion to base units of Optional

measure
MaterialQtyToBaseQtyNmrtr Numerator for conversion to base units of Optional

measure
MaterialRevisionLevel Revision level Optional
MatlCompFreeDe nedAttribute Sort string Optional
OperationScrapInPercent Operation scrap Optional
OrderLevelValue Order level Optional
OrderPathValue Order path Optional
1/30/2023
ProductionSupplyArea Production supply area Optional
PurchaseOrder Purchase Order Number Mandatory: in case of PATCH or MERGE

PurchaseOrderItem Number of Purchase Order Item Mandatory: in case of PATCH or MERGE

QuantityDistributionKey MRP distribution key Optional
QuantityIsFixed Quantity is xed Optional
QuantityInEntryUnit Quantity in Unit of Entry Optional
RecordType Reservation record type Optional
RequiredQuantity Requirement Quantity Read-only
RequirementDate Material component requirement date Optional
RequirementTime Material component requirement time Optional
Reservation Number of reservation/dependent Optional

requirements
ReservationIsFinallyIssued Final issue for reservation Optional
ReservationItem Item Number of Reservation Mandatory: in case of PATCH or MERGE

ScheduleLine Delivery Schedule Line Counter Mandatory in case of PATCH or MERGE

operation
Size1 Size1 Optional
UnitOfMeasureForSize1To3 Unit of measure for size 1 to 3 Optional
VariableSizeComponentUnit Unit of measure for variable-size Optional

components
VariableSizeComponentQuantity Variable-size item quantity per pc Optional
VariableSizeItemQuantity Number of variable-size components Optional
VariableSizeItemUnit Varialbe-size item unit of measure Optional
WithdrawnQuantity Quantity Withdrawn Read-only
 Note
1/30/2023
Create
Read
Update
Delete
Account Assignment
Technical name: PurchaseOrderAccountAssignment
Properties
 Note
ignored.
AccountAssignmentNumber Sequential number of account assignment Mandatory
AcctLineFinalReason Final account assignment reason code Optional
BudgetPeriod Timeframe of available budget authority Optional
ChartOfAccounts Chart of accounts Optional
CommitmentItem Functional grouping of expenditures and Optional

revenues with a FM area
CommitmentItemShortID Commitment item short id Optional
CreationDate Record created on Optional
EarmarkedFundsDocument Business transaction in FM which claims Optional

already allocated budget for expected
revenues or expenditures
1/30/2023
EarmarkedFundsDocumentItem Earmarked Funds: Dokument Item Optional
FixedAsset ID which, together with the main asset ID, Optional

uniquely identi es a xed asset in Asset
Accounting
Fund Fund Optional


GrantID Grant Optional
IsAcctLineFinal Final account assignement indicator Optional
IsDeleted Is deleted Read-only
LastChangedDate Record created on Optional
MasterFixedAsset Main asset number Optional

account assignment
NetworkActivity Single activity within a project Optional
NetworkActivityInternalID Internal counter Optional
NonDeductibleInputTaxAmount Non-deductible input tax Optional
OrderInternalID Routing number of operations in the order Optional
OrderIntBillOfOperationsItem General counter for order Optional
OrderQuantityUnit Purchase order unit of meas measure Optional

project.
ProjectNetworkInternalID Routing number of operations in the order Optional
PurchaseOrderQuantity Purchase Order Quantity Read-only
1/30/2023
PurgDocNetAmount Net order value in transaction currency Optional
ServiceDocument Service document id Optional
ServiceDocumentItem Service document item id Optional
ServiceDocumentType Service document type Optional
TaxCode Tax on sales and purchase code Optional

unloaded
ValidityDate Validity date Optional

element)

element) - external ID
WBSElementInternalID Work breakdown structure element (WBS Obsolete

element) - internal ID [Please do not use.]
 Note
Create
Read
Update
Delete
Pricing Element
Technical name: PurOrderItemPricingElement
1/30/2023
Properties
 Note
ignored.
 Note
It is not possible to transfer pricing values 1:1 from an external system as some values are calculated automatically and IDs
are generated. Regarding the pricing details, the OData service contains elds with "Necessity": read-only, which are not
lled during a Post request.
If migrating from one system to another, it is recommended to use the same pricing procedure in the source and the target
system, to ensure that pricing results are the same. If rounding pro les are maintained (material master, MRT1 tab), do not
send condition data in the Post request as a payload.
AccessNumberOfAccessSequence Number of the access within the access Read-only

sequence
AccountKeyForGLAccount Account key Optional
AcctKeyForAccrualsGLAccount Account key - accruals / provisions Optional
AccrualsGLAccount Number of accruals account Optional
BillingPriceSource Price Source Optional
CndnIsRelevantForIntcoBilling Condition is relevant for intercompany Read-only

billing
CndnIsRelevantForInvoiceList Condition is relevant for invoice list Read-only
CndnIsRelevantForLimitValue Controls whether the condition is relevant Read-only

for limit values
CndnRoundingOffDiffAmount Rounding-off difference of the condition Optional
ConditionAcctAssgmtRelevance Relevance for account assignment Optional
ConditionAdjustedQuantity, Adjusted Quantity Optional
ConditionAlternativeCurrency Condition currency (for cumulation elds) Optional
ConditionAmount Condition value Read-only
ConditionAmountLimitExceeded Indicator for maximum condition basis Optional

value
ConditionAmountInLocalCrcy Condition value Optional
ConditionApplication Application Read-only
1/30/2023
ConditionBaseValue Value that is used as a basis for calculating, Read-only

for example, percentage conditions
ConditionBaseValueIntlUnit Currency key Optional
ConditionBaseValueUnit Condition unit (currency, sales unit or %) Optional
ConditionBasisLimitExceeded ConditionByteSequence Optional
ConditionByteSequence ConditionByteSequence Optional
ConditionCalculationType Calculation type for condition Read-only
ConditionCategory Condition category (examples: tax, freight, Read-only

price, cost)
ConditionClass Condition class Read-only
ConditionControl Condition control Read-only
ConditionCurrency Condition currency Mandatory
ConditionInactiveReason Condition is inactive Read-only
ConditionIsDeletable Condition is deletable Optional
ConditionIsForCon guration Condition is for con guration Read-only
ConditionIsForStatistics Condition is used for statistics Read-only
ConditionIsManuallyChanged Condition has been manually or Read-only

automatically changed or created
ConditionMatrixMaintRelevance Indicator: matrix maintenance Optional
CndnIsRelevantForIntcoBilling, Condition for intercompany billing Optional
CndnIsRelevantForLimitValue Condition update Optional
ConditionOrigin Origin of the condition Read-only
ConditionQuantity Condition quantity Optional
ConditionQuantityUnit Condition quantity unit Optional
ConditionRateAmount Condition amount Optional
ConditionRateRatio, Condition ratio (in percent or per mille) Optional
ConditionRateValue Value (amount or percentage) that is used Optional

for price conditions
ConditionRateValueIntlUnit Currency key Optional
ConditionRateValueUnit Currency key Optional
ConditionRecord Condition record number Read-only
ConditionScaleBasisCurrency Currency of the applied scale Read-only
ConditionScaleBasisUnit Unit of measure of the applied scale Read-only
ConditionScaleBasisValue Basis of the scale is used to determine the Read-only

applicable scale step
ConditionSequentialNumber Sequential number of the condition Read-only
1/30/2023
ConditionToBaseQtyDnmntr Denominator for converting condition units Optional

to base units
ConditionToBaseQtyNmrtr Numerator for converting condition units to Optional

base units
ConditionType Condition type Optional
ConditionTypeName Description Optional
Con gblParametersAndFormulas Identi er of CPF formula in document Optional
CumulatedConditionBasisValue Condition basis Optional
CustomerRebateRecipient Customer number (rebate recipient) Optional
FactorForConditionBasisValue Factor for condition basis value Read-only
FreightSupplier Account number of supplier Optional
GLAccount G/L account number Optional
IsGroupCondition Group condition Read-only
IsRelevantForAccrual Document or item is relevant for accrual Read-only
PeriodFactorForCndnBasisValue Factor for condition basis (period) Optional
PrcgProcedureCounterForHeader Condition counter (header) Optional
PriceConditionDeterminationDte Condition pricing date Read-only
PriceDetnExchangeRate Exchange rate for price determination Read-only
PricingDateTime Pricing date time Read-only
PricingDocument Pricing document Mandatory
PricingDocumentItem Pricing document item Mandatory
PricingProcedure Procedure (for example, pricing, output Optional

control, acct. det, consting, and so on)
PricingProcedureCounter Pricing procedure counter Mandatory
PricingProcedureStep Pricing procedure step Mandatory
PricingScaleBasis Scale basis indicator Read-only
PricingScaleType Scale type Read-only
StructureCondition Structure condition Optional
TaxCode Tax on sales/purchases code Optional
TaxCodeName Tax code description Optional
TaxJurisdictionLevel Tax jurisdiction code levvel Optional
TransactionCurrency Transaction currency Read-only
VariantCondition Variant condition key Optional
1/30/2023
WithholdingTaxCode Withholding tax code Optional
 Note
Create
Read
Update
Delete
Partner
Technical name: PurchaseOrderPartner
Properties
 Note
ignored.
DefaultPartner Speci es a partner as the default partner Optional

for a particular partner function.
EmploymentInternalID Personnel number Optional
PurchaseOrder Purchasing document number Read-only
PartnerFunction Abbreviated form of the name that Read-only

identi es the partner function.
PartnerCounter Sequential number that the system applies Read-only

when there is more than one partner for a
particular partner function.
PersonWorkAgreement Person work agreement Optional
Plant Plant Read-only
1/30/2023
PurchasingDocumentPartnerType Type of partner number Optional
PurchasingOrganization Denotes the purchasing organization Read-only
Supplier Business partner who offers or provides Read-only

SupplierContact Number of contact person Optional
SupplierHierarchyCategory Hierarchy category: supplier hierarchy Optional
SupplierSubrange Subdivision of a supplier's overall product Read-only

range according to various criteria.
CreatedByUser Created by user Read-only
 Note
Create
Read
Update
Delete
Invoicing Plan
Technical name: PurchaseOrderInvoicingPlan
Properties
 Note
ignored.
PurchaseOrder Purchasing document number Read-only
1/30/2023
PurchaseOrderItem Purchase order item number Read-only
InvoicingPlan Invoicing plan number Optional
InvoicingPlanType Type = 10 (periodic invoicing plan) Read-only
InvoicingPlanStartDate Validity start date for invoicing plan Read-only
InvoicingPlanEndDate Validity end date for invoicing plan Read-only
InvoicingPlanNextInvcDateRule Rule for Origin of Next Invoice Date Read-only
PurchaseOrderType Purchasing document type, for example, NB Read-only
PurchasingGroup Purchasing group Read-only
PurchasingOrganization Purchasing organization Read-only
 Note
Create
Read
Invoicing Plan Item

Technical name: PurchaseOrderInvoicingPlanItem
Properties
 Note
ignored.
PurchaseOrder Purchasing document number Optional
PurchaseOrderItem Purchase order item number Optional
InvoicingPlan Invoicing plan number Optional
1/30/2023
InvoicingPlanItem Item for invoice plan Optional
InvoicingPlanSettlementFrmDte Validity start date for invoicing plan Optional

settlement
InvoicingPlanSettlementToDte Validity end date for invoicing plan Optional

settlement
InvoicingPlanInvoicingDate Billing date Optional
InvoicingPlanAmount Value to be billed on date in invoicing plan Optional
TransactionCurrency Currency key Read-only
PurchasingOrganization Purchasing organization Read-only
PurchasingGroup Purchasing group Read-only
PurchaseOrderType Purchasing document type, for example, NB Read-only
 Note
Create
Read
Supplier Address
Technical name: PurchaseOrderSupplierAddress
Properties
 Note
ignored.
SupplierAddressID Address number Read-only
1/30/2023
Read-only: in case of UPDATE operation
AddressID Adress number Optional
AddressPersonID Person number Optional
AddressRepresentationCode Version id for international addresses Optional
AddressFullName Full name of person Optional
CorrespondenceLanguage Language key Optional
CityName City name Optional
DistrictName District name Optional
VillageName City (different from postal city) Optional
CompanyPostalCode Company postal code Optional
StreetPre xName1 Street pre x name 1 Optional
HouseNumberSupplementText House number supplement Optional
Building Building (Number or Code) Optional
Floor Floor in building Optional
RoomNumber Room or apartment number Optional
Country Country/region key Mandatory
Region Region (state, province, county) Optional
TransportZone Transport zone to or from which the goods Optional

are delivered
POBox PO box Optional
POBoxIsWithoutNumber Flag: PO box without number Optional
POBoxPostalCode PO box postal code Optional
POBoxLobbyName PO box lobby Optional
POBoxDeviatingCityName PO box city Optional
POBoxDeviatingRegion Region for PO box (country/region, state, Optional

province, and so on)
POBoxDeviatingCountry PO box of country/region Optional
CareOfName C/o name Optional
1/30/2023
DeliveryServiceTypeCode, Type of delivery service Optional
DeliveryServiceNumber Number of delivery service Optional
AddressTimeZone Address time zone Optional
FormOfAddress Form-of-address key Optional
EmailAddress Email address Optional
InternationalPhoneNumber International phone number Optional
InternationalFaxNumber International fax number Optional
StreetSuffixName1 Street suffix name 1 Optional
PrfrdCommMediumType Preferred communication Optional
OrganizationName1 Name 1 Optional
AddressSearchTerm1 Search term 1 Optional
AddressSearchTerm2 Search term 2 Optional
RegionalStructureCheckStatus City le test status Optional
 Note
Create
Read
Update
Delete
Item Delivery Address

Technical name: PurOrderItemDeliveryAddress
Properties
 Note
1/30/2023
ignored.
PurchaseOrderItem Purchase order item number Optional
DeliveryAddressID Address number Read-only
CorrespondenceLanguage Alphanumeric key that identi es the Optional

language the document is written in.
DistrictName District name Optional
CompanyPostalCode Company postal code Optional
Building Building Optional
Floor Floor Optional
RoomNumber Room number Optional
Country Country Mandatory
Region Region Optional
TransportZone Transport zone Optional
POBox Post box Optiona
POBoxPostalCode Postal code of post box Optional
POBoxDeviatingCityName Deviating city name of post box Optional
CareOfName Care of name Optional
AddressTimeZone Address time zone Optional
1/30/2023
FormOfAddress Form-of-address key Optional
EmailAddress Email address Optional
InternationalPhoneNumber International phone number Optional
InternationalFaxNumber International fax number Optional
PrfrdCommMediumType Preferred communication Optional
OrganizationName1 Organization name 1 Optional
AddressSearchTerm1 Address search term 1 Optional
AddressSearchTerm2 Address search term 2 Optional
RegionalStructureCheckStatus City le test status Optional
Include the properties of the entity, a short description and the necessity of the property.
 Note
Create
Read
Update
Delete
Order Con rmation - Receive

Technical name: OrderCon rmationRequest_In
This asynchronous inbound service enables you to receive order con rmations from an external supplier system in your SAP
S/4HANA buyer system. The supplier con rms the goods or services, their pricing and the delivery schedule. This message can
be generated by a sales order in the supplier SAP system, which in turn triggers a message through this web service, con rming
the purchase order. Upon receipt of this message, the order con rmation is generated in the SAP S/4HANA system.
Namespace: http://sap.com/xi/EDI
Service Structure
1/30/2023
The service contains a message header and a payload, containing the header and item information.
The below mentioned operations are supported while processing a message through web service:
Create: Create con rmation and set con rmed net price, con rmed delivery date and/or con rmed quantity.
Update: Update con rmation and set new con rmed net price, new con rmed delivery date and/or new con rmed
quantity.
Reject: Reject a line item if the supplier is unable to ful l the order for the material or goods.
The service message header contains information about the service, the involved sender and receiver as well as date and time.
The following nodes and elds are the most important ones:
ReferenceID Reference ID of the SOAP message
CreationDateTime Date and time at which the message was created.

This information is used to check for duplicate
incoming messages and to avoid that the same
message is processed again.
ReconciliationIndicator Reconciliation Indicator
SenderBusinessSystemID Unique identi er of the external system that sends

the message. This information is used to send back
response messages or follow-on messages to the
sender system.
RecipientBusinessSystemID Unique identi er of the external system that receives

the message. This information is used to receive
messages or follow-on messages from the sender
system.
SenderParty InternalID ID of the business partner that sends the message to

your SAP S/4HANA Cloud system. The ID must be
identical to the business partner's ID in your SAP
S/4HANA Cloud system.
RecipientParty InternalID ID of the business partner that receives the message

from your SAP S/4HANA Cloud system. The ID must
be identical to the business partner's ID in your SAP
S/4HANA Cloud system.
ContactPerson InternalID ID of the contact person
Nodes
The nodes contain the business data of the service.
Node Description Link to details
OrderCon rmation Header information for the order OrderCon rmationRequest_In -

con rmation OrderCon rmation
1/30/2023
Node Description Link to details
Item Item information for the order con rmation OrderCon rmationRequest_In - Item
Sample Payload
 Sample Code
<?xml version="1.0" encoding="UTF-8"?>
<n0:OrderConfRequest xmlns:n0="http://sap.com/xi/EDI" xmlns:prx="urn:sap.com:proxy:CC3:/1SAI/TASA
<MessageHeader>
<ID>0894EF4577B11EEB98A725B11960D1CC</ID>
<CreationDateTime>2021-01-28T07:19:36Z</CreationDateTime>
<SenderBusinessSystemID>0345235</SenderBusinessSystemID>
</MessageHeader>
<OrderConfirmation>
<PurchaseOrderID>4500011923</PurchaseOrderID>
<SalesOrderID>23183</SalesOrderID>
<SalesDocumentType>TA</SalesDocumentType>
<SalesOrganization>1010</SalesOrganization>
<DistributionChannel>10</DistributionChannel>
<OrganizationDivision>00</OrganizationDivision>
<SalesOrderCreationDate>2021-01-28</SalesOrderCreationDate>
<TransactionCurrency>EUR</TransactionCurrency>
<BuyerExchangeRate>1.0</BuyerExchangeRate>
<ItemListIsCompletelyTransferred>true</ItemListIsCompletelyTransferred>
<Party PartyType="SoldTo">
<BuyerPartyID>1010</BuyerPartyID>
<SupplierPartyID>10154802</SupplierPartyID>
<Address>
<FormOfAddressName>Company</FormOfAddressName>
<AddressName>Company Code 1010 - Address Name 1</AddressName>
<AddressAdditionalName>Company Code 1010</AddressAdditionalName>
<StreetName>XYZ</StreetName>
<StreetAddressName>ABC</StreetAddressName>
<CityName>DEF</CityName>
<Country>DE</Country>
<District>Industriegebiet</District>
<Region>BW</Region>
<EmailAddress>noreply@xyz.com</EmailAddress>
<CorrespondenceLanguage>de</CorrespondenceLanguage>
</Address>
</Party>
<Party PartyType="BillTo">
<Address>
<AddressName>Company Code 1010 - Address Name 1</AddressName>
<AddressAdditionalName>Company Code 1010</AddressAdditionalName>
<StreetAddressName>XYZ 16</StreetAddressName>
<CityName>Walldorf</CityName>
<District>Industriegebiet</District>
<Region>BW</Region>
<EmailAddress>sap@toyotabharat.com</EmailAddress>
</Address>
</Party>
<Party PartyType="Payer">
<Address>
<AddressName>Toyota Bharat</AddressName>
1/30/2023
<StreetName>Bhimenahalli, Bidadi</StreetName>
<StreetAddressName>41 Bhimenahalli, Bidadi</StreetAddressName>
<CityName>Bangalore</CityName>
<Country>IN</Country>
<Region>KA</Region>
<EmailAddress>sap@toyotabharat.com</EmailAddress>
<CorrespondenceLanguage>en</CorrespondenceLanguage>
</Address>
</Party>
<Party PartyType="ShipTo">
<Address>
<AddressName>Storage Location 101C - Address Nam</AddressName>
<StreetAddressName>XYZ 16</StreetAddressName>
<CityName>DEF</CityName>
<Region>BW</Region>
<EmailAddress>123@xyz.com</EmailAddress>
</Address>
</Party>
<RequestedDeliveryDate>2021-02-04</RequestedDeliveryDate>
<UnloadingPointName>FRONT_GATE</UnloadingPointName>
<OrderCombinationIsAllowed>true</OrderCombinationIsAllowed>
<HeaderIncoterms>
<IncotermsClassification>CFR</IncotermsClassification>
<IncotermsLocation1>DFG</IncotermsLocation1>
</HeaderIncoterms>
<PaymentTerms>
<SupplierPaymentTermsID>0004</SupplierPaymentTermsID>
</PaymentTerms>
<Item>
<PurchaseOrderItemID>000010</PurchaseOrderItemID>
<PurchaseOrderItemCategory>TAN</PurchaseOrderItemCategory>
<SalesOrderItemID>10</SalesOrderItemID>
<SalesOrderItemCategory>TAN</SalesOrderItemCategory>
<OrderItemText>Handelsware 11, PD, normaler Handel</OrderItemText>
<RequestedQuantity unitCode="PCE">10.0</RequestedQuantity>
<Product>
<BuyerProductID>TG11</BuyerProductID>
<SupplierProductID>TG11</SupplierProductID>
</Product>
<NetPrice>
<BaseQuantity unitCode="PCE">1.0</BaseQuantity>
</NetPrice>
<NetAmount currencyCode="EUR">1000.0</NetAmount>
<Plant>1010</Plant>
<ScheduleLine>
<ConfirmedDeliveryDate>2020-11-17</ConfirmedDeliveryDate>
<ConfirmedOrderQuantityByMaterialAvailableCheck unitCode="PCE">0.0</ConfirmedOrderQua
</ScheduleLine>
<ScheduleLine>
<ConfirmedDeliveryDate>2021-02-03</ConfirmedDeliveryDate>
<ConfirmedOrderQuantityByMaterialAvailableCheck unitCode="PCE">10.0</ConfirmedOrderQu
</ScheduleLine>
</Item>
</OrderConfirmation>
</n0:OrderConfRequest>
Authentication Method
1/30/2023
For this service, use the basic or X.509 authentication method to sign on.
The basic process authenticates you based on your user ID and password in the HTTP header (Document Authentication). This
option is supported for HTTP and HTTPS.

To be able to use this service, you have to con gure the following corresponding communication scenario:
For the scenario Sourcing and Procurement with Suppliers Integration, con gure communication scenario
SAP_COM_0224.
To display more information on the SAP API Business Hub, select the Details tab of the service.

Namespace: /MMEDI
Recipient Name: EDI_MM_CONF_RECIPIENT
Interface: ORDCFRQIN
OrderCon rmationRequest_In - OrderCon rmation

Use
The OrderCon rmation node contains the order con rmation header data.
 Note
Nodes and Fields
Node or Field Description Cardinality
PurchaseOrderID Purchase order ID 1
PurchasingDocumentType Identi er allowing differentiation 0..1

between various formats of a
document category.
1/30/2023
PurchasingOrganization A purchasing organization that 0..1

procures materials and
services, negotiates conditions
of purchase with vendors, and is
responsible for such
transactions.
PurchasingGroup Purchasing group is a key for a 0..1

buyer or group of buyers
responsible for certain
purchasing activities.
PurchaseOrderCreationDate Calendar date when a purchase 0..1

order is created
PurchaseOrderLastChangeDate Calendar date when a purchase 0..1

order is last modi ed
SalesOrderID A unique alphanumeric identi er 0..1

assigned to a sales order
SalesDocumentType An indicator for controlling the 0..1

sales documents de ned in the
system that allows the system
to process different business
transactions in different ways
SalesOrganization A organizational unit that 0..1

structures the company
according to its sales
requirements. It is an area for
sales that combines the sales
relevant master data for
customers, products and price
lists
DistributionChannel A channel through which 0..1

saleable goods or services
reach customers
OrganizationDivision Organization division 0..1
SalesGroup An organizational unit that 0..1

performs and is responsible for
sales transactions
SalesOffice A manufacture's office that 0..1

supports the activities of a
company's sales agents
SalesOrderCreationDate Sales order creation date 0..1
TransactionCurrency Transaction currency 0..1
BuyerCompanyCodeCurrency Buyer company code currency 0..1
BuyerExchangeRate Buyer exchange rate 0..1
CorrespondanceExternalReference Correspondance external 0..1

reference
1/30/2023
ItemListIsCompletelyTransferred Indicator for status "completely 0..1

transferred"
Party see 0..unbounded

OrderCon rmationRequest_In -
Party
RequestedDeliveryDate Requested delivery date 0..1
UnloadingPointName Unloading point name 0..1
ReceivingPoint Receiving point 0..1
DeliveryBlockReason Delivery blok reason 0..1
CompleteDeliveryIsDe ned Complete delivery is de ned 0..1
OrderCombinationIsAllowed Order combination is allowed 0..1
HeaderIncoterms 0..1
IncotermsVersion Incoterms version 0..1
IncotermsClassi cation Incoterms (Part 1) 0..1
IncotermsLocation1 Incoterms location 1 0..1
PaymentTerms Payment terms 0..1
BuyerPaymentTermsID Buyer payment terms ID 0..1
SupplierPaymentTermsID Supplier payment terms ID 0..1
FixedValueDate Fixed value date 0..1
CashDiscount1Percent Cash discount percentage 1 0..1
CashDiscount1Days Days for cash discount 1 0..1
CashDiscount1Description Cash discount description 1 0..1
CashDiscount2Percent Cash discount percentage 2 0..1
CashDiscount2Days Days for cash discount 2 0..1
CashDiscount2Description Cash discount description 2 0..1
NetPaymentDays Net payment days 0..1
NetPaymentDescription Net payment description 0..1
PaymentCard Payment card 0..1
PaymentCardType Payment card type 0..1
PaymentCardID Payment card ID 0..1
PaymentCardValidityEndDate Payment card validity end date 0..1
PaymentCardHolderName Payment card holder name 0..1
PaymentCardBillingAmount Payment card billing amount 0..1
1/30/2023
Text Type A text that you can de ne in 0..unbounded

master records or documents.
The mandatory attribute

speci es the abbreviated form
of the name that identi es
various types of texts.
BuyerTextElementID Text element ID on the buyer 0..1

system
SupplierTextElementID Text element ID on the supplier 0..1

system
TextElementLanguage Text element language 0..1
TextElementText Text element text 0..1
TextElementTextFormat Text element text format 0..1
Attachment NOT IN USE
FileName NOT IN USE
MimeType NOT IN USE
FileSize NOT IN USE
OrderCon rmationRequest_In - Party
Nodes and Fields of the Party Node

The Party node can be included at header and at item level of the order con rmation.
 Note
Party GlobalLocationNumber Unique identi cation 0..1

number. The Global
Location Number (GLN)
identi es physical, legal,
or functional units
belonging to companies
or parts of companies.
BuyerPartyID Buyer party ID 0..1
SupplierPartyID Supplier party ID 0..1
Address 0..1
FormOfAddress Form of address 0..1
FormOfAddressName Form of address name 0..1
AddressName Address name 0..1
1/30/2023
AddressAdditionalName Address additional 0..1

name
StreetName Street name 0..1
HouseNumber House number 0..1
StreetAddressName Street address name 0..1
PostalCode Postal code 0..1
CityName City name 0..1
Country Country 0..1
District District 0..1
Region Region 0..1
PhoneNumber Phone number 0..1
FaxNumber Fax number 0..1
FaxExtension Fax extension 0..1
FaxCountryDialingCode Fax country dialing code 0..1
FaxCountry Fax country 0..1
EmailAddress Email address 0..1
CorrespondenceLanguage Correspondence 0..1

language
AddressTimeZone Address time zone 0..1
ExternalAddressParserCode External address parser 0..1

code
PartyType The business partner is 0..unbounded

a person, organization,
group of persons, or
group of organizations in
which a company has a
business interest.

PartyType speci es
the abbreviated form of
the name that identi es
the partner function.
 Note
Chrome.
OrderCon rmationRequest_In - Item

Use
1/30/2023
The Item node contains the elds of the order con rmation item.
 Note
Nodes and Fields
ActionCode Action code n/a
PurchaseOrderItemID Purchase order item id 0..1
PurchaseOrderItemCategory Purchase order item category 0..1
SalesOrderItemID Sales order item id 0..1
SalesOrderItemCategory Sales order item category 0..1
OrderItemText Order item text 0..1
RequestedQuantity unitCode The total (rounded) order 0..1

quantity for this item.
The optional attribute

unitCode speci es the unit
of measure of the ordered
material is.
HigherLevelItem Higher level item 0..1
SalesDocumentRjcnReason Sales document rejection 0..1

reason
SalesDocumentRjcnReasonName Sales document rejection 0..1

reason name
ReturnAttributes 0..1
ProductToRemainWithCust Indicator set by the supplier 0..1

to signal that the returned
goods should remain at the
customer's site
ReturnMaterialAuthID Speci es the return material 0..1

authorization (RMA) number
from the supplier; this item-
speci c number indicates
that the supplier has
accepted the return order.
DeliveryDateQuantityIsFixed Indicator that delivery date 0..1

quantity is xed
DepartmentClassi cationByCust Department classi cation by 0..1

customer
MaterialUsageIndicator Indicator of material usage 0..1
IsUIDRelevant Indicator for UID relevance 0..1
1/30/2023
CustRetMatlAuthzn Customer Material 0..1

Authorization
RejectionReasonText Reason for rejection 0..1
Product 0..1
GlobalTradeItemNumber A 14-digit number used to 0..1

uniquely identify products
worldwide
BuyerProductID Buyer product id 0..1
SupplierProductID Supplier product id 0..1
ManufacturerPartNumber This eld carries the data of 0..1

the eld Mfr Part Number
maintained in the tab
Material Data of the purchase
order item.
Manufacturer This eld carries the data of 0..1

the eld Manufacturer
order item.
ManufacturerName This eld carries the data of 0..1

the eld manufacturer name
order item.
NetPrice 0..1
Amount Net price amount 1
currencyCode The mandatory attribute n/a

currencyCode speci es
the currency.
BaseQuantity Base quantity 1
unitCode The quantity on which the

amount or percentage is
based.

unitCode speci es the
order unit (for example,
bottles).
NetAmount currencyCode Contains the difference of the 0..1

actual and the tax amounts
currencyCode speci es
the currency.
MaximumNumberOfPartialDelivery Maximum number of partial 0..1

delivery
UnloadingPointName Unloading point name 0..1
1/30/2023
ReceivingPoint Receiving point 0..1
Plant A place where materials are 0..1

produced, or goods and
services are provided
StorageLocation A place used for storing 0..1

items in a warehouse or other
repository
Party OrderCon rmationRequest_In 0..unbounded

- Party
Incoterms Incoterms 0..1
IncotermsClassi cation Incoterms 0..1
PurgDocOrderAcknNumber This eld carries value of the 0..1

eld Order Ack. as
maintained in the
Con rmations tab of the
purchase order.
ScheduleLine 0..unbounded
ScheduleLineOrderQuantity Schedule line order quantity 0..1

based.

bottles).
RequestedDeliveryDate Requested delivery date Optional
RequestedDeliveryTime Requested delivery time Optional
RequestedDeliveryTimeZone Contains time zone de ned in Optional

the delivery address of the
purchase order, if the time
zone is not de ned in the
purchase order, then the
system time zone is used in
this eld.
RequestedDeliveryDateTime Contains date, time, and time Optional

zone offset de ned in the
purchase order.
Con rmedDeliveryDate The date on which it has been 0..1

con rmed that the goods will
arrive at their destination
Con rmedDeliveryTime The time on which it has been 0..1

con rmed that the goods will
arrive at their destination
1/30/2023
Con rmedDeliveryTimeZone Contains time zone de ned in 0..1

the supplier system
Con rmedDeliveryDateTime Contains date, time, and 0..1

timezone offset de ned in the
supplier system
Con rmedOrderQuantityByMaterialAvailableCheck Con rmed order quantity by 0..1

material available check
Service: Service start and end date for 0..1

PerformancePeriodStartDate the purchase order.
PerformancePeriodEndDate

based.

bottles).
Con rmedExpectedOverallLmtAmt This eld carries the total

amount con rmed by the
supplier from the external
system for the limit items.
SubcontractingComponentDetails DO NOT USE THIS FIELD
Text BuyerTextElementID Text element ID on the buyer 0..1

system
SupplierTextElementID Text element ID on the 0..1

supplier system
TextElementLanguage Text element language 0..1
TextElementText Text of the text element 0..1
TextElementTextFormat Format of the text element 0..1
Type Type of the text element 0..1
OrderCon rmationRequest_In - Party
Nodes and Fields of the Party Node

The Party node can be included at header and at item level of the order con rmation.
 Note
1/30/2023
Party GlobalLocationNumber Unique identi cation 0..1

number. The Global
Location Number (GLN)
identi es physical, legal,
or functional units
belonging to companies
or parts of companies.
BuyerPartyID Buyer party ID 0..1
SupplierPartyID Supplier party ID 0..1
Address 0..1
FormOfAddress Form of address 0..1
FormOfAddressName Form of address name 0..1
AddressName Address name 0..1
AddressAdditionalName Address additional 0..1

name
StreetName Street name 0..1
HouseNumber House number 0..1
StreetAddressName Street address name 0..1
PostalCode Postal code 0..1
CityName City name 0..1
Country Country 0..1
District District 0..1
Region Region 0..1
PhoneNumber Phone number 0..1
FaxNumber Fax number 0..1
FaxExtension Fax extension 0..1
FaxCountryDialingCode Fax country dialing code 0..1
FaxCountry Fax country 0..1
EmailAddress Email address 0..1
CorrespondenceLanguage Correspondence 0..1

language
AddressTimeZone Address time zone 0..1
ExternalAddressParserCode External address parser 0..1

code
1/30/2023
PartyType The business partner is 0..unbounded

a person, organization,
group of persons, or
group of organizations in
which a company has a
business interest.

PartyType speci es
the abbreviated form of
the name that identi es
the partner function.
 Note
Chrome.
Purchase Requisition / Shopping Cart
Shopping Cart - Replicate

Technical name: <PurchaseRequisitionReplicationRequest_Out>
This service enables you to replicate the shopping cart from an SAP S/4HANA system to an external system. It is based on the
SOAP protocol.
Service Request
The service message header contains information on the service, the involved sender and receiver as well as date and time. The
following nodes and elds are the most important ones:
CreationDateTime Date and time at which the message was created
SenderBusinessSystemID ID of the SAP S/4HANA system that sends the message
RecipientBusinessSystemID ID of the external system that will receive the message
Service Nodes
Service Node Description Link to details
MessageHeader Node that contains details of the message PurchaseRequisitionReplicationRequest_Out

header – MessageHeader
1/30/2023
Service Node Description Link to details
PurchaseRequest Node that contains details of purchase PurchaseRequisitionReplicationRequest_Out

requisition – PurchaseRequest

To be able to use this service, you have to con gure the following communication scenario: SAP_COM_0090

Namespace: /MMHUB
Recipient Name: PROC_TECH
To assign recipients to users, use the Assign Recipients to Users app from the Communication Management – Message
PurchaseRequisitionReplicationRequest_Out – MessageHeader
Use
Node that contains the message header details of the purchase requisition document.
Nodes and Fields

The following table provides an overview of the elds.
ID ID of the purchase
requisition in the SAP
S/4HANA Cloud hub
system
PurchaseRequisitionID ID of the purchase

requisition in the
connected system
UUID Universal Unique

Identi er. A global
unique identi er that is
generated from the
system timestamp and
the network address.
1/30/2023
ReferenceID ID of the purchase

requisition in the
external system
Reference UUID Contains the UUID

reference in order to
connect the sender and
receiver systems
CreationDateTime Date and time when the

message has been
created
SenderBusinessSystemID ID of the SAP S/4HANA

system that sends the
message
RecipientBusinessSystemID ID of the external system

that will receive the
message
SenderParty The SAP S/4HANA

system
InternalID Internal ID
schemeID Identi es the ID scheme

of the sender party
schemeAgencyID ID of the sender party

that maintains the ID
scheme
StandardID Standard ID
ContactPerson Contact person
OrganisationFormattedName Name of the organisation

who sent the message
PersonFormattedName Name of the person who

sent the message
PhoneNumber Phone number of the

sending party.
AreaID Area code
SubscriberID Subscriber code
ExtensionID Extension
CountryCode Country code
CountryDiallingCode Country dailling code
CountryName Country name
1/30/2023
languageCode Language in which the

results of the service
requested are to be
delivered. The
description is available
in multiple languages.
FaxNumber Fax number of the

sending party
AreaID Area code
Extension Extension

requested are to be
delivered. The
EmailURI Email address of the

sending party
RecipientParty The connected system
schemeID Identi es the ID scheme
schemeAgencyID ID of the party that

maintains the ID scheme
StandardID Standard ID
ContactPerson Contact person
OrganisationFormattedName Name of the organization

who sent the message
PersonFormattedName Name of the person who

sent the message
PhoneNumber Phone number of the

receiving party
AreaID Area code
1/30/2023
CountryName Country Name

requested are to be
delivered. The
FaxNumber Fax number of the

receiving party
AreaID Area code

requested are to be
delivered. The
EmailURI Email address of the

receiving party
BusinessScope Business scope
TypeCode Type code
listID Identi es a list of codes

that belong together.
Only unique for the
agency that manages the
list.
listVersionID Identi es the version of

a code list
listAgencyID Identi es the agency

that manages the code
list (such as a
standardization body).
listAgencySchemeID Identi es the agency ID

scheme
listAgencySchemeAgencyID ID of the agency that

maintains the ID scheme
 Note
1/30/2023
To display more information about the service node on the SAP API Business Hub, select the operation. This works best in
Mozilla Firefox or Google Chrome.
PurchaseRequisitionReplicationRequest_Out – PurchaseRequest
Use
Node that contains the details of the purchase requisition document.
Nodes and Fields
 Note
In the following table, eld attributes are marked in blue.
The following table provides an overview of the elds.
errorResponseIndicator The indicator which tells if an error has occurred in response of the service
Description Description of the purchase requistion item
ID Purchase requisition item number in hub system
PurchaseRequisitionItemID Purchase requisition item number in connected system
CentralRequisitionUpdtCtrlSttg Source of update of the purchase requisition in the connected system
CntrlReqnApprvlStsInRpldReqn Approval status of the purchase requisition
CntrlReqnIsRpldBfrApprvl The indicator tells if the replication of the purchase requisition to the connected
system happens before it is approved in the hub system.
TextCollection Collection of header texts
ProductProcurementArrangementID Depicts an info-record ID in an external system
Typecode Item type code
ProcessingTypeCode Item category in purchase requisition document
PostingDate Date at which the purchase requisition was requested
OrderingDate Date at which the purchase requisition was released
CancelledIndicator Deletion indicator
TotalAmount Total value of the purchase requisition item
ValuationPrice Price in purchase requisition item
TotalRequestedQuantity Item quanity of purchase requisition requested
RequestorPersonName Name of the requestor who requested the purchase requisition document
DeliveryPeriod Date and time at which the purchase requisition is delivered
Product Material in the external system
ProductCategory Material group
1/30/2023
Batch Batch number
CurrencyCode Currency code
TaxCode Tax code
Percent Percent
BaseQuantity Base quantity
BaseQuantityTypeCode Base quantity type code
Amount Amount
SellarParty Fixed supplier of an external system
ProposedSellarParty Desired supplier of an external system
ResponsiblePurchasingOrganisationParty Purchasing organization
ResponsiblePurchasingGroupParty Purchasing group
InventoryManagedLocation Storage location
SupplyingPlantID Issuing Plant ID
ReceivingPlantID Plant ID of an external system
TextCollection Collection of item texts
PurchasingContractReference Contract reference of an external system
AccountingCodingBlockDistribution Account assignment data of purchase requisition item
AttachmentFolder Attachment
AddDataLocIBR Usage of material
actionCode Action (create/change) of purchase requisition item
 Note
To display more information about the service node on the SAP API Business Hub, select the operation. This works best in
Mozilla Firefox or Google Chrome.
Purchase Requisition - OData V2

Technical name: API_PURCHASEREQ_PROCESS_SRV
This service enables you to read, create, update, and delete purchase requisitions through an API call from a source system
outside SAP S/4HANA Cloud.
Service Structure
1/30/2023
The purchase requisition has the following entity structure. It contains header, item, account assignment, item notes and
delivery address nodes.
Entities
Purchase Requisition Header information for purchase requisition Purchase Requisition

(A_PurchaseRequisitionHeader)
Item (A_PurchaseRequisitionItem) Item information for purchase requisition Item
Account Assignment Account assignment information for Account Assignment

(A_PurReqnAcctAssgmt) purchase requisition
Delivery Address Delivery address information for purchase Delivery Address

(A_PurReqAddDelivery) requisition
Item Notes (A_PurchaseReqnItemText) Item text information for purchase Item Notes
requisition
Batch and Non-Batch Operations
Single mode is only supported for the following OData operations:
Entity POST PATCH DELETE
A_PurchaseRequisitionHeader YES YES NO
A_PurchaseRequisitionItem YES YES NO
1/30/2023
A_PurReqnAcctAssgmt NO YES NO
A_PurReqAddDelivery NO YES NO
A_PurchaseReqnItemItext YES YES YES
Batch mode is only supported for the following OData operations:
Batch Operations
A_PurchaseRequisitionHeader YES YES NO
A_PurchaseRequisitionItem YES YES NO
A_PurReqnAcctAssgmt YES YES NO
A_PurReqAddDelivery NO YES NO
A_PurchaseReqnItemItext YES YES YES
Service Response
1. Response Codes for Batch and Non-Batch Operations
Response Codes
Operation Success/Failure Response Code Description
Batch Success 202 The system displays a self-

explanatory detailed
Failure 400/500 message.
Batch (Change Set Level) Success 201/204
Failure 400
Non-Batch Success 201/204
Failure 400/500
2. Error Messages
Message Class and Message Number Description
MMPUR_REQ_COMMON/ You cannot edit referenced text.
Message No. 098
MMPUR_REQ_COMMON/ You cannot update the deleted purchase requisition items.
Message No.125
MM_PUR_REQN/ Purchase requisition &1 updated. Status changed to enable

resubmission.
Message No. 025
MM_PUR_REQN/ PR item &1 updated. Status changed to enable resubmission.
Message No. 026
1/30/2023
MMPUR_REQ_COMMON/ You can only update one purchase requisition per change set.
Message No. 033
MMPUR_REQ_COMMON/ You can create items belonging to only one origin in one PR
Message No. 135
MMPUR_REQ_COMMON/ You must use multiple changesets to create multiple PRs
Message No. 136
MMPUR_REQ_COMMON/ You can combine operations pertaining to only one PR in one

changeset
Message No. 137
MMPUR_REQ_COMMON/ Please provide purchasing document type
Message No. 143
MMPUR_REQ_COMMON/ Please use same purchasing doc. type for header and items
within a PR
Message No. 145
MMPUR_REQ_COMMON/ Cannot assign info record or contract as SoS for enhanced limit
item
Message No. 156
MMPUR_REQ_COMMON/ You cannot create or add limit items in a central purchase

requisition
Message No. 157
MEPO/ Creating an enhanced limit item with a material is not allowed.
Message No. 169
MEPO/ The expected value exceeds the overall limit.

Message No. 892
MMPUR_SPROC/Message No. 16 Multiple account assignments are not allowed for enhanced
limit items.
MMPUR_REQ_SERVPROC/Message No. 019 Item set &1 does not have a subordinate item.
MMPUR_REQ_SERVPROC/Message No. 020 Hierarchy level limit reached for the item &1.
MMPUR_REQ_SERVPROC/Message No. 031 &1 in item &2 cannot be edited.
MMPUR_REQ_SERVPROC/Message No. 034 A hierarchy list could not be formed using the entered values.
MMPUR_REQ_SERVPROC/Message No. 035 You cannot insert or move an item in a hierarchy list.
MMPUR_REQ_SERVPROC/Message No. 037 Cannot enter hierarchy values in a at list
MMPUR_REQ_SERVPROC/Message No. 042 Provide the parent item details before the subitem details for
item &1.
MMPUR_REQ_SERVPROC/Message No. 043 You cannot have an item note for &1 as it is an itemset.
MMPUR_REQ_SERVPROC/Message No. 044 You cannot change an item set into an item or vice versa.
Error Handling
To monitor messages transferred by this service, you need to assign the following recipient to the users:
1/30/2023
Namespace: /MMPUR
Recipient Name: MMPUR_PR_ODATA_RECEIVERS
Assign Recipients and Monitor Messages
To assign recipients to users, use the Assign Recipients to Users app from the Communication Management – Message
Monitoring Con guration (SAP_CA_BC_COM_CONF_PC) business catalog. For more information, see:
Assign Recipients to Users
Communication Management
To monitor messages, use the Message Dashboard app from the Communication Management - Message Monitoring and Error
Handling (SAP_CA_BC_COM_ERR_PC) business catalog.
To view and lter error logs related to SOAP and OData web services, use the Communication Management - Technical
Message Monitoring (SAP_CA_BC_COM_TECH_ERR_PC) business catalog.
For more information, see:
SOAP Error Log and OData Error Log
Message Dashboard
Message Monitoring
The business role template Con guration Expert – Business Network Integration (SAP_BR_CONF_EXPERT_BUS_NET_INT)
contains both of these business catalogs.
Constraints
The constraints are as listed below:
Operation Constraints
Create Only authorized roles can be used to create purchase requisition through an API call. The following
authorization objects for purchase requisitions are relevant:
M_BANF_BSA
M_BANF_EKG
M_BANF_EKO
M_BANF_WRK
1/30/2023
Update
Only GET, PATCH and POST are allowed with the OData call URL. You cannot use the methods,
DELETE, MERGE, and HEAD in OData call URL. Usage of any of these methods would result
in an error.
PATCH and POST methods are allowed with the batch call request. You cannot use the
methods DELETE, MERGE, HEAD in the change set of Batch Call request. Usage of any of
these methods would result in an error.
Multiple purchase requisitions can be updated using multiple change sets. You cannot update
more than one purchase requisition within one change set. ONLY ONE purchase requisition
can be updated in a single change set.
Only authorized roles can be used to update purchase requisition through an API call.
Related Events
Purchase Requisition Events
The link to the API on the SAP API Business Hub: Purchase Requisition .
 Note
Purchase Requisition
Technical name: A_PurchaseRequisitionHeader
Use
This API node contains the purchase requisition header elds.
Parameters
PurchaseRequisition A requisition to purchase the POST: Optional

external procurement of materials
PATCH: Not Applicable
PurchaseRequisitionType The type of purchase requisition POST: Optional
PurReqnDescription Description of the purchase Optional

requisition header
1/30/2023
SourceDetermination Automatic Source of Supply POST: Optional

assignment
PATCH, GET: Not Applicable
 Note
The value of this parameter is
not persisted
PurReqnDoOnlyValidation A ag for simulation of purchase Optional

requisition creation.
If the ag is set to True, the

purchase requisition is validated
but not created.
Item
Technical name: A_PurchaseRequisitionItem
Use
This API node contains the purchase requisition item elds.
Parameters
AddressID Address identi er Deprecated
BaseUnit Unit of Measure POST: Mandatory
Batch A batch is a homogenous subset of a material that is Optional

managed separately from other subsets of the same
material
ConsumptopnPosting Consumption posting Optional
CreatedByUser User ID of creator Read Only
CreationDate Date of creation Deprecated
DeliveryAddressID Delivery address Read Only
DeliveryDate Delivery date Optional
ExpectedOverallLimitAmount Amount expected to be spent on the limit item Mandatory for Limit Items, that is for items
with PurchasingDocumentItemCategory = 'A'
1/30/2023
ExternalApprovalStatus External Processing Status Optional
External solutions integrated with SAP S/4HANA

Cloud can create purchase requisition items in SAP
S/4HANA Cloud System with external processing
status as In Process Externally, that is, the value of
the eld ExternalApprovalStatus must be set to ʻP’.
The solutions can then invoke the operations
EnableForPurchasing and
DiscardFromPurchasing on these purchase
requisition items, and enable them for purchasing or
discard them from purchasing in SAP S/4HANA
Cloud System.
FixedSupplier Fixed supplier Optional
GoodsReceiptIsExpected Indicates that a goods receipt is allowed and Optional

expected.
GoodsReceiptsIsNonValuated Goods receipt non-valuated Optional
IsClosed Document is closed Optional
IsDeleted Indicates if the object is deleted Optional
IsOutline This is used for items in a hierarchy list. It is set to Optional

true for item sets, and set to false for functional
items. In the case of at list, this parameter need not
be provided.
IsPurReqnBlocked Indicates if purchase requisition is blocked Optional
ItemDeliveryAddressID Delivery address identi er Optional
ItemNetAmount Item net amount in transaction currency Read Only
LastChangeDateTime Time stamp for last changed Read Only
ManualDeliveryAddressID Manual address identi er in purchasing document Read Only

item
MaterialGoodsReceiptDuration Goods receipt processing duration in working days Optional
MaterialPlannedDeliveryDurn Planned delivery time in days Optional
MaterialRevisionLevel Revision Level Optional
MinRemainingShelfLife Minimum remaining shelf life Optional
MRPController MRP controller or team of MRP controllers Optional

responsible for material
1/30/2023

assignment. It can be one of the following:
Single Accounting - ""
Distribution on Quantity Basis - "1"
Distribution by Percentage - "2"
 Note
Based on the distribution indicator chosen, you
must pass appropriate values for the parameter
"MultipleAcctAssgmtDistrPercent" in
A_PurReqnAcctAssgmt.
OrderedQuantity Ordered quantity Optional
 Note
You must always provide the <BaseUnit>
corresponding to the <OrderedQuantity> value, in
each and every operation.
OverallLimitAmount Maximum amount that can be spent on the limit Mandatory for Limit Items, that is for items
item. It is the upper limit that the expected value of with PurchasingDocumentItemCategory = 'A'
the limit item (ExpectedOverallLimitAmount) must
not exceed.
PATCH: Optional
ProcessingStatus Processing status Read Only
N - Not edited
B - PO created
A - RFQ created
K - Contract created
L - Scheduling agreement created
S - Service entry sheet created
F - External Contract Created
G - External RFQ Created
ProductType Identi es the product type group, which is used to Optional

differentiate between materials and lean services.
For example,
1 - Material
2 - Service
1/30/2023
PurchaseContract A legally binding purchase agreement that contains Optional

special conditions that are negotiated between a
buyer and a seller, covering goods to be supplied or
services to be performed.
PurchaseRequisition A requisition to purchase the external procurement of POST: Mandatory

materials.
PurchaseRequisitionIsFixed Indicates that a purchase requisition is xed and Optional

therefore cannot be changed by material
requirements planning.
PurchaseRequisitionItem Item Number of purchase requisition POST: Optional
PurchaseRequisitionItemText Purchase requisition item text Optional
PurchaseRequisitionPrice Price in purchase requisition POST: Optional

 Note
You must always provide the
<PurReqnItemCurrency> corresponding to the
<PurchaseRequisitionPrice> value, in each and
every operation.
PurchaseRequisitionStatus Requisition processing state Deprecated
PurchaseRequisitionType Purchase requisition type POST: Optional
PurchasingDocument Purchasing document number Optional
PurchasingDocumentCategory Purchasing document category Read Only
PurchasingDocumentItem Purchasing document item number Optional
PurchasingDocumentItemCategory Item category in purchasing document Optional
'0' - Standard Item
'A' - Limit Item
PurchasingDocumentSubtype Control indicator for purchasing document type Read Only
PurchasingGroup Purchasing group POST: Mandatory
PATCH: Optional
PurchasingInfoRecord Purchasing information record Optional
PurchasingParentItem In the case of hierarchy list, this parameter is used to Optional

provide the item number of the parent item. For at
list, since all the items are in the same level, this
parameter need not be provided.
1/30/2023
PurgCon gurableItemNumber This parameter provides the hierarchy number of the Optional
items in a hierarchy list. This parameter is empty
("") in the case of at list.
PurgExternalSortNumber This parameter indicates the position of the item Optional

within a particular level of a hierarchy list. This
parameter is '0' in the case of at list.
PurReqCreationDate Purchase request or purchase requisition creation Read Only

date
PurReqnItemCurrency Purchase requisition item currency key Optional
PurReqnExternalReference External Document Optional
PurReqnItemExternalReference External Item Optional
PurReqnTypeExternalReference External Document Type Optional
PurReqnExternalSystemId External System ID Optional
PurReqnExternalSystemType External System Type Optional
PurReqnProcessingType Processing State Read Only
PurReqnProcessingDateTime Time stamp Read Only
PurReqnOrigin Creation indicator (Purchase Requisition/Schedule POST: Optional

Lines)
Some of the possible values are:
'R' - Realtime (manual)
'S' - Self-Service Procurement
PurReqnPriceQuantity Price unit Optional
 Note
corresponding to the <PurReqnPriceQuantity>
value, in each and every operation.
PurReqnReleaseStatus Purchase requisition release status Read Only
01 - Version in Process
02 - Active
03 - In Release
04 - For Overall Release
05 - Release Completed
08 - Release Refused
PurReqnSourceOfSupplyType Purchase requisition source of supply type Read Only
PurReqnSSPAuthor Author of requisition Optional
PurReqnSSPCatalog Purchase requisition SSPCatalog user ID Optional
PurReqnSSPCatalogItem Purchase requisition SSPCatalog item ID Optional
1/30/2023
PurReqnSSPCrossCatalogItem Purchase requisition SSPCatalog item key Optional
PurReqnSSPRequestor Requestor of purchase requisition Optional
PurContractForOverallLimit Reference Contract for limit items of type Service Optional
ReleaseCode Purchasing document release indicator Optional
ReleaseIsNotCompleted Release not complete Optional
ReleaseStrategy Release strategy Deprecated
 Note
corresponding to the <RequestedQuantity>
RequirementTracking Requirement tracking number Optional
Reservation Document number of the Reservation follow-on Read Only

document, if any, that is created for the purchase
requisition item.
ServicePerformer A person who carries out a service Optional
SourceOfSupplyIsAssigned Indicator if source of supply is assigned Read Only
StorageLocation A location where stock of materials is stored within a Optional

plant
Supplier Supplier Optional
SSPReqrUserId Requestor of SSP purchase requisition Optional
SSPAuthorExternalBPIdnNumber Business Partner Identi er for purchase requisition Optional
TaxCode Tax code Optional
ProcmtHubBackendBusSyst Backend Business System Optional
PurchaseOrderPriceType The price in the purchase order item is adopted from Optional
the purchase requisition item, based on this
parameter. The possible values are:
' ' - Do not adopt
'1' - As gross price
'2' - As net price
Account Assignment
1/30/2023
Technical name: A_PurReqnAcctAssgmt
Use
This API node contains the account assignment elds that correspond to the purchase requisition item.
Parameters
BaseUnit Unit of Measure Read Only
BusinessProcess Identi es a process in a company that uses Optional

resources and can involve the activities of
different departments
ChartOfAccounts Chart of Account Optional
CommitmentItem Commitment item Optional
CostElement General Ledger (GL) account number Optional
CreationDate Date of creation Optional
EarmarkedFundsDocument Business transaction in funds management Optional

which claims already allocated budget for
expected revenues or expenditures
FixedAsset A unique ID for xed asset in asset Optional

accounting
Fund Fund Optional


GrantID Grant identi er Optional
IsDeleted Account assignment if it is marked for Optional

deletion
MasterFixedAsset Main or master asset number Optional
1/30/2023

account assignment
 Note
The value that you provide for this
parameter must correspond to the value
of the parameter
"MultipleAcctAssgmtDistribution" in
A_PurchaseRequisitionItem.
If "MultipleAcctAssgmtDistribution"
in A_PurchaseRequisitionItem is
Single Accounting - "",
MultipleAcctAssgmtDistrPercent
must be 0
Distribution on Quantity Basis - "1",
must be 0
Distribution by Percentage - "2",
pass the percentage split for the
accounting lines. For example,
Accounting line 1 - 60.5
NetworkActivity Network activity Optional
NetworkActivityInternalID Network activity identi er Optional
OrderIntBillOfOperationsItem An identi er of an item of the internal bill of Optional

operations assigned to an order, for
example, a production order or a network.
OrderInternalID The internal identi er of an order. Optional
ProcessOrder Manufacturing order used in process Optional

industries. They are used for the production
of materials or for rendering of services in a
speci c quantity on a speci c date.
Pro tabilitySegment Pro tability Segment Number (CO-PA) Optional

project.
ProjectNetworkInternalID Routing identi er for operations in the order Optional
1/30/2023
PurchaseReqnAcctAssgmtNumber Serial Number for Purchase Requisition PATCH: Not Applicable

Account Assignment Segment
PurchaseRequisition Purchase requisition PATCH: Not Applicable
PurchaseRequisitionItem Purchase requisition item PATCH: Not Applicable
PurchaseRequisitionType Type of purchase requisition Optional
PurReqnNetAmount Net amount of purchase requisition Optional
 Note
<BaseUnit> corresponding to the
<Quantity> value, in each and every
operation.
SalesDocumentItem Sales document item Optional
ScheduleLine Delivery schedule line number Optional
SDDocument Sales and distribution document number Optional

unloaded

element)
Delivery Address
Technical name: A_PurReqAddDelivery
Use
This API node contains the purchase requisition item delivery address elds.
Parameters
1/30/2023
AdditionalStreetPre xName Additional address eld which is printed Optional

above the street line
AdditionalStreetSuffixName Additional address eld which is printed Optional

under the street line
AddressID Address identi er PATCH: Not Applicable
AddressTimeZone Time zone of the address Optional
AddressType Delivery address type Read Only
'L' - Storage Location
'P' - Plant
'U' - User Entry
'R' - Reference
 Note
Following address types are NOT
supported:
'C' - Customer
'S' - Supplier
Address type 'R' is not supported for

purchase requisitions of origin 'S' (Self-
Service Procurement).
Building Building name Optional
BusinessPartnerName1 Name1 for a business partner of category Optional

group

group

group

group
CityCode City code Optional
CitySearch City name Optional
Enter the city name in uppercase for search

help table
CompanyPostalCode Company postal code (for large customers) Optional
CorrespondenceLanguage Language for transaction or correspondence Optional
Country Country key Optional
1/30/2023
County County code Optional
DeliveryServiceNumber Delivery service identi er. Optional
The type of delivery service is de ned by

eld DeliveryServiceTypeCode
DeliveryServiceTypeCode Code number for the service delivery type Optional
FaxNumber Fax number, consisting of dialing code and Read Only

number, but without country dialing code
Floor Floor number Optional
FormOfAddress Title Optional
FullName Full name Read Only
HomeCityName City of residence which is different from the Optional

postal city
ItemDeliveryAddressID Number of delivery address Read Only
ManualDeliveryAddressID Manual address number in purchasing PATCH: Not Applicable

document item
Nation Nation Optional
Person Person Optional
PhoneNumber Telephone number Read Only
Plant Plant PATCH: Not Applicable
POBoxDeviatingCountry Different PO box country Optional
POBoxDeviatingRegion Different PO box region Optional
POBoxLobbyName Name of the lobby PO box Optional
PrfrdCommMediumType Preferred communication method Optional
PurchaseRequisition A requisition to purchasing for the external PATCH: Not Applicable

procurement of planned materials
PurchaseRequisitionItem Item number of purchase requisition PATCH: Not Applicable
1/30/2023
SearchTerm1 Search Term1 Optional
StreetName Street and house number Optional
StreetPre xName Additional address eld which is printed Optional

above the Street line
StreetSearch Street name in uppercase for Search Optional
Enter the street name in uppercase for

search help table
StreetSuffixName Street name Optional
TransportZone Transportation zone to or from which goods Optional

are delivered
Item Notes
Technical name: A_PurchaseReqnItemText
Use
This API node contains the item text information for purchase requisition.
 Note
This service node is a child item of Purchase Requisition Item node and cannot be created independently.
Parameters
Parameters Description Necessity
ArchObjectNumber Object key for the text POST: Optional
For example, PATCH: Not Applicable
400006573200010
in which,
4000065732 is the PR Number
00010 is the Item Number
DocumentText Document text ID POST: Mandatory
B01- Item Text
B02 - Item Note
B03 - Delivery Text
B04 - Material PO Text
1/30/2023
Parameters Description Necessity
FixedIndicator Fixed Indicator can be one of the following: Read Only
Space – Text is automatically adopted to the

target object
N – Text is referenced to the target object but

cannot be adopted
* - Text is referenced to the target object and

can be adopted
Language Language POST: Mandatory
NoteDescription A long text that includes additional information Optional

about items in the purchase requisition
PurchaseRequisition A purchase requisition number POST: Mandatory
PurchaseRequisitionItem Purchase requisition item number POST: Mandatory
TechnicalObjectType Text object type which is EBAN POST: Mandatory
Operations for Purchase Requisition

Purchase requisition offers the following operations:
Operation HTTP- Sample URL

Method
Create a purchase POST POST <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeade

requisition
Create
Read a purchase GET GET <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader(

requisition $expand=to_PurchaseReqnItem,to_PurchaseReqnItem/to_PurchaseReqnAcctAssgmt,to_PurchaseReq
Read
Update a purchase PATCH PATCH <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHead

requisition
Update
Delete a purchase PATCH PATCH <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(

requisition
Delete
Validate purchase GET GET <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/Validate?PurchaseRequisition=

requisition
Validate
Enable a purchase POST POST <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/DiscardFromPurchasing?Purc

requisition for
purchasing
EnableForPurchasing
1/30/2023

Method
Discard a purchase POST POST <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/EnableForPurchasing?Purchas

requisition from
purchasing
DiscardFromPurchasing
Create
Create a Purchase Requisition
Add an Item to a Purchase Requisition
Add a Limit Item to a Purchase Requisition
Create an Item Note
Add an Accounting Line to a PR Item
Add Accounting Lines - Single to Multiple Account Distribution

In this scenario, you wish to create a purchase requisition of document type "NBS", for a free text item.
Request
A_PurchaseRequisitionHeader - Purchase Requisition
 Note
You must include the associated entities of the purchase requisition item, such as account assignment, delivery address and
item note in your request; else the creation request shall fail.
Response
On success, this operation returns the purchase requisition number, along with the data contained in the purchase requisition.
The requisition is created in the logon language.
Here, in the response below, purchase requisition "4000087493" is created successfully. If there are any errors, the appropriate
error messages are returned.
 Note
Success, information and warning messages, if any, are returned in the response header. Currently this is limited to 12
messages.
Examples
1/30/2023
Request
POST <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader
{
"PurReqnDescription": "",
"to_PurchaseReqnItem": {
"results": [
{
"PurchaseRequisitionType": "NBS",
"PurchaseRequisitionItemText": "Test PR",
"AccountAssignmentCategory": "U",
"MaterialGroup": "A001",
"RequestedQuantity": "100",
"BaseUnit": "EA",
"PurchaseRequisitionPrice": "1.00",
"PurchasingGroup": "001",
"Plant": "0001",
"CompanyCode": "0001",
"TaxCode": "V0",
"to_PurchaseReqnAcctAssgmt": {
"results": []
},
"to_PurchaseReqnDeliveryAddress": {},
"to_PurchaseReqnItemText": {
"results": []
}
}
]
}
}
Response
{
"d": {
"__metadata": {
"id": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader('4000
"uri": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader('400
"type": "API_PURCHASEREQ_PROCESS_SRV.A_PurchaseRequisitionHeaderType"
},
"PurchaseRequisition": "4000087493",
"PurReqnDescription": "David20191202",
"SourceDetermination": false,
"PurReqnDoOnlyValidation": false,
"results": [
{
"__metadata": {
"id": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(P
"uri": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(
"type": "API_PURCHASEREQ_PROCESS_SRV.A_PurchaseRequisitionItemType"
},
"PurchaseRequisitionItem": "10",
"PurchasingDocument": "",
"PurchasingDocumentItem": "0",
"PurReqnReleaseStatus": "02",
"PurchasingDocumentSubtype": "",
"PurchasingDocumentItemCategory": "0",
"Material": "",
"PurchasingDocumentCategory": "B",
"BaseUnit": "EA",
"PurReqnPriceQuantity": "1",
1/30/2023
"MaterialGoodsReceiptDuration": "0",
"ReleaseCode": "0",
"PurchaseRequisitionReleaseDate": null,
"PurchasingOrganization": "",
"Plant": "0001",
"CompanyCode": "",
"SourceOfSupplyIsAssigned": false,
"SupplyingPlant": "",
"OrderedQuantity": "0",
"DeliveryDate": "/Date(1575244800000)/",
"CreationDate": "/Date(1575244800000)/",
"ProcessingStatus": "N",
"ExternalApprovalStatus": "",
"PurchasingInfoRecord": "",
"Supplier": "",
"IsDeleted": "",
"FixedSupplier": "",
"RequisitionerName": "",
"CreatedByUser": "David",
"PurReqCreationDate": "/Date(1575244800000)/",
"DeliveryAddressID": "",
"ManualDeliveryAddressID": "",
"PurReqnItemCurrency": "EUR",
"MaterialPlannedDeliveryDurn": "0",
"DelivDateCategory": "1",
"MultipleAcctAssgmtDistribution": "",
"StorageLocation": "",
"PurReqnSSPRequestor": "",
"PurReqnSSPAuthor": "",
"PurchaseContract": "",
"PurReqnSourceOfSupplyType": "",
"PurchaseContractItem": "0",
"ConsumptionPosting": "U",
"PurReqnOrigin": "R",
"PurReqnSSPCatalog": "",
"PurReqnSSPCatalogItem": "",
"PurReqnSSPCrossCatalogItem": 0,
"IsPurReqnBlocked": "",
"ItemDeliveryAddressID": "",
"Language": "EN",
"IsClosed": false,
"ReleaseIsNotCompleted": false,
"ServicePerformer": "",
"ProductType": "1",
"PurchaseRequisitionStatus": "",
"ReleaseStrategy": "",
"PerformancePeriodStartDate": null,
"PerformancePeriodEndDate": null,
"PurchaseOrderPriceType": "",
"SupplierMaterialNumber": "",
"Batch": "",
"MaterialRevisionLevel": "",
"MinRemainingShelfLife": "0",
"ItemNetAmount": "0.00",
"TaxCode": "V0",
"GoodsReceiptIsExpected": true,
"InvoiceIsExpected": true,
"GoodsReceiptIsNonValuated": false,
"RequirementTracking": "",
"MRPController": "",
"PurchaseRequisitionIsFixed": false,
"AddressID": "",
"LastChangeDateTime": null,
"Reservation": "0",
"PurReqnExternalReference": "",
"PurReqnItemExternalReference": "",
"PurReqnExternalSystemId": "",
"PurReqnExternalSystemType": "",
"PurReqnTypeExternalReference": "",
"PurReqnProcessingType": "",
"PurReqnProcessingDateTime": "",
"ProcmtHubBackendBusSyst": "",
"SSPAuthorExternalBPIdnNumber": "",
1/30/2023
"SSPReqrUserId": "",
"IsOutline": false,
"PurchasingParentItem": "0",
"PurgConfigurableItemNumber": "",
"PurgExternalSortNumber": "0",
"ProductSeasonYear": "",
"ProductSeason": "",
"ProductCollection": "",
"ProductTheme": "",
"ProductCharacteristic1": "",
"ProductCharacteristic1Desc": "",
"StockSegment": "",
"RequirementSegment": "",
"to_PurchaseReqn": {
"__deferred": {
"uri": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionIte
}
},
"results": []
},
"to_PurchaseReqnDeliveryAddress": {
"__metadata": {
"id": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(Purch
"uri": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(Purc
"type": "API_PURCHASEREQ_PROCESS_SRV.A_PurReqAddDeliveryType"
},
"AddressID": "",
"AddressType": "",
"Plant": "0001",
"CareOfName": "",
"AdditionalStreetSuffixName": "",
"CorrespondenceLanguage": "",
"PrfrdCommMediumType": "",
"POBox": "",
"POBoxIsWithoutNumber": false,
"POBoxPostalCode": "",
"POBoxLobbyName": "",
"POBoxDeviatingCityName": "",
"POBoxDeviatingRegion": "",
"POBoxDeviatingCountry": "",
"DeliveryServiceTypeCode": "",
"DeliveryServiceNumber": "",
"AddressTimeZone": "",
"FullName": "",
"CityName": "ABC",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "69191",
"CompanyPostalCode": "",
"StreetName": "Street",
"StreetPrefixName": "",
"AdditionalStreetPrefixName": "",
"StreetSuffixName": "",
"HouseNumber": "15",
"HouseNumberSupplementText": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "01",
"County": "",
"FormOfAddress": "",
"BusinessPartnerName1": "John",
"BusinessPartnerName2": "",
1/30/2023
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"TaxJurisdiction": "",
"TransportZone": "",
"Person": ""
},
"results": []
}
}
]
}
}
}

In this scenario, you wish to add an item to an existing purchase requisition. In the sample below, we are adding an item "Cable"
to the purchase requisition "4000087493".
Request
A_PurchaseRequisitionItem - Item
 Note
While creating an item, you must include the associated entities, else the item creation shall fail.
Response
On success, the purchase requisition item is added to the purchase requisition. The item "Cable" is added to the purchase
requisition "4000087493", with item number "20".
 Note
messages.
Examples
Request
POST <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem
{
"PurchaseRequisitionItemText": "Cable",
1/30/2023
"Plant": "0001",
"BaseUnit": "P",
"results": []
},
"to_PurchaseReqnDeliveryAddress": {},
"results": []
}
}
Response
{
"d": {
"__metadata": {
"id": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(Purchas
"uri": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(Purcha
},
"Material": "",
"BaseUnit": "P",
"ReleaseCode": "0",
"Plant": "0001",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"ProductTheme": "",
"StockSegment": "",
"__deferred": {
"uri": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(Purc
}
},
"results": []
},
"__metadata": {
"id": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(PurchaseReq
"uri": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(PurchaseRe
},
1/30/2023
"AddressID": "",
"AddressType": "",
"Plant": "0001",
"CareOfName": "",
"POBox": "",
"FullName": "",
"CityName": "ABC",
"District": "",
"CityCode": "",
"HomeCityName": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "01",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": ""
},
"results": []
}
}
}

In this scenario, you wish to add a limit item to an existing purchase requisition. In the sample below, we are adding a limit item
to the purchase requisition "4000087493", in order to procure minor office supplies for the period 7 July 2020 to 17 July 2020.
As the exact details such as price and quantity are not known at the time of ordering, we create a limit item, that is item with
PurchasingDocumentItemCategory 'A'. We can provide the amount we expect to spend on this item using the eld,
"ExpectedOverallLimitAmount", which is 100 EUR in this case. The overall limit or upper limit of the amount that can be spent on
this item is provided using the eld "OverallLimitAmount", which is also 100 EUR in this case. The expected amount must not
exceed the overall limit amount.
1/30/2023
Request
Item (A_PurchaseRequisitionItem) - Item
Response
On success, the operation creates a limit item with the details provided in the request. If there are any errors, the appropriate
 Note
messages.
Examples
Request
POST <host>/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader HTTP/1.1

{
"PurchaseRequisitionType": "NB",
"PurReqnDescription": "Minor Office Supplies",
"to_PurchaseReqnItem": [
{
"Plant": "1010",
"PurchasingDocumentItemCategory": "A",
"ProductType": "1",
"PurchaseRequisitionItemText": "Limit Item",
"ExpectedOverallLimitAmount": "100",
"OverallLimitAmount": "100",
"PerformancePeriodStartDate": "2020-07-07T00:00:00",
"PerformancePeriodEndDate": "2020-07-17T00:00:00",
"AccountAssignmentCategory": "U"
}
]
}
Response
You can see in the response below that a limit item has been created successfully. The parameters such as DeliveryDate,
PurchaseRequisitionPrice and RequestedQuantity are not applicable for limit items. So, the PerformancePeriodEndDate is
taken as the DeliveryDate. The ExpectedOverallLimitAmount is considered as the PurchaseRequisitionPrice. The
RequestedQuantity is always considered as "0".
status_code: 201 Created

{
"d": {
"__metadata": {
"id": "<host>/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader('4000087493')",
"uri": "<host>/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader('4000087493')",
},
1/30/2023
"PurReqnDescription": "Example Limit PR",
"results": [
{
"__metadata": {
"id": "<host>/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(Purchas
"uri": "<host>/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(Purcha
},
"PurchaseRequisitionItemText": "Limit Item",
"Material": "",
"MaterialGroup": "",
"RequestedQuantity": "0.000",
"BaseUnit": "",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
"OrderedQuantity": "0.000",
"Supplier": "",
"IsDeleted": "",
"CreatedByUser": "CC0000000105",
"DelivDateCategory": "",
"Language": "EN",
"IsClosed": false,
"ReleaseIsNotCompleted": true,
"ProductType": "1",
1/30/2023
"PerformancePeriodStartDate": "/Date(1594080000000)/",
"PerformancePeriodEndDate": "/Date(1594944000000)/",
"Batch": "",
"AddressID": "",
"Reservation": "0",
"ExpectedOverallLimitAmount": "100.00",
"OverallLimitAmount": "100.00",
"PurContractForOverallLimit": "",
"IsOutline": false,
"__deferred": {
"uri": "<host>/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(Pu
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
}
}
]
}
}
}
Following are some of the error messages related to limit items
item
Message No. 156
1/30/2023

requisition
Message No. 157
Message No. 169

Message No. 892
MMPUR_SPROC/Message No. 16 Multiple account assignments are not allowed for enhanced limit
items.
Create an Item Note

In this scenario, you wish to add an item note to an item in a purchase requisition. In the sample below, we are adding the item
note "Coaxial Cable" to item "10" of purchase requisition "4000087493".
Request
A_PurchaseReqnItemText - Item Notes
Response
On success, the item note is added to the purchase requisition item. The item note "Coaxial Cable" is added to item "10" of
purchase requisition "4000087493".
 Note
messages.
Examples
Request
POST <host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemText
{
"PurchaseRequisition":"4000087493",
"PurchaseRequisitionItem":"10",
"DocumentText": "B02",
"NoteDescription": "Coaxial Cable"
}
Response
{
"d": {
1/30/2023
"__metadata": {
"id": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemText(Purc
"uri": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemText(Pur
"type": "API_PURCHASEREQ_PROCESS_SRV.A_PurchaseReqnItemTextType"
},
"PurchaseRequisition": "",
"DocumentText": "",
"TechnicalObjectType": "",
"Language": "",
"ArchObjectNumber": "",
"NoteDescription": "",
"FixedIndicator": ""
}
}
Create a PR Item with Delivery Address

In this scenario, you wish to create a purchase requisition item with a delivery address. The sample below shows the different
types of delivery address that can be provided in a purchase requisition item, and their order of precedence.
Request
A_PurReqAddDelivery - Delivery Address
Response
On success, purchase requisition with delivery address is created.
 Note
messages.
Examples
If you want to enter the delivery address manually, enter the address details in the delivery address entity,
A_PurReqAddDelivery.
If you want to provide a reference delivery address, provide reference delivery address ID using the parameter
ItemDeliveryAddressID in A_PurchaseRequisitionItem. Do not provide a manual address.
If you want to have the storage location address as the delivery address, maintain the storage location using the
parameter StorageLocation in A_PurchaseRequisitionItem. Do not provide reference delivery address ID or
manual address.
If you want to have the plant address as the delivery address, maintain the plant using the parameter Plant in
A_PurchaseRequisitionItem. Do not provide the storage location, reference delivery address ID or manual
address.
Request
1/30/2023
POST <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader HTTP/1.1

{
"PurReqnDescription": "User Entry",
{
"PurchaseRequisitionItemText": "test item PR1 -1",
"PurchasingOrganization": "0001",
"Plant": "0001",
"StorageLocation": "0001",
"Material": "CM_HAWA",
"BaseUnit": "EA",
"ItemDeliveryAddressID": "0000406629",
"Country": "DE",
"BusinessPartnerName1": "Adam1",
"BusinessPartnerName2": "Gibbs1"
}
}
]
}
Response
{
"d": {
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeade
},
"results": [
{
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequi
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequ
},
"AccountAssignmentCategory": "",
"MaterialGroup": "001",
"BaseUnit": "EA",
"ReleaseCode": "0",
1/30/2023
"Plant": "0001",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
"CreatedByUser": "ABC",
"DeliveryAddressID": "1305825",
"ManualDeliveryAddressID": "1305825",
"ConsumptionPosting": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "1305825",
"Reservation": "0",
"IsOutline": false,
1/30/2023
"ProductTheme": "",
"StockSegment": "",
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_Purchase
}
},
"__deferred": {
}
},
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAdd
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAd
},
"AddressID": "",
"Plant": "0001",
"AddressType": "",
"CareOfName": "",
"POBox": "",
"FullName": "",
"CityName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "",
"County": "",
"BusinessPartnerName2": "Gibbs1",
1/30/2023
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
"AddresseeFullName": ""
},
"__deferred": {
}
}
}
]
}
}
}
On doing a read of the purchase requisition, you can see that although you have provided the plant, storage location, reference
address and manual address while creating the requisition, the manually entered address takes precedence. Hence the address
type is set as 'U' and the manual address entered by the user is taken as the delivery address of the purchase requisition.
Request
GET <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader(PurchaseRequis
Response
{
"d": {
"__metadata": {
},
"results": [
{
"__metadata": {
},
"MaterialGroup": "001",
"BaseUnit": "EA",
1/30/2023
"ReleaseCode": "",
"PurchaseRequisitionReleaseDate": "/Date(1632268800000)/",
"Plant": "0001",
"Supplier": "",
"IsDeleted": "",
"CreatedByUser": "ABC",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "1306009",
"LastChangeDateTime": "/Date(1632241072431+0000)/",
"Reservation": "0",
1/30/2023
"ProductTheme": "",
"StockSegment": "",
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"AddressID": "1306009",
"Plant": "0001",
"AddressType": "U",
"CareOfName": "",
"POBox": "",
"FullName": "Adam1 Gibbs1",
"CityName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "",
"County": "",
1/30/2023
"BusinessPartnerName2": "Gibbs1",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"results": [
{
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_P
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_
"type": "API_PURCHASEREQ_PROCESS_SRV.A_PurchaseReqnItemTextType
},
"TechnicalObjectType": "EBAN",
"Language": "EN",
"ArchObjectNumber": "001212896500010",
"NoteDescription": "Sample text",
"FixedIndicator": "N"
}
]
}
}
]
}
}
}

In this scenario, you wish to add an accounting line to an item in a purchase requisition. In the sample below, we are adding an
accounting line to item "10" of purchase requisition "4000087493". Please note that while you add a new accounting line to an
item, you must also correspondingly update the accounting details in the purchase requisition item, hence this operation is only
supported as a batch request.
Request
A_PurReqnAcctAssgmt - Account Assignment
Response
On success, the accounting line is added to item "10" of purchase requisition "4000087493".
 Note
messages.
1/30/2023
Examples
Request
--batch
content-type: multipart/mixed; boundary=changeset_1
--changeset_1
content-type: application/http
content-transfer-encoding: binary
PATCH A_PurchaseRequisitionItem(PurchaseRequisition='4000087493',PurchaseRequisitionItem='10') HTTP

accept: application/json
content-type: application/json
{
"AccountAssignmentCategory": "K",
"MultipleAcctAssgmtDistribution": ""
--changeset_1
POST A_PurReqnAcctAssgmt HTTP/1.1

{
"CostCenter": "SVC_AUNIT_",
"GLAccount": "0000400000"
}
--changeset_1--
--batch--
Response
--C3A8F6C0C42A1009C11AC305D368163E0
Content-Type: multipart/mixed; boundary=C3A8F6C0C42A1009C11AC305D368163E1
Content-Length: 2403
--C3A8F6C0C42A1009C11AC305D368163E1
Content-Type: application/http
Content-Length: 71
HTTP/1.1 204 No Content

Content-Length: 0
--C3A8F6C0C42A1009C11AC305D368163E1
HTTP/1.1 201 Created

location: https://<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqnAcctAssgmt(Purchase
{
"d": {
1/30/2023
"__metadata": {
"id": "https://<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqnAcctAssgmt(Purch
"uri": "https://<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqnAcctAssgmt(Purc
"type": "API_PURCHASEREQ_PROCESS_SRV.A_PurReqnAcctAssgmtType"
},
"PurchaseReqnAcctAssgmtNumber": "1",
"CostCenter": "SVC_AUNIT_",
"MasterFixedAsset": "",
"ProjectNetwork": "",
"BaseUnit": "",
"Quantity": "100.000",
"MultipleAcctAssgmtDistrPercent": "0.0",
"PurReqnItemCurrency": "",
"PurReqnNetAmount": "0.00",
"IsDeleted": "",
"CostElement": "",
"GLAccount": "400000",
"BusinessArea": "",
"SDDocument": "",
"SalesOrder": "",
"SalesDocumentItem": "0",
"SalesOrderItem": "0",
"ScheduleLine": "0",
"SalesOrderScheduleLine": "0",
"FixedAsset": "",
"ProcessOrder": "",
"OrderID": "",
"UnloadingPointName": "",
"ControllingArea": "0001",
"CostObject": "",
"ProfitabilitySegment": "0",
"ProfitCenter": "SAP-DUMMY",
"ProjectNetworkInternalID": "0",
"CommitmentItem": "",
"FundsCenter": "",
"Fund": "",
"FunctionalArea": "",
"CreationDate": null,
"GoodsRecipientName": "",
"RealEstateObject": "",
"NetworkActivityInternalID": "0",
"PartnerAccountNumber": "",
"JointVentureRecoveryCode": "",
"SettlementReferenceDate": null,
"OrderInternalID": "0",
"OrderIntBillOfOperationsItem": "0",
"EarmarkedFundsDocument": "",
"CostCtrActivityType": "",
"BusinessProcess": "",
"GrantID": "",
"ValidityDate": null,
"ChartOfAccounts": "",
"WBSElement": "",
"PurchaseRequisitionType": "",
"Plant": "",
"PurchasingGroup": ""
}
}--C3A8F6C0C42A1009C11AC305D368163E1--
--C3A8F6C0C42A1009C11AC305D368163E0--

In this scenario, you wish to add another accounting line to an item in a purchase requisition. In the sample below, we are adding
another accounting line to item "10" of purchase requisition "4000087493". Please note that while you add a new accounting
line to an item, you must also correspondingly update the accounting details in the purchase requisition item, hence this
operation is only supported as a batch request.
1/30/2023
Request
A_PurReqnAcctAssgmt - Account Assignment
Response
 Note
messages.
Examples
Request
--batch
--changeset_1
PATCH A_PurchaseRequisitionItem(PurchaseRequisition='4000087493',PurchaseRequisitionItem='10') HTTP

{
"MultipleAcctAssgmtDistribution": "1"
--changeset_1
PATCH A_PurReqnAcctAssgmt(PurchaseRequisition='4000087493',PurchaseRequisitionItem='10',PurchaseReq
{
"Quantity": "70"
}
--changeset_1
POST A_PurReqnAcctAssgmt HTTP/1.1

{
"CostCenter": "RWB_AUNIT_",
"GLAccount": "0000400000",
"Quantity": "30"
1/30/2023
}
--changeset_1--
--batch--
Response
--0470133E3A84A169BC9E3B1C89DC636C0
Content-Type: multipart/mixed; boundary=0470133E3A84A169BC9E3B1C89DC636C1
--0470133E3A84A169BC9E3B1C89DC636C1
Content-Length: 71

Content-Length: 0
--0470133E3A84A169BC9E3B1C89DC636C1
Content-Length: 71

Content-Length: 0
--0470133E3A84A169BC9E3B1C89DC636C1

location: https: //<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqnAcctAssgmt(Purchas
{
"d": {
"__metadata": {
"id": "https://<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqnAcctAssgmt
"uri": "https://<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqnAcctAssgm
"type": "API_PURCHASEREQ_PROCESS_SRV.A_PurReqnAcctAssgmtType"
},
"CostCenter": "RWB_AUNIT_",
"BaseUnit": "",
"Quantity": "30.000",
"MultipleAcctAssgmtDistrPercent": "30.0",
"PurReqnNetAmount": "0.00",
"IsDeleted": "",
"CostElement": "",
"BusinessArea": "",
"SDDocument": "",
"SalesOrder": "",
"SalesDocumentItem": "0",
"ScheduleLine": "0",
1/30/2023
"FixedAsset": "",
"ProcessOrder": "",
"OrderID": "",
"CostObject": "",
"FundsCenter": "",
"Fund": "",
"RealEstateObject": "",
"GrantID": "",
"ValidityDate": null,
"ChartOfAccounts": "",
"WBSElement": "",
"PurchaseRequisitionType": "",
"Plant": "",
"PurchasingGroup": ""
}
}
--0470133E3A84A169BC9E3B1C89DC636C1--
--0470133E3A84A169BC9E3B1C89DC636C0--
Create a Purchase Requisition with Hierarchy List

Item Hierarchy
You can use item hierarchies in purchase requisitions to structure and sort items, such as materials or services in a hierarchy. To
get an overview of what item hierarchies are, what functions they have, and where you can nd examples of how you work with
them, see Item Hierarchies.
 Note
In the standard system, the item hierarchy function is switched off by default. The con guration expert can activate the item
hierarchy function for purchase requisitions using the con guration step Activate Item Hierarchies in Purchasing present
under Sourcing and Procurement General Settings Item Hierarchy . Note that once the item hierarchy function is
switched on, it cannot be turned off.
For example, if you are purchasing materials and services for different departments of a company, you can use item hierarchies
to group the items by department.
You can create functional items (materials and services) and item sets by using the Create operation.
Create an Item Set
To create an item set using the Create operation:

1/30/2023
Set IsOutline to true.
Set PurchasingParentItem to '0' for creating at root level. If you are creating it as a child of another item set,
provide that item set's PurchaseRequisitionItem (item number) as the PurchasingParentItem.
As an item set is just used to de ne the hierarchical structure, it can contain only the
PurchaseRequisitionItemText which is a description of the item set.
An item set must always have atleast one functional item in it, else the Create operation will return an error.
In the request payload, always provide the parent item details rst, followed by the details of the children, else the
operation returns an error.
You cannot have more than ve levels of nesting in the hierarchy list.
The values provided by you in the request payload for the parameters PurgConfigurableItemNumber and
PurgExternalSortNumber are not considered. These values are internally calculated.
It is mandatory to provide the item number PurchaseRequisitionItem in the request payload.
Create a Functional Item
To create a functional item using the Create operation:
Set IsOutline to false.
Set PurchasingParentItem to '0' for creating at root level. If you are creating it as a child of another item set,
provide its PurchaseRequisitionItem (item number) as the PurchasingParentItem.
The functional item can be a material or a service.
The values provided by you in the request payload for the parameters PurgConfigurableItemNumber and
PurgExternalSortNumber are not considered. These values are internally calculated.
It is mandatory to provide the item number PurchaseRequisitionItem in the request payload.
If the create operation is successful, then the functional item or item set is added to the hierarchy list. In the response payload,
PurgConfigurableItemNumber contains the hierarchy number, and PurgExternalSortNumber contains the number
that indicates the position of the item within a particular level. For example, if PurgConfigurableItemNumber is 2.3, and
PurgExternalSortNumber is 3, then it indicates that the item is at position 2.3 of the hierarchy list, and is the third item in
the second level of the hierarchy as shown in the sample list below:
1 Printer
1.1 Cartridge (Material)
2 Stationery Items
2.1 Pen (Material)
2.2 Eraser (Material)
2.3 Pencil (Material)
3 Maintenance (Service)
 Note
You cannot convert a at list into a hierarchy list and vice-versa.
Following are some of the sample create scenarios for item hierarchy:
1/30/2023
Create an Item Set at Root Level
Add a Functional Item to an Item Set
Add Another Functional Item to the Same Item Set
Add an Item Set Within an Item Set
Create a Hierarchy List with Item Sets and Functional Items

In this scenario, you want to create a purchase requisition with a hierarchy list that contains an item set to group some
information technology items. Hence, we are creating Information Technology as an item set. This item set contains a
functional item cartridge in it.
Request
Response
On success, a purchase requisition with a hierarchy list is created. The hierarchy list contains a parent item set with a functional
item in it as shown below:
1 Information Technology (Item Set)
Examples
Request
{
"PurReqnDescription": "Item Set 1",
{
"PurchaseRequisitionItemText": "Information Technology (Item Set)",
"IsOutline": true,
"PurchasingParentItem": "0"
},
{
"IsOutline": false,
"PurchaseRequisitionItemText": "Cartridge (Material)",
1/30/2023
"PurchasingDocumentItemCategory": "",
"Plant": "1010",
"ProductType": "1",
"Material": "",
"MaterialGroup": "L002",
"BaseUnit": "EA",
}
]
}
Response

{
"d": {
"__metadata": {
},
"PurReqnDescription": "Item Set 1",
"results": [
{
"__metadata": {
},
"PurchaseRequisitionItemText": "Information Technology (Item Set)",
"Material": "",
"BaseUnit": "",
"ReleaseCode": "0",
"PurchasingGroup": "",
"Plant": "",
"CompanyCode": "",
"DeliveryDate": null,
1/30/2023
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
"GoodsReceiptIsExpected": false,
"InvoiceIsExpected": false,
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"PurgConfigurableItemNumber": "1",
"__deferred": {
}
},
"__deferred": {
1/30/2023
}
},
"__deferred": {
}
},
"__deferred": {
}
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"PurgConfigurableItemNumber": "1.1",
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
}
}
]
}
}
}
1/30/2023
Create a Functional Item at Root Level

In this scenario, you wish to add a functional item at the root level of the hierarchy list. Here, we are adding a functional material
item Pen (Material) at the root level of the hierarchy list of purchase requisition 10006454.
Request
Response
On success, a functional item (Pen) is added to the root level of the hierarchy list. Now, the hierarchy list looks as below:
2 Pen (Material)
Examples
Request
{
"IsOutline": false,
"PurchaseRequisitionItemText":"Pen (Material)",
"Plant": "1010",
"ProductType": "1",
"Material": "",
"BaseUnit": "EA",
}
}
Response

{
"d": {
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(P
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(
1/30/2023
},
"PurchaseRequisitionItemText": "Pen (Material)",
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
1/30/2023
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionI
}
},
"__deferred": {
}
},
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(Pur
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(Pu
},
"AddressID": "",
"Plant": "1010",
"AddressType": "",
"CareOfName": "",
"CorrespondenceLanguage": "DE",
"POBox": "",
"AddressTimeZone": "CET",
"FullName": "",
"CityName": "Walldorf",
"District": "",
"CityCode": "",
"HomeCityName": "",
"StreetName": "Dietmar-Hopp-Allee",
1/30/2023
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"BusinessPartnerName1": "Plant 1010 - Address Name 1",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"__deferred": {
}
}
}
}
Add a Functional Item to an Item Set

In this scenario, you wish to add a functional item to an item set in the hierarchy list. Here, we are adding a functional material
item Keyboard (Material) to the Information Technology item set of the purchase requisition 10006454.
Request
Response
On success, functional item (Keyboard) is added to the item set (Information Technology) of the hierarchy list. Now, the
hierarchy list looks as below:
1.2 Keyboard (Material)
2 Pen (Material)
Examples
1/30/2023
Request
{
"IsOutline": false,
"PurchaseRequisitionItemText":"Keyboard (Material)",
"Plant": "1010",
"ProductType": "1",
"Material": "",
"BaseUnit": "EA",
}
}
Response

{
"d": {
"__metadata": {
},
"PurchaseRequisitionItemText": "Keyboard (Material)",
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
"Supplier": "",
1/30/2023
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"__deferred": {
1/30/2023
}
},
"__metadata": {
},
"AddressID": "",
"Plant": "1010",
"AddressType": "",
"CareOfName": "",
"POBox": "",
"FullName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"__deferred": {
}
}
}
}
1/30/2023
Add Another Functional Item to the Same Item Set

In this scenario, you wish to add another functional item to the item set in the hierarchy list. Here, we are adding a functional
service item, Maintenance (Service) to the Information Technology item set of the purchase requisition 10006454.
Request
Response
On success, functional item (Maintenance) is added to the item set (Information Technology) of the hierarchy list. Now, the
hierarchy list looks as below:
1.3 Maintenance (Service)
2 Pen (Material)
Examples
Request
{
"IsOutline": false,
"PurchaseRequisitionItemText":"Maintenance (Service)",
"Plant": "1010",
"MaterialGroup": "YBMM01",
"ProductType": "2",
"BaseUnit": "EA",
}
}
Response
1/30/2023

{
"d": {
"__metadata": {
},
"PurchaseRequisitionItemText": "Maintenance (Service)",
"Material": "",
"MaterialGroup": "YBMM01",
"BaseUnit": "EA",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "2",
1/30/2023
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"__deferred": {
}
},
"__metadata": {
},
"AddressID": "",
"Plant": "1010",
"AddressType": "",
"CareOfName": "",
"POBox": "",
"FullName": "",
"District": "",
"CityCode": "",
1/30/2023
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"__deferred": {
}
}
}
}
Add an Item Set Within an Item Set

In this scenario, you wish to add an item set within the item set in the hierarchy list. Here, we are adding the item set, Mouse
(Item Set) to the item set (Information Technology) of the purchase requisition 10006454.
Request
 Note
Since an item set cannot be created without a functional item in it, we are creating the item set and a functional item in it.
Since the request body includes two POST requests, one for the item set (Mouse) and another for the functional item (Wired
Mouse), it is done using a batch call as shown below.
Response
On success, item set (Mouse) with the functional item (Wired Mouse) is added to the item set (Information Technology) of the
hierarchy list. Now, the hierarchy list looks as below:
1/30/2023
1.3 Monitor (Material)
1.4 Mouse (Item Set)
1.4.1 Wired Mouse (Material)
2 Pen (Material)
Examples
Request
POST <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/$batch
Content-Type: multipart/mixed; boundary=batch
--batch
--changeset_1
Content-ID: 1
POST A_PurchaseRequisitionItem HTTP/1.1

{
"PurchaseRequisitionItemText": "Mouse (Item Set)",
"IsOutline": true,
}
--changeset_1
Content-ID: 2
POST A_PurchaseRequisitionItem HTTP/1.1

"IsOutline": false,
"PurchaseRequisitionItemText":"Wired Mouse (Material)",
"Plant": "1010",
"ProductType": "1",
"Material": "",
"BaseUnit": "EA",
1/30/2023
}
}
--changeset_1--
--batch--
Response
--AF5FF7C15EBDF9341647278406D842D90
Content-Type: multipart/mixed; boundary=AF5FF7C15EBDF9341647278406D842D91
--AF5FF7C15EBDF9341647278406D842D91
content-id: 1

sap-message: {
"code": "ME/040",
"message": "Can delivery date be met?",
"longtext_url": "/sap/opu/odata/iwbep/message_text;o=LOCAL/T100_longtexts(MSGID='ME',MSGNO='040
"target": "",
"severity": "warning",
"transition": false,
"details": [
{
v
"code": "06/403",
"message": "Purchase requisition 10006454 changed",
"longtext_url": "/sap/opu/odata/iwbep/message_text;o=LOCAL/T100_longtexts(MSGID='06',MS
"target": "",
"severity": "success",
"transition": false
}
]
}
location: <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(PurchaseRe
"d": {
"__metadata": {
},
"PurchaseRequisitionItemText": "Mouse (Item Set)",
"Material": "",
"BaseUnit": "",
"ReleaseCode": "0",
"Plant": "",
"CompanyCode": "",
1/30/2023
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
1/30/2023
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
}
}
}
--AF5FF7C15EBDF9341647278406D842D91
content-id: 2

location: https: //cc3-715-api.wdf.sap.corp/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_Purchas
"d": {
"__metadata": {
"id": "https://cc3-715-api.wdf.sap.corp/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A
"uri": "https://cc3-715-api.wdf.sap.corp/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/
},
"PurchaseRequisitionItemText": "Wired Mouse (Material)",
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"PurgConfigurableItemNumber": "1.4.1",
"__deferred": {
}
},
"__deferred": {
}
1/30/2023
},
"__metadata": {
},
"AddressID": "",
"Plant": "1010",
"AddressType": "",
"CareOfName": "",
"POBox": "",
"FullName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"__deferred": {
}
}
}
}
--AF5FF7C15EBDF9341647278406D842D91--
--AF5FF7C15EBDF9341647278406D842D90--
1/30/2023
Create a Hierarchy List with Item Sets and Functional Items

In this scenario, you wish to create a purchase requisition with a hierarchy list containing 2 item sets Stationery Items and
Printer, and one functional service item Maintenance at the root level.
Request
Response
On success, a purchase requisition containing a hierarchy list is created. The hierarchy list contains 2 parent item sets
Stationery Items and Printer, and 1 functional service item at the root level as shown below:
1 Stationery Items (Item Set)
1.1 Pen (Material)
2 Printer
Examples
Request
{
"PurReqnDescription": "Item set",
{
"PurchaseRequisitionItemText": "Stationery Items (Item Set)",
"IsOutline": true,
},
{
"IsOutline": false,
"PurchaseRequisitionItemText":"Pencil (Material)",
1/30/2023
"Plant": "1010",
"ProductType": "1",
"Material": "",
"BaseUnit": "EA",
},
{
"IsOutline": false,
"PurchaseRequisitionItemText":"Eraser (Material)",
"Plant": "1010",
"ProductType": "1",
"Material": "",
"BaseUnit": "EA",
},
{
"IsOutline": true,
"PurchaseRequisitionItemText":"Printer (Material)",
"PurchaseRequisitionItem": "40"
},
{
"IsOutline": false,
"PurchaseRequisitionItemText":"Cartridge (Material)",
"Plant": "1010",
"ProductType": "1",
"Material": "",
"BaseUnit": "EA",
},
{
"IsOutline": false,
"PurchaseRequisitionItemText":"Maintenance (Service)",
"Plant": "1010",
"ProductType": "2",
"Material": "",
"BaseUnit": "EA",
1/30/2023
}
]
}
Response

{
"d": {
"__metadata": {
},
"results": [
{
"__metadata": {
},
"Material": "",
"BaseUnit": "",
"ReleaseCode": "0",
"Plant": "",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
1/30/2023
},
"__deferred": {
}
}
},
{
"__metadata": {
},
"PurchaseRequisitionItemText": "Printer (Material)",
"Material": "",
"BaseUnit": "",
"ReleaseCode": "0",
"Plant": "",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
1/30/2023
"ProductType": "",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
}
},
{
"__metadata": {
},
"PurchaseRequisitionItemText": "Maintenance (Service)",
1/30/2023
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "2",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
1/30/2023
"IsOutline": false,
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
}
},
{
"__metadata": {
},
"PurchaseRequisitionItemText": "Pencil (Material)",
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
1/30/2023
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
1/30/2023
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
}
},
{
"__metadata": {
},
"PurchaseRequisitionItemText": "Eraser (Material)",
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
}
},
{
"__metadata": {
},
1/30/2023
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "0",
"Plant": "1010",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
1/30/2023
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
}
}
]
}
}
}
Read
Read a Purchase Requisition
Read a Purchase Requisition Item
Read Delivery Address
Read Item Notes

In this scenario, you wish to read a purchase requisition. In the sample below, we are reading the purchase requisition
"4000087493", along with its items and associated entities.
1/30/2023
Request
Response
On Success, this operation returns the purchase requisition along with its associated entities. The purchase requistion
"4000087493" is returned, along with its header and item level details.
Examples
Request
Response
{
"d": {
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader('4000
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader('400
},
"PurReqnDescription": "DescriptionUpdated",
"results": [
{
"__metadata": {
},
"Material": "",
"BaseUnit": "P",
"ReleaseCode": "",
"Plant": "0001",
1/30/2023
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
1/30/2023
"ProductTheme": "",
"StockSegment": "",
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionIte
}
},
"results": []
},
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(Purch
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(Purc
},
"AddressID": "655846",
"AddressType": "P",
"Plant": "0001",
"CareOfName": "",
"POBox": "",
"FullName": "John",
"CityName": "ABC",
"District": "",
"CityCode": "",
"HomeCityName": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "01",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "STREET",
"CitySearch": "ABC",
1/30/2023
"Person": ""
},
"results": []
}
},
{
"__metadata": {
},
"PurchaseRequisitionItemText": "ItemTextUpdated",
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "0001",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
1/30/2023
"ProductType": "1",
"Batch": "",
"AddressID": "",
"IsOutline": false,
"ProductTheme": "",
"StockSegment": "",
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionIte
}
},
"results": []
},
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(Purch
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(Purc
},
"AddressType": "P",
"Plant": "0001",
"CareOfName": "",
"POBox": "",
1/30/2023
"FullName": "John",
"CityName": "ABC",
"District": "",
"CityCode": "",
"HomeCityName": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "01",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": ""
},
"results": [
{
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemTex
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemTe
},
"Language": "EN",
"NoteDescription": "Coaxial Cable",
}
]
}
}
]
}
}
}

In this scenario, you wish to read an item in a purchase requisition. In the sample below, we are reading item "10" of purchase
requisition "4000087493".
1/30/2023
Request
Response
On success, this operation returns the item in the purchase requisition. Here, it returns only item "10" of purchase requisition
"4000087493", along with its associated entities.
Examples
Request
GET <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(PurchaseRequisit
Response
{
"d": {
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(Purchas
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(Purcha
},
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "0001",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"ProductTheme": "",
"StockSegment": "",
"__deferred": {
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(Purc
}
1/30/2023
},
"results": []
},
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(PurchaseReq
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(PurchaseRe
},
"AddressType": "P",
"Plant": "0001",
"CareOfName": "",
"POBox": "",
"FullName": "John",
"CityName": "ABC",
"District": "",
"CityCode": "",
"HomeCityName": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "01",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": ""
},
"results": [
{
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemText(Purc
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemText(Pur
},
1/30/2023
"Language": "EN",
}
]
}
}
}

In this scenario, you wish to read the delivery address of an item in a purchase requisition. In the sample below, we are reading
the delivery address of item "10" of purchase requisition "4000087493".
Request
Response
On success, this operation returns the delivery address of the purchase requisition item. Here, it returns the delivery address
maintained in item "10" of purchase requisition "4000087493".
Examples
Request
GET <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(PurchaseRequisition='4
Response
{
"d": {
"__metadata": {
"id": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(PurchaseRequi
"uri": "<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(PurchaseRequ
},
"AddressType": "P",
"Plant": "0001",
"CareOfName": "",
"POBox": "",
1/30/2023
"FullName": "John",
"CityName": "ABC",
"District": "",
"CityCode": "",
"HomeCityName": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "01",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": ""
}
}
Read Item Notes

In this scenario, you wish to read the item note of all items in a purchase requisition. In the sample below, we are reading the
item note of all items in purchase requisition "4000087493"
Request
Response
On success, this operation returns the item note of all items in a purchase requisition. Here, it returns the item note of all the
items in the purchase requisition "4000087493".
Examples
1/30/2023
Request
GET <host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemText?$filter=PurchaseReq
Response
{
"d": {
"results": [
{
"__metadata": {
"id": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemT
"uri": "<host>/sap/opu/odata/SAP/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItem
},
"Language": "EN",
}
]
}
}
Read a Purchase Requisition with Hierarchy List

You can read a hierarchy list containing functional items (materials and services) and item sets by using the Read operation.
Following are some of the sample read scenarios for item hierarchy:
Read a Hierarchy List with Item Sets and Functional Items
Read an item in a Hierarchy List
Read a Hierarchy List with Item Sets and Functional Items

In this scenario, you wish to read a purchase requistion that has item sets and functional items in it.
Request
Response
On success, the hierarchy list with the item sets and functional items in it is returned as follows:
1/30/2023
1.1 Pen (Material)
2 Printer
Examples
Request
Response
status_code: 200 OK
{
"d": {
"__metadata": {
},
"results": [
{
"__metadata": {
},
"Material": "",
"BaseUnit": "",
"ReleaseCode": "",
"Plant": "",
"CompanyCode": "",
1/30/2023
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"__deferred": {
}
1/30/2023
},
"results": []
},
"__metadata": {
},
"AddressID": "",
"Plant": "",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"FullName": "",
"CityName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "",
"Region": "",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
1/30/2023
},
"Material": "",
"BaseUnit": "",
"ReleaseCode": "",
"Plant": "",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
1/30/2023
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"AddressID": "",
"Plant": "",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"FullName": "",
"CityName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
1/30/2023
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "",
"Region": "",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"PurchaseRequisitionStatus": "X",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
1/30/2023
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"FullName": "Plant 1010 - Address Name 1",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "DIETMAR-HOPP-ALLEE",
"CitySearch": "WALLDORF",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
1/30/2023
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
1/30/2023
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
1/30/2023
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
1/30/2023
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
"PurchaseRequisitionItemText": "Maintenance",
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
1/30/2023
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "2",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
1/30/2023
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
},
1/30/2023
"results": []
}
}
]
}
}
}
Read an item in a Hierarchy List

In this scenario, you wish to read an item in a purchase requistion.
Request
Response
On success, the requested item is returned.
Examples
Request
GET <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(PurchaseRequisit
Response
status_code: 200 OK
{
"d": {
"__metadata": {
},
"Material": "",
"BaseUnit": "",
1/30/2023
"ReleaseCode": "",
"Plant": "",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
1/30/2023
"IsOutline": true,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"AddressID": "",
"Plant": "",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"FullName": "",
"CityName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "",
"Region": "",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
1/30/2023
"Person": "",
},
"results": []
}
}
}
Update
Update a Purchase Requisition
Update a Purchase Requisition Item
Update Delivery Address
Update Item Notes

In this scenario, you wish to update a purchase requisition. In the sample below, we are updating the description of purchase
Request
Response
On success, the description of purchase requisition is updated. Here description of purchase requisition "4000087493" is
updated.
 Note
messages.
Examples
Request
PATCH <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionHeader('4000087493'
{
"PurReqnDescription": "DescriptionUpdated"
}
Response
status_code: 204 No Content
1/30/2023

In this scenario, you wish to update an item in a purchase requisition. In the sample below, we are updating the purchase
requisition item text of item "10" of purchase requisition "4000087493". If the elds that have been updated retrigger the
work ow based on the work ow con guration, the status gets changed to In Release and the item is then resubmitted for
further processing.
Rejected items and items that have follow-on documents can also be updated using this operation. The status gets changed to
In Release and is resubmitted for further processing.
Request
Response
On success, the purchase requisition item details are updated. Here, the purchase requisition item text of item "10" of purchase
requisition "4000087493" is updated.
 Note
messages.
Examples
Request
PATCH <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseRequisitionItem(PurchaseRequis
{
"PurchaseRequisitionItemText": "ItemTextUpdated"
}
Response

In this scenario, you wish to update the delivery address details of an item in a purchase requisition. In the sample below, we are
updating the delivery address details of item "10" of purchase requisition "4000087493".
Request
1/30/2023
Response
On success, the delivery address details of the purchase requisition item are updated. Here, the delivery address details of item
"10" of purchase requisition "4000087493" are updated.
 Note
messages.
Examples
Request
PATCH <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurReqAddDelivery(PurchaseRequisition=
{
"CareOfName": "CareOfNameUpdated"
}
Response
Update Item Notes

In this scenario, you wish to update the item note of an item in a purchase requisition. In the sample below, we are updating the
item note of item "10" of purchase requistion "4000087493".
Request
Response
On success, the item note of the purchase requisition item is updated. Here, the item note of item "10" of purchase requisition
"4000087493" is updated.
 Note
messages.
Examples
1/30/2023
Request
PATCH <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/A_PurchaseReqnItemText(PurchaseRequisiti
{
"NoteDescription": "NoteUpdated"
}
Response
Update a Purchase Requisition with Hierarchy List

You can update existing functional items (materials and services) and item sets by using the Update operation.
Update an Item Set
You can update only the item description (PurchaseRequisitionItemText) of the item set. The other parameters in the
item set cannot be updated. If you provide the parameters PurgConfigurableItemNumber and
PurgExternalSortNumber in the request payload, please provide the correct values (as returned by Create).
Update a Functional Item
The hierarchy parameters IsOutline and PurchasingParentItem cannot be updated. Update of other parameters is
similar to that of at list. If you provide the parameters PurgConfigurableItemNumber and PurgExternalSortNumber
in the request payload, please provide the correct values (as returned by Create).
Following are some of the sample update scenarios for item hierarchy:
Update an Item Set
Update an Item Set

In this scenario, you wish to update the item description of an item set in a purchase requistion.
Request
Response
On success, the item description of the item set is updated.
Examples
Request
1/30/2023
{
"PurchaseRequisitionItemText": "Stationery Items Updated (Item Set)"
}
Response
On doing a read of item 10 of the purchase requisition using the read request provided in Read an Item in a Hierarchy List, we
can see that the item description of the item set has been updated.
{
"d": {
"__metadata": {
},
"PurchaseRequisitionItemText": "Stationery Items Updated (Item Set)",
"Material": "",
"BaseUnit": "",
"ReleaseCode": "",
"Plant": "",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"AddressID": "",
"Plant": "",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
1/30/2023
"FullName": "",
"CityName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "",
"Region": "",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"results": []
}
}
}
Delete
Delete a Purchase Requisition Item

In this scenario, you wish to delete an item in a purchase requisition. In the sample below, we are deleting item "20" of purchase
 Note
DELETE operation is not supported. The purchase requisition item is marked for deletion.
Request
1/30/2023
Response
On success, this operation marks the purchase requisition item for deletion. Here, it marks item "20" of purchase requisition
"4000087493" for deletion.
 Note
messages.
Examples
Request
{
"IsDeleted": "X"
}
Response
Delete a Purchase Requisition with Hierarchy List

You can soft delete, that is, set the IsDeleted ag to 'X' for existing functional items (materials and services) and item sets by
using the Update operation.
Deleting an Item Set
You can soft delete an item set by setting its IsDeleted ag. When you soft delete an item set, all its children are also soft-
deleted.
Deleting a Functional Item
You can soft delete a functional item by setting its IsDeleted ag.
 Note
If the functional item is the only child of an item set, then the Delete operation returns an error. This is because an item set
must have at least one functional item in it.
Following are some of the sample delete scenarios for item hierarchy:
Delete an Item Set
Delete a Functional Item
1/30/2023
Delete an Item Set

In this scenario, you wish to delete an item set in a purchase requistion. Here, we are deleting the item set Printer in the
purchase requisition 10006740.
Request
Response
On success, the item set and all its children are soft deleted. That is, the IsDeleted ag is set to 'X'.
Examples
Request
{
"IsDeleted": "X"
}
Response
On doing a read of the purchase requisition using the read request provided in Read a Hierarchy List, we can see that the
IsDeleted ag is set to 'X' for the item set 'Printer' and its child 'Cartridge'.
{
"d": {
"__metadata": {
},
"results": [
{
"__metadata": {
},
1/30/2023
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
1/30/2023
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
1/30/2023
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
1/30/2023
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
1/30/2023
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "2",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
1/30/2023
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
1/30/2023
},
"results": []
}
},
{
"__metadata": {
},
"PurchaseRequisitionItemText": "Stationery Items Updated (Item Set)",
"Material": "",
"BaseUnit": "",
"ReleaseCode": "",
"Plant": "",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "",
1/30/2023
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"AddressID": "",
"Plant": "",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"FullName": "",
"CityName": "",
1/30/2023
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "",
"Region": "",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "",
"ReleaseCode": "",
"Plant": "",
"CompanyCode": "",
1/30/2023
"Supplier": "",
"IsDeleted": "X",
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"__deferred": {
}
},
1/30/2023
"results": []
},
"__metadata": {
},
"AddressID": "",
"Plant": "",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"FullName": "",
"CityName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "",
"Region": "",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
1/30/2023
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "1010",
"Supplier": "",
"IsDeleted": "X",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
1/30/2023
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
1/30/2023
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
},
"results": []
}
}
]
}
}
}
Delete a Functional Item

In this scenario, you wish to delete a functional item in a purchase requistion. Here, we are deleting the item Maintenance in the
purchase requisition 10006740.
Request
Response
On success, the functional item is soft deleted. That is, the IsDeleted ag is set to 'X'.
Examples
Request
{
"IsDeleted": "X"
}
Response
1/30/2023
On doing a read of the purchase requisition using the read request provided in Read a Hierarchy List, we can see that the
IsDeleted ag is set to 'X' for the item 'Maintenance'.
{
"d": {
"__metadata": {
},
"results": [
{
"__metadata": {
},
"Material": "",
"BaseUnit": "",
"ReleaseCode": "",
"Plant": "",
"CompanyCode": "",
"Supplier": "",
"IsDeleted": "",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"AddressID": "",
"Plant": "",
"AddressType": "P",
"CareOfName": "",
1/30/2023
"POBox": "",
"FullName": "",
"CityName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "",
"Region": "",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
1/30/2023
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
1/30/2023
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"BusinessPartnerName1": "Plant",
"BusinessPartnerName2": "1010 - Address Name 1",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
1/30/2023
},
"results": []
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
1/30/2023
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
1/30/2023
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "",
"ReleaseCode": "",
"Plant": "",
"CompanyCode": "",
1/30/2023
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": true,
"__deferred": {
}
},
1/30/2023
"results": []
},
"__metadata": {
},
"AddressID": "",
"Plant": "",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"FullName": "",
"CityName": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"PostalCode": "",
"StreetName": "",
"HouseNumber": "",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "",
"Region": "",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"StreetSearch": "",
"CitySearch": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
1/30/2023
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "1010",
"Supplier": "",
"IsDeleted": "",
"Language": "EN",
"IsClosed": false,
"ProductType": "1",
"Batch": "",
1/30/2023
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
1/30/2023
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
},
"results": []
}
},
{
"__metadata": {
},
"Material": "",
"BaseUnit": "EA",
"ReleaseCode": "",
"Plant": "1010",
"Supplier": "",
"IsDeleted": "X",
1/30/2023
"Language": "EN",
"IsClosed": false,
"ProductType": "2",
"Batch": "",
"TaxCode": "",
"AddressID": "",
"Reservation": "0",
"IsOutline": false,
"__deferred": {
}
},
"results": []
},
"__metadata": {
},
"Plant": "1010",
1/30/2023
"AddressType": "P",
"CareOfName": "",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "8",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "BW",
"County": "",
"Nation": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"Person": "",
},
"results": []
}
}
]
}
}
}
Validate
This operation performs a number of validation checks on the data in a purchase requisition.
Request
1/30/2023
PurchaseRequisition GET: Mandatory A string that uniquely identi es a request to

procure a material or service
Response
This operation returns the response codes with corresponding error messages. On success, it returns the success response
code, indicating that the parameters in the purchase requisition are valid.
Property Necessity Comments
Type Optional Message type - information, warning, or error
ID Optional Message ID
Number Optional Message Number
Message Optional Message description
LogNumber Optional Application Log Number
LogMsgNo Optional Internal message serial number
MessageV1 Optional Message variable
Parameter Optional Parameter name
Row Optional Lines in parameter
Field Optional Field in parameter
System Optional Logical system from which message

originates.
 Note
messages.
Response Codes
Following are the response codes for batch and non-batch mode:
Response Codes
Non-Batch Success 200 The system displays a self-

explanatory detailed message.
Failure 400/500
Batch Not Applicable Not Applicable
Batch (Change Set Level) Not Applicable Not Applicable
1/30/2023
Example
Request
GET <host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/Validate?PurchaseRequisition='4000070421'
Response
status_code: 200 OK
Constraints
Validate Batch mode is not supported
EnableForPurchasing
External solutions integrated with SAP S/4HANA Cloud can invoke this operation on purchase requisition items, and enable
them for purchasing in SAP S/4HANA Cloud system.
External solutions can create purchase requisition items in SAP S/4HANA Cloud with external processing status as In Process
Externally, that is, the value of the eld ExternalApprovalStatus must be set to ʻP’. The solutions can then invoke the
operation EnableForPurchasing, on these purchase requisition items. The operation transitions the external processing
status of the purchase requisition items, and enables them for purchasing in SAP S/4HANA Cloud system.
 Note
This operation can only be applied on purchase requisition items that are created from external solutions integrated
with SAP S/4HANA Cloud, with external processing status as In Process Externally.
You cannot update or delete purchase requisition items in SAP S/4HANA Cloud system, while their external
processing status is In Process Externally.
If header-level approval is con gured, you cannot add an item that is In Process Externally to a purchase requisition
that has all its items enabled for purchasing.
Request
PurchaseRequisition POST: Mandatory A string that uniquely identi es a request to

PATCH: Mandatory
1/30/2023
PurchaseRequisitionItem POST: Mandatory A string that indicates the item within the
purchase requisition.
 Note
If you specify as ʻ00000’, then the action
is applied on all the items in the
purchase requisition. The status
transition happens only for items with
status In Process Externally. The status
of the other items remains unchanged.
Response
code, indicating that the status of the purchase requisition has been changed to enable it for purchasing.

originates.
 Note
messages.
Response Codes
Response Codes
1/30/2023

Failure 400/500
Error Messages
Following are the messages displayed when there is an error:
MEREQ/ You can't perform this action as this PR status change is not
allowed
Message No. 002
MEREQ/ Item in PR does not exist
Message No. 003
MEREQ/ Can't add item that is In Process Externally to purchase requisition

&1
Message No. 008
Example
Request
POST
<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/EnableForPurchasing?PurchaseRequisition='40000
Response
status_code: 400 Bad Request

{
"error": {
"code": "MEREQ/002",
"message": {
"lang": "en",
"value": "You can't perform this action as this PR status change is not allowed"
},
"innererror": {
"application": {
"component_id": "MM-PUR-REQ",
"service_namespace": "/SAP/",
"service_id": "API_PURCHASEREQ_PROCESS_SRV",
"service_version": "0001"
},
"transactionid": "ADDAB28236D104B0E005D6D496EB6FB6",
"timestamp": "20190905053423.4926400",
"Error_Resolution": {
"SAP_Transaction": "For backend administrators: use ADT feed reader \"SAP Gateway E
"SAP_Note": "See SAP Note 1797736 for error analysis (https://service.sap.com/sap/s
},
"errordetails": [
{
"code": "MEREQ/002",
"message": "You can't perform this action as this PR status change is not allow
"longtext_url": "/sap/opu/odata/iwbep/message_text;o=LOCAL/T100_longtexts(MSGID
"propertyref": "",
"severity": "error",
"transition": false,
"target": ""
1/30/2023
}
]
}
}
}
Constraints
EnableForPurchasing Batch mode is not supported
DiscardFromPurchasing
External solutions integrated with SAP S/4HANA Cloud can invoke this operation on purchase requisition items, and discard
them from purchasing in SAP S/4HANA Cloud system.
Externally, that is, the value of the eld ExternalApprovalStatus must be set to ʻP’. The solutions can then invoke the
operation DiscardFromPurchasing, on these purchase requisition items. The operation transitions the external processing
status of the purchase requisition items, and discards them from purchasing in SAP S/4HANA Cloud system.
 Note
Request

PATCH: Mandatory
 Note
1/30/2023
Response
code, indicating that the status of the purchase requisition has been changed to discard it from purchasing.

originates.
 Note
messages.
Response Codes
Response Codes

Failure 400/500
Error Messages
Following are the messages displayed when there is an error:
1/30/2023
MEREQ/ You can't perform this action as this PR status change is not
allowed
Message No. 002
MEREQ/ Item in PR does not exist
Message No. 003
Example
Request
<host>/sap/opu/odata/sap/API_PURCHASEREQ_PROCESS_SRV/DiscardFromPurchasing?PurchaseRequisition='400
Response
status_code: 200 OK
Constraints
DiscardFromPurchasing Batch mode is not supported
Purchase Requisition - OData V4

This service helps you to read, create, update, and delete purchase requisitions through this OData Version 4 service from a
source system outside SAP S/4HANA Cloud.
Service name: API_PURCHASEREQUISITION_2
This service enables you to read, create, update, and delete purchase requisitions through this OData version 4 from a source
system outside SAP S/4HANA Cloud.
This is an OData version 4 service. This version aims to improve processing time and resource consumption of clients and
servers and to re ect the complexity of the underlying business model. This includes a lightweight JSON format that reduces
the size of every response. Business data can be retrieved in the exact amount, at the right time, and in appropriate mode by
using new synchronization mechanisms. Calculations are made and data is aggregated by using the tiers best suited for this
task. Sophisticated metadata artifacts enable a true-to-life modeling of business models.
Technical Details
A service group contains services belonging to the same business object model and so it shares similar environment conditions.
This means the con guration and administration of a service group apply to all services in a service group, that is, routing,
authorization, and so on, so you only have to do them once.
1/30/2023
In the OData version 4 (V4) runtime implementation of the SAP Gateway Foundation, framework services originate from
repositories.
Service Group (incl. Namespace if Repository ID Service Name (incl. Namespace if Version
Existent) Existent)
API_PURCHASEREQUISITION_2 srvd_a2x API_PURCHASEREQUISITION_2 0001
Service Structure
Service Header (optional)
The service header contains information about the service.
Entities
Entity Description Necessity Link to Details
Purchase Requistion ( Header information for Mandatory Purchase Requisition

A_PurchaseRequisition_2 ) purchase requisition
Item ( Item information for purchase Mandatory Item

A_PurchaseRequisitionItem_2 requisition
)
Account Assignment ( Account assignment Mandatory Account Assignment

A_PurchaseReqnAcctAssgmt_2 ) information for purchase
requisition
1/30/2023
Entity Description Necessity Link to Details
Delivery Address ( Delivery address information Mandatory Delivery Address

A_PurchaseReqnDelivAddress_2 for purchase requisition
)
Item Notes ( Item text information for Mandatory Item Notes

A_PurchaseReqnItemText_2 ) purchase requisition
Batch and Non-Batch Operations
Single mode is only supported for the following OData operations:
A_PurchaseRequisitionHeader_2 YES YES NO
A_PurchaseRequisitionItem_2 YES YES NO
A_PurchaseReqnAcctAssgmt_2 NO YES NO
A_PurchaseReqnDelivAddress_2 NO YES NO
A_PurchaseReqnItemText_2 YES YES YES
Batch mode is only supported for the following OData operations:
Batch Operations
A_PurchaseRequisitionHeader_2 YES YES NO
A_PurchaseRequisitionItem_2 YES YES NO
A_PurchaseReqnAcctAssgmt_2 YES YES NO
A_PurchaseReqnDelivAddress_2 NO YES NO
A_PurchaseReqnItemText_2 YES YES YES
Service Response
Response Codes for Batch and Non-Batch Operations
Response Codes
Batch Success 202 The system displays a self-

Failure 400/500
Batch (Change Set Level) Success 201/204
Failure 400
Non-Batch Success 201/204
Failure 400/500
1/30/2023
Error Messages
MMPUR_REQ_COMMON/ You cannot edit referenced text.
Message No. 098
MMPUR_REQ_COMMON/ You cannot update the deleted purchase requisition items.
Message No.125
MM_PUR_REQN/ Purchase requisition &1 updated. Status changed to enable

resubmission.
Message No. 025
MM_PUR_REQN/ PR item &1 updated. Status changed to enable resubmission.
Message No. 026
MMPUR_REQ_COMMON/ You can only update one purchase requisition per change set.
Message No. 033
MMPUR_REQ_COMMON/ You can create items belonging to only one origin in one PR
Message No. 135
MMPUR_REQ_COMMON/ You must use multiple changesets to create multiple PRs
Message No. 136
MMPUR_REQ_COMMON/ You can combine operations pertaining to only one PR in one

changeset
Message No. 137
MMPUR_REQ_COMMON/ Please provide purchasing document type
Message No. 143
MMPUR_REQ_COMMON/ Please use same purchasing doc. type for header and items within
a PR
Message No. 145
item
Message No. 156

requisition
Message No. 157
Message No. 169

Message No. 892
MMPUR_SPROC/Message No. 16 Multiple account assignments are not allowed for enhanced limit
items.
Constraints
1/30/2023
Create Only authorized roles can be used to create purchase requisition through an API call. The following
authorization objects for purchase requisitions are relevant:
M_BANF_BSA
M_BANF_EKG
M_BANF_EKO
M_BANF_WRK
Update
Only GET, PATCH and POST are allowed with the OData call URL. You cannot use the methods,
DELETE, MERGE, and HEAD in OData call URL. Usage of any of these methods would result
in an error.
PATCH and POST methods are allowed with the batch call request. You cannot use the
methods DELETE, MERGE, HEAD in the change set of Batch Call request. Usage of any of
these methods would result in an error.
Multiple purchase requisitions can be updated using multiple change sets. You cannot update
more than one purchase requisition within one change set. ONLY ONE purchase requisition
can be updated in a single change set.
Only authorized roles can be used to update purchase requisition through an API call.
Authentication
The link to the API on the SAP API Business Hub: Purchase Requisition .
 Note
Purchase Requisition
Technical name:A_PurchaseRequisitionHeader_2
Properties
PurchaseRequisition A requisition to purchase the external POST: Optional

procurement of materials
PurchaseRequisitionType The type of purchase requisition POST: Optional
PurReqnDescription Description of the purchase requisition Optional

header
1/30/2023
SourceDetermination Automatic Source of Supply assignment POST: Optional
PATCH, GET: Not Applicable

 Note
The value of this parameter is not
persisted
PurReqnDoOnlyValidation A ag for simulation of purchase requisition Optional

creation.
If the ag is set to True, the purchase

requisition is validated but not created.
 Note
Validate
Item
Technical name:A_PurchaseRequisitionItem_2
Properties
BaseUnit Unit of Measure POST: Mandatory
BaseUnitISOCode ISO Code for Unit of Measure Mandatory
Batch A batch is a homogenous subset of a material that is Optional

managed separately from other subsets of the same
material
CompanyCode Company code Optional. The value passed is relevant only

for Central Procurement scenarios, and is
determined based on the plant. In all other
scenarios, this value is ignored.
ConsumptionPosting Consumption posting Optional
1/30/2023
CreatedByUser User ID of creator Read Only
ExpectedOverallLimitAmount Amount expected to be spent on the limit item Mandatory for Limit Items, that is for items
with PurchasingDocumentItemCategory = 'A'
ExternalApprovalStatus External Processing Status Optional
External solutions integrated with SAP S/4HANA

Cloud can create purchase requisition items in SAP
S/4HANA Cloud System with external processing
status as In Process Externally, that is, the value of
the eld ExternalApprovalStatus must be set to ʻP’.
The solutions can then invoke the operations
EnableForPurchasing and
DiscardFromPurchasing on these purchase
requisition items, and enable them for purchasing or
discard them from purchasing in SAP S/4HANA
Cloud System.
GoodsReceiptIsExpected Indicates that a goods receipt is allowed and Optional

expected.
GoodsReceiptsIsNonValuated Goods receipt non-valuated Optional
IsClosed Document is closed Optional
IsDeleted Indicates if the object is deleted Optional
PurReqnItemBlockingStatus Indicates if purchase requisition is blocked Optional
PurReqnItemBlockingReasonText Indicates the reason due to which the purchase Optional

requisition is blocked
ItemDeliveryAddressID Delivery address identi er Optional
ItemNetAmount Item net amount in transaction currency Read Only
LastChangeDateTime Time stamp for last changed Read Only
MaterialGoodsReceiptDuration Goods receipt processing duration in working days Optional
MaterialPlannedDeliveryDurn Planned delivery time in days Optional
MaterialRevisionLevel Revision Level Optional
MinRemainingShelfLife Minimum remaining shelf life Optional
MRPController MRP controller or team of MRP controllers Optional

responsible for material
1/30/2023

assignment. It can be one of the following:
Single Accounting - ""
Distribution on Quantity Basis - "1"
Distribution by Percentage - "2"
 Note
Based on the distribution indicator chosen, you
must pass appropriate values for the parameter
"MultipleAcctAssgmtDistrPercent" in
A_PurReqnAcctAssgmt.
OrderedQuantity Ordered quantity Optional
 Note
corresponding to the <OrderedQuantity> value, in
each and every operation.
OverallLimitAmount Maximum amount that can be spent on the limit Mandatory for Limit Items, that is for items
item. It is the upper limit that the expected value of with PurchasingDocumentItemCategory = 'A'
the limit item (ExpectedOverallLimitAmount) must
not exceed.
PATCH: Optional
ProcessingStatus Processing status Read Only

N - Not edited
B - PO created
A - RFQ created
K - Contract created
L - Scheduling agreement created
S - Service entry sheet created
F - External Contract Created
G - External RFQ Created
ProductTypeCode Identi es the product type group, which is used to Optional

differentiate between materials and lean services.
For example,
1 - Material
2 - Service
1/30/2023
PurchaseContract A legally binding purchase agreement that contains Optional

special conditions that are negotiated between a
buyer and a seller, covering goods to be supplied or
services to be performed.
PurchaseRequisition A requisition to purchase the external procurement of POST: Mandatory

materials.
PurchaseRequisitionIsFixed Indicates that a purchase requisition is xed and Optional

therefore cannot be changed by material
requirements planning.
PurchaseRequisitionItem Item Number of purchase requisition POST: Optional
PurchaseRequisitionItemText Purchase requisition item text Optional
PurchaseRequisitionPrice Price in purchase requisition POST: Optional
 Note PATCH: Not Applicable

<PurReqnItemCurrency> corresponding to the
<PurchaseRequisitionPrice> value, in each and
every operation.
PurchaseRequisitionType Purchase requisition type POST: Optional
PurchasingDocument Purchasing document number Optional
PurchasingDocumentItem Purchasing document item number Optional
PurchasingDocumentItemCategory Item category in purchasing document Optional
'0' - Standard Item
'A' - Limit Item
PurchasingDocumentSubtype Control indicator for purchasing document type Read Only
PurchasingGroup Purchasing group POST: Mandatory
PATCH: Optional
PurchasingInfoRecord Purchasing information record Optional
PurContractForOverallLimit Reference Contract for limit items of type Service Optional
PurReqCreationDate Purchase request or purchase requisition creation Read Only

date
PurReqnItemCurrency Purchase requisition item currency key Optional
PurReqnExternalReference External Document Optional
PurReqnItemExternalReference External Item Optional
PurReqnExternalSystemId External System ID Optional
1/30/2023
PurReqnOrigin Creation indicator (Purchase Requisition/Schedule POST: Optional

Lines)
'R' - Realtime (manual)
'S' - Self-Service Procurement
PurReqnPriceQuantity Price unit Optional
 Note
corresponding to the <PurReqnPriceQuantity>
PurReqnReleaseStatus Purchase requisition release status Read Only

01 - Version in Process
02 - Active
03 - In Release
04 - For Overall Release
05 - Release Completed
08 - Release Refused
PurReqnSourceOfSupplyType Purchase requisition source of supply type Read Only
PurReqnSSPAuthor Author of requisition Optional
PurReqnSSPCatalog Purchase requisition SSPCatalog user ID Optional
PurReqnSSPCatalogItem Purchase requisition SSPCatalog item ID Optional
PurReqnSSPCrossCatalogItem Purchase requisition SSPCatalog item key Optional
PurReqnSSPRequestor Requestor of purchase requisition Optional
ReleaseIsNotCompleted Release not complete Optional
 Note
corresponding to the <RequestedQuantity>
RequirementTracking Requirement tracking number Optional
Reservation Document number of the Reservation follow-on Read Only

document, if any, that is created for the purchase
requisition item.
ServicePerformer A person who carries out a service Optional
SourceOfSupplyIsAssigned Indicator if source of supply is assigned Read Only
1/30/2023
StorageLocation A location where stock of materials is stored within a Optional

plant
Supplier Supplier Optional
SSPReqrUserId Requestor of SSP purchase requisition Optional
SSPAuthorExternalBPIdnNumber Business Partner Identi er for purchase requisition Optional
ProcurementHubSourceSystem Hub source system in central procurement Optional
PurchaseOrderPriceType The price in the purchase order item is adopted from Optional
the purchase requisition item, based on this
parameter. The possible values are:
' ' - Do not adopt
'1' - As gross price
'2' - As net price
 Note
EnablePurReqForPurchasing
DiscardPurReqFromPurchasing
Account Assignment
Technical name:A_PurchaseReqnAcctAssgmt_2
Properties
1/30/2023
BaseUnit Unit of Measure Read Only
BaseUnitISOCode ISO Code for Unit of Measure Mandatory
BusinessProcess Identi es a process in a company that uses Optional

resources and can involve the activities of
different departments
ChartOfAccounts Chart of Account Optional
CreationDate Date of creation Optional
EarmarkedFundsDocument Business transaction in funds management Optional

which claims already allocated budget for
expected revenues or expenditures
FixedAsset A unique ID for xed asset in asset Optional

accounting
Fund Fund Optional


GrantID Grant identi er Optional
IsDeleted Account assignment if it is marked for Optional

deletion
MasterFixedAsset Main or master asset number Optional
1/30/2023

account assignment
 Note
The value that you provide for this
parameter must correspond to the value
of the parameter
"MultipleAcctAssgmtDistribution" in
A_PurchaseRequisitionItem.
Single Accounting - "",
must be 0
Distribution on Quantity Basis - "1",
must be 0
Distribution by Percentage - "2",
pass the percentage split for the
accounting lines. For example,
NetworkActivity Network activity Optional
NetworkActivityInternalID Network activity identi er Optional
OrderIntBillOfOperationsItem An identi er of an item of the internal bill of Optional

operations assigned to an order, for
example, a production order or a network.
OrderInternalID The internal identi er of an order. Optional

project.
ProjectNetworkInternalID Routing identi er for operations in the order Optional
PurchaseReqnAcctAssgmtNumber Serial Number for Purchase Requisition PATCH: Not Applicable

Account Assignment Segment
PurchaseRequisition Purchase requisition PATCH: Not Applicable
PurchaseRequisitionItem Purchase requisition item PATCH: Not Applicable
1/30/2023
PurchaseRequisitionType Type of purchase requisition Optional
PurReqnItemCurrency Currency of purchase requisition item Mandatory
PurReqnNetAmount Net amount of purchase requisition Optional
 Note
<BaseUnit> corresponding to the
<Quantity> value, in each and every
operation.
REInternalFinNumber Internal key for real estate object Optional

unloaded

element)
 Note
Delivery Address
Technical name:A_PurchaseReqnDelivAddress_2
Properties
1/30/2023
AdditionalStreetPre xName Additional address eld which is printed Optional

above the street line
AdditionalStreetSuffixName Additional address eld which is printed Optional

under the street line
AddressID Address identi er PATCH: Not Applicable
AddressTimeZone Time zone of the address Optional
PurchasingDeliveryAddressType Delivery address type Read Only
'L' - Storage Location
'P' - Plant
'U' - User Entry
 Note
Following address types are NOT
supported:
'R' - Reference
'C' - Customer
'S' - Supplier
Building Building name Optional

group

group

group

group
CityCode City code Optional
CompanyPostalCode Company postal code (for large customers) Optional
CorrespondenceLanguage Language for transaction or correspondence Optional
Country Country key Optional
County County code Optional
DeliveryServiceNumber Delivery service identi er. Optional
The type of delivery service is de ned by

eld DeliveryServiceTypeCode
DeliveryServiceTypeCode Code number for the service delivery type Optional
1/30/2023
Floor Floor number Optional
FormOfAddress Title Optional
FullName Full name Read Only
HomeCityName City of residence which is different from the Optional

postal city
ItemDeliveryAddressID Number of delivery address Read Only
ManualDeliveryAddressID Manual address number in purchasing PATCH: Not Applicable

document item
Plant Plant PATCH: Not Applicable
POBoxDeviatingCountry Different PO box country Optional
POBoxDeviatingRegion Different PO box region Optional
POBoxLobbyName Name of the lobby PO box Optional
PrfrdCommMediumType Preferred communication method Optional
PurchaseRequisition A requisition to purchasing for the external PATCH: Not Applicable

procurement of planned materials
PurchaseRequisitionItem Item number of purchase requisition PATCH: Not Applicable
SearchTerm1 Search Term1 Optional
StreetName Street and house number Optional
StreetPre xName Additional address eld which is printed Optional

above the Street line
StreetSuffixName Street name Optional
TransportZone Transportation zone to or from which goods Optional

are delivered
 Note
1/30/2023
Item Notes
Technical name:A_PurchaseReqnItemText_2
Properties
TextObjectKey Object key for the text POST: Optional
400006573200010
in which,
4000065732 is the PR Number
00010 is the Item Number
TextObjectType Document text ID POST: Mandatory
B01- Item Text
B02 - Item Note
B03 - Delivery Text
B04 - Material PO Text
FixedIndicator Fixed Indicator can be one of the following: Read Only
Space – Text is automatically adopted to the

target object
N – Text is referenced to the target object but

cannot be adopted
* - Text is referenced to the target object and

can be adopted
Language Language POST: Mandatory
PlainLongText A long text that includes additional information Optional

about items in the purchase requisition
1/30/2023
PurchaseRequisition A purchase requisition number POST: Mandatory
PurchaseRequisitionItem Purchase requisition item number POST: Mandatory
TextObjectCategory Text object type which is EBAN POST: Mandatory
 Note
Create an Item Note
Read Item Notes
Update Item Notes
Delete an Item Note
Operations for Purchase Requisition

Purchase requisition offers the following operations:
The Purchase Requisition API offers these operations:

Method
Create a purchase requisition POST POST <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequis

Read a purchase requisition GET GET <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequisit

Read a Purchase Requisition $expand=_PurchaseRequisitionItem($expand=_PurchaseReqnItemText,_PurchaseReqnAcctAss
Update a purchase requisition PATCH PATCH <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequi

Delete a purchase requisition PATCH PATCH <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequi

Delete a Purchase Requisition
Item
Validate purchase requisition GET POST <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequis

Validate
Enable a purchase requisition POST POST

for purchasing <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequisition/0
1/30/2023

Method
Discard a purchase requisition POST POST

from purchasing <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequisition/0
Change Sets
When you combine operations in batch mode, please consider the following:
Within a changeset, you can combine operations pertaining to only one purchase requisition.
You can create only one purchase requisition within a changeset. Use multiple changesets to create multiple purchase
requisitions.
You can update only one purchase requisition within a changeset. Use multiple changesets to update multiple purchase
requisitions.
ETags
The API uses entity tags (ETags) for optimistic concurrency control. That is, if a client requests a modi cation of a resource on
the back-end server, the ETags of the resource on the client server and on the back-end server are compared to determine
whether any changes were made to the resource on the back-end server. For this API, the If-Match header must be set for all
change operations.
Create
Create an Item Note

In this scenario, you wish to create a purchase requisition of document type "NB", for a free text item.
Request
A_PurchaseRequisition_2 - Purchase Requisition
Response
1/30/2023
On success, a purchase requisition is created. In the example below, purchase requisition "10783070" is created.
Examples
Request
POST <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequisition/0001/Purc
{
"PurReqnDescription": "Example PR",
"_PurchaseRequisitionItem": [
{
"RequestedQuantity": 100,
"BaseUnit": "EA",
"PurchaseRequisitionPrice": 1.00,
"Plant": "0001",
"CompanyCode": "0001"
}
]
}
Response

{
"@odata.context": "$metadata#PurchaseReqn(_PurchaseRequisitionItem())/$entity",
"@odata.metadataEtag": "W/\"20201013095656\"",
"PurReqnDescription": "Example PR",
"SAP__Messages": [],
{
"Material": "",
"BaseUnit": "EA",
"PurReqnPriceQuantity": 1,
"MaterialGoodsReceiptDuration": 0,
"Plant": "0001",
"OrderedQuantity": 0,
"DeliveryDate": "2020-10-14",
"Supplier": "",
1/30/2023
"IsDeleted": false,
"CreatedByUser": "JOHN",
"PurReqCreationDate": "2020-10-13",
"MaterialPlannedDeliveryDurn": 0,
"PurReqnItemBlockingStatus": "",
"PurReqnItemBlockingReasonText": "",
"Language": "EN",
"IsClosed": false,
"ProductTypeCode": "1",
"Batch": "",
"MinRemainingShelfLife": 0,
"ItemNetAmount": 100.00,
"LastChangeDateTime": "2020-10-13T11:06:45.35354Z",
"ExpectedOverallLimitAmount": 0.00,
"OverallLimitAmount": 0.00,
"SAP__Messages": []
}
]
}

In this scenario, you wish to add an item to an existing purchase requisition. In the sample below, we are adding an item "cable"
of quantity "100" to the purchase requisition "10783070".
Request
A_PurchaseRequisitionItem_2 - Item
1/30/2023
Response
On success, the operation creates an item with the details provided in the request. If there are any errors, the appropriate error
messages are returned.
Examples
Request
{
"BaseUnit": "EA",
"Plant": "0001",
"CompanyCode": "0001"
}
Response

{
"@odata.context": "$metadata#PurchaseReqnItem/$entity",
"Material": "",
"BaseUnit": "EA",
"Plant": "0001",
"Supplier": "",
"IsDeleted": false,
1/30/2023
"Language": "EN",
"IsClosed": false,
"Batch": "",
"SAP__Messages": []
}

In this scenario, you wish to add a limit item to an existing purchase requisition. In the sample below, we are adding a limit item
to the purchase requisition "10783070", in order to procure minor office supplies for the period 20 August 2020 to 3 September
2020. As the exact details such as price and quantity are not known at the time of ordering, we create a limit item, that is item
with PurchasingDocumentItemCategory 'A'. We can provide the amount we expect to spend on this item using the eld,
"ExpectedOverallLimitAmount", which is 100 EUR in this case. The overall limit or upper limit of the amount that can be spent on
this item is provided using the eld "OverallLimitAmount", which is also 100 EUR in this case. The expected amount must not
exceed the overall limit amount.
Request
Response
1/30/2023
On success, the operation creates a limit item with the details provided in the request. If there are any errors, the appropriate
Examples
Request
{
"PurchaseRequisitionItemText": "Minor Office Supplies",
"Plant": "0001",
"ExpectedOverallLimitAmount": 100,
"OverallLimitAmount": 100,
"PerformancePeriodStartDate": "2020-08-20",
"PerformancePeriodEndDate": "2020-09-03"
}
Response

{
"Material": "",
"RequestedQuantity": 0.000,
"BaseUnit": "",
"Plant": "0001",
"OrderedQuantity": 0.000,
"Supplier": "",
"IsDeleted": false,
1/30/2023
"Language": "EN",
"IsClosed": false,
"PerformancePeriodEndDate": "2020-09-03",
"Batch": "",
"SAP__Messages": []
}
Create an Item Note

In this scenario, you wish to add an item note to an item in a purchase requisition. In the sample below, we are adding the item
note "Coaxial Cable" to item "10" of purchase requisition "10783070".
Request
A_PurchaseReqnItemText_2 - Item Notes
Response
On success, the item note is added to the purchase requisition item. The item note "Coaxial Cable" is added to item "10" of
purchase requisition "10783070".
Examples
1/30/2023
Request
{
"TextObjectCategory": "EBAN",
"TextObjectType": "B01",
"Language": "EN",
"PlainLongText": "Coaxial Cable"
}
Response

{
"@odata.context": "$metadata#PurchaseReqnItemText/$entity",
"TextObjectKey": "001078307000010",
"Language": "EN",
"PlainLongText": "Coaxial Cable",
"FixedIndicator": "",
"SAP__Messages": []
}

In this scenario, you wish to add an accounting line to an item in a purchase requisition. In the sample below, we are adding an
accounting line to item "10" of purchase requisition "10783070". Please note that while you add a new accounting line to an
item, you must also correspondingly update the accounting details in the purchase requisition item, hence this operation is only
supported as a batch request.
Request
A_PurchaseReqnAcctAssgmt_2 - Account Assignment
Response
Examples
Request
POST <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequisition/0001/$bat
--batch
content-type: multipart/mixed; boundary=changeset
--changeset
1/30/2023
Content-ID: 1
PATCH PurchaseReqnItem(PurchaseRequisition='10783070',PurchaseRequisitionItem='10') HTTP/1.1

{
"AccountAssignmentCategory": "K"
}
--changeset
Content-ID: 2
POST PurchaseReqnAcctAssgmt HTTP/1.1

{
"CostCenter": "JMW-COST",
"GLAccount": "46000"
}
--changeset--
--batch--
Response
status_code: 200 OK
--EE71428608BB8AAEA0983B819C3CFAF60
Content-Type: multipart/mixed; boundary=EE71428608BB8AAEA0983B819C3CFAF61
content-id: 1
HTTP/1.1 200 OK
Content-Type: application/json;odata.metadata=minimal;charset=utf-8
odata-version: 4.0
cache-control: no-cache, no-store, must-revalidate
sap-messages: [{"code":"06/403","message":"Purchase requisition 10783070 changed","numericSeverity"
{
"Material": "",
"BaseUnit": "EA",
"PurchaseRequisitionPrice": 1,
1/30/2023
"Plant": "0001",
"Supplier": "",
"IsDeleted": false,
"ConsumptionPosting": "V",
"Language": "EN",
"IsClosed": false,
"Batch": "",
"ItemNetAmount": 100,
"GoodsReceiptIsNonValuated": true,
"ProcurementHubSourceSystem": "",
"SAP__Messages": []
}
content-id: 2

location: PurchaseReqnAcctAssgmt(PurchaseRequisition='10783070',PurchaseRequisitionItem='10',Purcha
odata-version: 4.0
1/30/2023
{
"@odata.context": "$metadata#PurchaseReqnAcctAssgmt/$entity",
"BaseUnit": "EA",
"Quantity": 100,
"MultipleAcctAssgmtDistrPercent": 0,
"PurReqnNetAmount": 0,
"IsDeleted": false,
"BusinessArea": "0001",
"SalesOrder": "",
"FixedAsset": "",
"OrderID": "",
"CostObject": "",
"FundsCenter": "",
"Fund": "",
"GrantID": "",
"ValidityDate": "2020-10-14",
"ChartOfAccounts": "INT",
"WBSElementExternalID": "",
"SAP__Messages": []
}
--EE71428608BB8AAEA0983B819C3CFAF61--
--EE71428608BB8AAEA0983B819C3CFAF60--

In this scenario, you wish to add another accounting line to an item in a purchase requisition. In the sample below, we are adding
another accounting line to item "10" of purchase requisition "10783070". Please note that while you add a new accounting line
to an item, you must also correspondingly update the accounting details in the purchase requisition item, hence this operation
is only supported as a batch request.
Request
1/30/2023
A_PurchaseReqnAcctAssgmt_2 - Add Accounting Lines - Single to Multiple

Account Distribution
Response
Examples
Request
--batch
content-type: multipart/mixed; boundary=changeset
--changeset
Content-ID: 1
PATCH PurchaseReqnItem(PurchaseRequisition='10783070',PurchaseRequisitionItem='10') HTTP/1.1

{
"MultipleAcctAssgmtDistribution": "1"
}
--changeset
Content-ID: 2
PATCH PurchaseReqnAcctAssgmt(PurchaseRequisition='10783070',PurchaseRequisitionItem='10',PurchaseRe
{
"Quantity": 70,
"BaseUnit": "EA"
}
--changeset
Content-ID: 3
POST PurchaseReqnAcctAssgmt HTTP/1.1

{
"Quantity": 30,
"BaseUnit": "EA"
}
--changeset--
--batch--
1/30/2023
Response
status_code: 200 OK
--5F3EC26D4515625E64D2416C87C82F280
Content-Type: multipart/mixed; boundary=5F3EC26D4515625E64D2416C87C82F281
--5F3EC26D4515625E64D2416C87C82F281
content-id: 1
HTTP/1.1 200 OK
odata-version: 4.0
sap-messages: [{"code":"06/403","message":"Purchase requisition 10783070 changed","numericSeverity"
{
"Material": "",
"BaseUnit": "EA",
"PurchaseRequisitionPrice": 1,
"Plant": "0001",
"Supplier": "",
"IsDeleted": false,
"MultipleAcctAssgmtDistribution": "1",
"ConsumptionPosting": "V",
1/30/2023
"Language": "EN",
"IsClosed": false,
"Batch": "",
"ItemNetAmount": 100,
"GoodsReceiptIsNonValuated": true,
"SAP__Messages": []
}
--5F3EC26D4515625E64D2416C87C82F281
content-id: 2
HTTP/1.1 200 OK
odata-version: 4.0
{
"@odata.context": "$metadata#PurchaseReqnAcctAssgmt/$entity",
"BaseUnit": "EA",
"Quantity": 70,
"MultipleAcctAssgmtDistrPercent": 70,
"PurReqnNetAmount": 0,
"IsDeleted": false,
"BusinessArea": "0001",
"SalesOrder": "",
"FixedAsset": "",
"OrderID": "",
"CostObject": "",
"FundsCenter": "",
"Fund": "",
1/30/2023
"GrantID": "",
"ValidityDate": "2020-10-14",
"ChartOfAccounts": "INT",
"WBSElementExternalID": "",
"SAP__Messages": []
}
--5F3EC26D4515625E64D2416C87C82F281
content-id: 3

location: PurchaseReqnAcctAssgmt(PurchaseRequisition='10783070',PurchaseRequisitionItem='10',Purcha
odata-version: 4.0
{"@odata.context":"$metadata#PurchaseReqnAcctAssgmt/$entity","@odata.metadataEtag":"W/\"20201014104
--5F3EC26D4515625E64D2416C87C82F281--
--5F3EC26D4515625E64D2416C87C82F280--
Read
Read Item Notes

In this scenario, you wish to read a purchase requisition. In the sample below, we are reading the purchase requisition
"10783070", along with its items and associated entities.
Request
Response
1/30/2023
On Success, this operation returns the purchase requisition along with its associated entities. In the sample below, the purchase
requistion "10783070" is returned, along with its header and item level details.
Examples
Request
GET <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequisition/0001/Purch
Response
{
"@odata.context": "$metadata#PurchaseReqn(_PurchaseRequisitionItem(_PurchaseReqnItemText(),_Pur
"PurReqnDescription": "Test Patch Update",
{
"Material": "",
"BaseUnit": "EA",
"Plant": "0001",
"Supplier": "",
"IsDeleted": false,
1/30/2023
"Language": "EN",
"IsClosed": false,
"Batch": "",
"_PurchaseReqnAcctAssgmt": [],
"_PurchaseReqnDelivAddress": {
"Plant": "0001",
"PurchasingDeliveryAddressType": "P",
"CareOfName": "",
"POBox": "",
"FullName": "SAP Labs 1",
"District": "",
"CityCode": "",
"HomeCityName": "",
"StreetName": "Hasso-Plattner-Ring",
"HouseNumber": "7",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "08",
"County": "",
1/30/2023
"BusinessPartnerName1": "SAP Labs 1",
"PhoneNumber": "333",
"FaxNumber": "",
"SearchTerm1": "",
"SAP__Messages": []
},
"_PurchaseReqnItemText": []
},
{
"Material": "",
"RequestedQuantity": 0.000,
"BaseUnit": "",
"Plant": "0001",
"OrderedQuantity": 0.000,
"Supplier": "",
"IsDeleted": false,
"Language": "EN",
"IsClosed": false,
"PerformancePeriodEndDate": "2020-09-03",
1/30/2023
"Batch": "",
"Plant": "0001",
"PurchasingDeliveryAddressType": "P",
"CareOfName": "",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "7",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "08",
"County": "",
"PhoneNumber": "333",
"FaxNumber": "",
"SearchTerm1": "",
"SAP__Messages": []
},
1/30/2023
"_PurchaseReqnItemText": []
},
{
"Material": "",
"BaseUnit": "EA",
"Plant": "0001",
"Supplier": "",
"IsDeleted": false,
"Language": "EN",
"IsClosed": false,
"Batch": "",
1/30/2023
"Plant": "0001",
"PurchasingDeliveryAddressType": "U",
"CareOfName": "CareOfNameUpdated",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "7",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "08",
"County": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"SAP__Messages": []
},
"_PurchaseReqnItemText": [
{
"TextObjectKey": "001078307000010",
"Language": "EN",
"PlainLongText": "Twisted Cables",
"SAP__Messages": []
}
1/30/2023
]
}
]
}

In this scenario, you wish to read an item in a purchase requisition. In the sample below, we are reading item "10" of purchase
Request
Response
On success, this operation returns the item in the purchase requisition. Here, it returns item "10" of purchase requisition
"10783070", along with its associated entities.
Examples
Request
Response
status_code: 200 OK
{
"@odata.context": "$metadata#PurchaseReqnItem(_PurchaseReqnItemText(),_PurchaseReqnAcctAssgmt()
"Material": "",
"BaseUnit": "EA",
"Plant": "0001",
1/30/2023
"Supplier": "",
"IsDeleted": false,
"Language": "EN",
"IsClosed": false,
"Batch": "",
"Plant": "0001",
"POBox": "",
1/30/2023
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "7",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "08",
"County": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"SAP__Messages": []
},
"_PurchaseReqnItemText": [
{
"TextObjectKey": "001078307000010",
"Language": "EN",
"PlainLongText": "Coax Cables",
"SAP__Messages": []
}
]
}

In this scenario, you wish to read the delivery address of an item in a purchase requisition. In the sample below, we are reading
the delivery address of item "10" of purchase requisition "10783070".
Request
A_PurchaseReqnDelivAddress_2 - Delivery Address
Response
1/30/2023
On success, this operation returns the delivery address of the purchase requisition item. Here, it returns the delivery address
maintained in item "10" of purchase requisition "10783070".
Examples
Request
Response
status_code: 200 OK
{
"@odata.context": "$metadata#PurchaseReqnDelivAddress/$entity",
"Plant": "0001",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "7",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "08",
"County": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"SAP__Messages": []
}
1/30/2023
Read Item Notes

In this scenario, you wish to read the item note of all items in a purchase requisition. In the sample below, we are reading the
item note of all items in purchase requisition "10783070"
Request
Response
On success, this operation returns the item note of all items in a purchase requisition. Here, it returns the item note of all the
items in the purchase requisition "10783070".
Examples
Request
Response
status_code: 200 OK
{
"@odata.context": "$metadata#PurchaseReqnItemText",
"value": [
{
"TextObjectKey": "001078307000010",
"Language": "EN",
"SAP__Messages": []
}
]
}
Update
Update Item Notes
1/30/2023

In this scenario, you wish to update a purchase requisition. In the sample below, we are updating the description of purchase
Request
Response
On success, the description of purchase requisition is updated. Here,description of purchase requisition "10783070" is updated.
Examples
Request
PATCH <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequisition/0001/Pur
{
"PurReqnDescription": "Test Patch Update"
}
Response
status_code: 200 OK
{
"@odata.context": "$metadata#PurchaseReqn/$entity",
"PurReqnDescription": "Test Patch Update",
"SAP__Messages": []
}

In this scenario, you wish to update an item in a purchase requisition. In the sample below, we are updating the purchase
requisition item text of item "10" of purchase requisition "10783070". If the elds that have been updated retrigger the
work ow based on the work ow con guration, the item status gets changed to In Release and the item is then resubmitted for
further processing.
Rejected items and items that have follow-on documents can also be updated using this operation. The status gets changed to
In Release and is resubmitted for further processing.
Request
1/30/2023
Response
On success, the purchase requisition item details are updated. Here, the purchase requisition item text of item "10" of purchase
requisition "10783070" is updated.
Examples
Request
{
"PurchaseRequisitionItemText": "ItemTextUpdated"
}
Response
status_code: 200 OK
{
"Material": "",
"BaseUnit": "EA",
"Plant": "0001",
"Supplier": "",
"IsDeleted": false,
1/30/2023
"Language": "EN",
"IsClosed": false,
"Batch": "",
"SAP__Messages": []
}

this scenario, you wish to update the delivery address details of an item in a purchase requisition. In the sample below, we are
updating the delivery address details of item "10" of purchase requisition "10783070".
Request
A_PurchaseReqnDelivAddress_2 - Delivery Address
Response
On success, the delivery address details of the purchase requisition item are updated. Here, the delivery address details of item
"10" of purchase requisition "10783070" are updated.
Examples
Request
1/30/2023
{
"CareOfName": "CareOfNameUpdated"
}
Response
status_code: 200 OK
{
"@odata.context": "$metadata#PurchaseReqnDelivAddress/$entity",
"Plant": "0001",
"POBox": "",
"District": "",
"CityCode": "",
"HomeCityName": "",
"HouseNumber": "7",
"Building": "",
"Floor": "",
"RoomNumber": "",
"Country": "DE",
"Region": "08",
"County": "",
"PhoneNumber": "",
"FaxNumber": "",
"SearchTerm1": "",
"SAP__Messages": []
}
Update Item Notes

In this scenario, you wish to update the item note of an item in a purchase requisition. In the sample below, we are updating the
item note of item "10" of purchase requistion "10783070".
1/30/2023
Request
Response
On success, the item note of the purchase requisition item is updated. Here, the item note of item "10" of purchase requisition
"10783070" is updated.
Examples
Request
{
"PlainLongText": "Twisted Cables"
}
Response
status_code: 200 OK
{
"@odata.context": "$metadata#PurchaseReqnItemText/$entity",
"TextObjectKey": "001075287500010",
"Language": "EN",
"SAP__Messages": []
}
Delete
Delete an Item Note

In this scenario, you wish to delete an item in a purchase requisition. In the sample below, we are deleting item "20" of purchase
 Note
DELETE operation is not supported. The purchase requisition item is marked for deletion.
1/30/2023
Request
Response
On success, this operation marks the purchase requisition item for deletion. Here, it marks item "20" of purchase requisition
"10783070" for deletion.
Examples
Request
"IsDeleted": true
}
Response
Delete an Item Note

In this scenario, you wish to delete an item note in an item in a purchase requisition. In the sample below, we are deleting the
item note in item "10" of purchase requisition "10783070".
Request
Response
On success, the item note in item "10" of purchase requisition "10783070" is deleted.
Examples
Request
DELETE <host>/sap/opu/odata4/sap/api_purchaserequisition_2/srvd_a2x/sap/purchaserequisition/0001/Pu
Response

1/30/2023
Validate
This operation performs a number of validation checks on the data in a purchase requisition.
Request
PurchaseRequisition Mandatory A string that uniquely identi es a request to

Response
On success, it returns the success response code, indicating that the parameters in the purchase requisition are valid.
Examples
Request
Response
External solutions integrated with SAP S/4HANA Cloud can invoke this operation on purchase requisitions, and enable them for
purchasing in SAP S/4HANA Cloud system.
External solutions can create purchase requisitions in SAP S/4HANA Cloud with external processing status as In Process
Externally, that is, the value of the eld ExternalApprovalStatus must be set to ʻP’. The solutions can then invoke the operation
EnablePurReqForPurchasing, on these purchase requisitions. The operation transitions the external processing status of
the purchase requisitions, and enables them for purchasing in SAP S/4HANA Cloud system.
 Note
This operation can only be applied on purchase requisitions that are created from external solutions integrated with
SAP S/4HANA Cloud, with external processing status as In Process Externally.
You cannot update or delete purchase requisitions in SAP S/4HANA Cloud system, while their external processing
status is In Process Externally.
1/30/2023
Request

PATCH: Mandatory
Response
On success, it returns the success response code, indicating that the status of the purchase requisition has been changed to
enable it for purchasing. Else, it returns the appropriate error code and message.

originates.
 Note
messages.
Examples
Request
Response
status_code: 200 OK
1/30/2023
External solutions integrated with SAP S/4HANA Cloud can invoke this operation on purchase requisitions, and discard them
from purchasing in SAP S/4HANA Cloud system.
External solutions can create purchase requisitions in SAP S/4HANA Cloud with external processing status as In Process
DiscardPurReqFromPurchasing, on these purchase requisitions. The operation transitions the external processing status
of the purchase requisitions, and discards them from purchasing in SAP S/4HANA Cloud system.
 Note
This operation can only be applied on purchase requisitions that are created from external solutions integrated with
SAP S/4HANA Cloud, with external processing status as In Process Externally.
You cannot update or delete purchase requisitions in SAP S/4HANA Cloud system, while their external processing
status is In Process Externally.
Request

PATCH: Mandatory
Response
On success, it returns the success response code, indicating that the status of the purchase requisition has been changed to
discard it from purchasing. Else, it returns the appropriate error code and message.
1/30/2023

originates.
 Note
messages.
Examples
Request
Response
status_code: 200 OK
EnablePurReqItemForPurchasing
External solutions integrated with SAP S/4HANA Cloud can invoke this operation on purchase requisition items, and enable
them for purchasing in SAP S/4HANA Cloud system.
EnablePurReqItemForPurchasing, on these purchase requisition items. The operation transitions the external processing
status of the purchase requisition items, and enables them for purchasing in SAP S/4HANA Cloud system.
 Note
Request
1/30/2023

PATCH: Mandatory
 Note
Response
code, indicating that the status of the purchase requisition item has been changed to enable it for purchasing.

originates.
 Note
messages.
Example
Request
1/30/2023
Response
status_code: 200 OK
DiscardPurReqItemFromPurg
External solutions integrated with SAP S/4HANA Cloud can invoke this operation on purchase requisition items, and discard
them from purchasing in SAP S/4HANA Cloud system.
DiscardPurReqItemFromPurg, on these purchase requisition items. The operation transitions the external processing
status of the purchase requisition items, and discards them from purchasing in SAP S/4HANA Cloud system.
 Note
Request

PATCH: Mandatory
 Note
Response
code, indicating that the status of the purchase requisition item has been changed to discard it for purchasing.
1/30/2023

originates.
 Note
messages.
Examples
Request
Response
status_code: 200 OK
Purchase Requisition – Create, Update

Short description: PurchaseRequisitionRequest_In, service de nition: MMPUR_PURREQUISITIONREQUEST_IN
This inbound service enables you to create and update purchase requisitions through an API call. The update operation can be
used to ag line items as “deleted” or “undeleted”. The item category “standard” allows you to use material items (product
type group “1”) and lean services (product type group „2 “). Enhanced limit items (item category “E”) are also supported.
The service contains a message header and nodes for the purchase requisition header, attachments at header level, the
purchase requisition item, the delivery address, account assignment information, a text collection, and attachments at item
level.
1/30/2023
Service Structure
Service Message Header: The service message header contains information about the service.
The following nodes and elds are the most important ones:

created
SenderBusinessSystemID ID of the external system that sends the

message
SenderParty InternalID ID of the business partner that sends the

message to your SAP S/4HANA Cloud
system. The ID must be identical to the
business partner's ID in your SAP S/4HANA
Cloud system.
Service Nodes
Service Node / Field Description Is a Subnode of Link to Details
PurchaseRequisition Purchase requisition header n/a PurchaseRequisitionRequest_In

[Service Node] – PurchaseRequisition
Attachment [Field] Attachment Purchase requisition header and PurchaseRequisitionRequest_In

purchase requisition item – Attachment
PurRequisitionReqItm Purchase requisition item Purchase requisition PurchaseRequisitionRequest_In

[Service Node] – PurRequisitionReqItm
PurReqDeliveryAddress Delivery address of purchase Purchase requisition item PurchaseRequisitionRequest_In

[Service Node] requisition item - PurReqDeliveryAddress
PurReqAcctAssignment Account assignment of Purchase requisition item PurchaseRequisitionRequest_In

[Service Node] purchase requisition item – PurReqAcctAssignment
TextCollection [Service Node] Text collection Purchase requisition item PurchaseRequisitionRequest_In

– TextCollection
Restrictions
Create items with item category “enhanced limit”
Determine sources of supply
Note
You should always transfer the external procurement reference document ID (ExtProcmtRefDocument). This applies
when you use the service to create a purchase requisition and when you use it to update a purchase requisition.
1/30/2023
You have to provide both the external procurement reference document ID and the external procurement reference
document item ID. This means, you have to ll the elds ExtProcmtRefDocument and
ExtProcmtRefDocumentItem.

Namespace: /MMPUR
Recipient Name: MMPUR_PREQN_IN
Interface: PREQNIN
Extensibility
This service can be extended at item level, using the app Custom Fields and Logic. The business context is Purchase Requisition
Item (MM_PURREQN_ITEM).
PurchaseRequisitionRequest_In – PurchaseRequisition
Fields of the Purchase Requisition Header
Field Description Necessity
ActionCode Action code Mandatory
ItemListCompleteTransmissionIndicator Indicates whether full transmission or Mandatory

partial transmission of the data is
performed. Currently, only full
transmission is supported.
PurchaseRequisitionID Purchase requisition number Optional
PurchasingRequisitionType Purchasing requisition type Mandatory
PurchaseRequisitionText Purchase requisition text Optional
ExtProcmtRefDocument External procurement reference Optional

document: identi es the document in
the external system that corresponds to
the purchase requisition in SAP
S/4HANA Cloud
Attachment Attachment Optional
PurchaseRequisitionRequest_In – Attachment
1/30/2023
Attributes of the purchase requisition attachments
Attribute Description Necessity
FileName File name Mandatory
MimeType Mime type Mandatory
FileSize File size Mandatory
 Note
Chrome.
PurchaseRequisitionRequest_In – PurRequisitionReqItm
Service nodes and elds of purchase requisition items
Service Node / Field Description Necessity Link to Further Field

Documentation
PurchaseRequisitionItemID Identi er of Optional

purchase
requisition item
PurReqItemCategory Item category of Mandatory

the purchase
requisition
PurReqnOrigin Purchase Optional

requisition origin:
speci es the
background why a
purchase
requisition was
created, for
example, from an
MRP run or for a
production order
PurchasingOrganization Purchasing Optional

organization
MaterialRevisionLevel Material revision Optional

level: together with
a change number,
this identi er
denotes the
change status of a
material or
document.
RequisitionerName Requisitioner Optional

name
1/30/2023

Documentation
PurchaseRequisitionItemText Text of purchase Optional

requisition item
Material Material number Optional

of the requested
item
SupplierMaterialNumber Supplier material Optional

number
MfrPartNumber Manufacturer part Optional

number
PurReqnPrice Purchase Optional

requisition price
PurReqnPrice Shows the price of Optional

the requested
material per price
unit
PurReqnPriceQuantity Speci es for how Optional

many units the
price is valid
PurReqQuantity Purchase Optional

requisition
quantity: identi es
the quantity of the
material
requested on this
purchase
requisition item
PurReqCreationDate Creation date of Optional

the purchase
requisition
DelivDateCategory Delivery date Optional

category:
indicates whether
the delivery date
is entered and
displayed as a
calendar day,
week or month
GoodsReceiptDurationInDays Goods receipt Optional

duration in days:
Represents the
number of
workdays required
for inspection and
for placement into
storage after a
material has been
received.
1/30/2023

Documentation
Plant Plant Mandatory
RequirementTracking The requirement Optional

tracking number is
copied from the
purchase
requisition to other
purchasing
documents (for
example: RFQ or
purchase order)
for reference. The
requirement
tracking number
thus enables you
to group the
purchasing
documents that
exist for a speci c
material
requirement.
AcctAssignmentCategory Account Optional

assignment
category
ConsumptionPosting Consumption Optional

posting: speci es
that the
consumption is to
be posted to a
consumption
account (V) or an
asset account (A)
MultipleAcctAssgmtDistribution Multiple account Optional

assignment
distribution:
indicates how the
quantity and value
of the purchase
order item are
distributed to
individual account
assignment items
1/30/2023

Documentation
PartialInvoiceIndicator Partial invoice Optional

indicator:
determines how
invoice amounts in
partial invoices
are to be
distributed among
the individual
account
assignments. -
Applies when
multiple account
assignment
distribution is
used
GoodsReceiptIsExpected Goods receipt is Optional

expected:
indicates that a
goods receipt is
expected
GoodsReceiptIsNonValuated Goods receipt is Optional

non-valuated:
indicates that a
goods receipt is
not valuated.
InvoiceIsExpected Invoice is Optional

expected:
indicates that an
invoice is
expected.
PurReqnSourceOfSupplyType Purchase Optional

requisition source
of supply type:
allows making a
distinction
between the
purchasing
documents that
can be used as
sources of supply
PurchasingInfoRecord Speci es the Optional

number that
uniquely identi es
a purchasing info
record. It indicates
that a Purchasing
info record exists.
SourceOfSupplyIsAssigned Source of supply Optional

is assigned:
indicator denoting
that a source of
supply has been
assigned
1/30/2023

Documentation
MRPController MRP Controller: Optional

speci es the
number of the
MRP controller or
group of MRP
controllers who are
responsible for
planning for the
material
IsClosed Is closed: Optional

indicates that a
purchase
requisition is
closed; this means
that no further
purchase orders
are to be created
for this purchase
requisition
PurchaseRequisitionIsFixed Purchase Optional

requisition is
xed: rms the
purchase
requisition or
delivery schedule
line of a
scheduling
agreement, and
determines that it
cannot be
automatically
changed by the
materials planning
and control
system
PurReqnReceivingSupplier Purchase Optional

requisition
receiving supplier:
the supplier to be
supplied, that is,
who is to receive a
delivery of raw
materials, for
example
MaterialPlannedDeliveryDurn Material planned Optional

delivery duration:
number of
calendar days that
is needed to
obtain the material
or service if it is
procured
externally
1/30/2023

Documentation
PurchaseRequisitionStatus Purchase Optional

requisition status
IsPurReqnBlocked Indicates whether Optional

a purchase
requisition is
blocked
ExtMaterialForPurg External material Optional

for purchasing: a
material in an
external system
that is the
equivalent of a
material in the
SAP S/4HANA
system
ExtFixedSupplierForPurg External xed Optional

supplier for
purchasing: xed
supplier from an
external system
ExtDesiredSupplierForPurg External desired Optional

supplier for
purchasing:
desired supplier
from an external
system
ExtContractForPurg External contract Optional

for purchasing
ExtContractItemForPurg External contract Optional

item for
purchasing
ExtInfoRecordForPurg External info Optional

record for
purchasing
ExtPlantForPurg External plant for Optional

purchasing
ExtCompanyCodeForPurg External company Optional

code for
purchasing
ExtPurgOrgForPurg External Optional

purchasing
organization for
purchasing
ExtProcmtRefDocumentItem External Optional

procurement
reference
document item
1/30/2023

Documentation
MinRemainingShelfLife Minimum Optional

remaining shelf
life: speci es the
minimum amount
of time for which
the material must
keep upon goods
receipt so that the
goods receipt is
accepted by the
system.
PurchasingDocumentItemProductType Purchasing Optional

document item
product type:
identi es the
product type
group of the item,
such as “material”
or “service”
OverallLimitAmount Overall limit Optional

amount: maximum
value that the total
of all unplanned
services (or the
value of the
material) covered
by this document
item may not
exceed
ExpectedOverallLimitAmount Expected overall Optional

limit amount:
value that the
unplanned
services (or the
material) covered
by this item are
not expected to
exceed.
PerformancePeriod Performance Optional

period
PerformancePeriodStartDate Start date of the Optional

performance
period (applicable
to enhanced limit
items)
PerformancePeriodEndDate End date of the Optional

performance
period (applicable
to enhanced limit
items)
Batch Batch Optional
1/30/2023

Documentation
PurchasingContractReference Reference to a Optional

purchase contract
PurchaseContractID ID of the Optional

referenced
purchase contract
PurchaseContractItemID ID of the Optional

referenced
purchase contract
item
PurchasingOrderReference Reference to a Optional

purchase order or
scheduling
agreement
PurchasingDocumentID ID of a referenced Optional

purchase order or
scheduling
agreement
PurchasingDocumentItem ID of a referenced Optional

purchase order or
scheduling
agreement item
ItemNetAmount Item net amount Optional
PurReqnSSPRef Collection of data Optional

that is relevant
when self-service
requisitioning is
used to create the
purchase
requisition
PurReqnSSPAuthor Person who has Optional

created the
purchase
requisition
PurReqnSSPCatalog Technical key of a Optional

web service, e.g. a
catalog
PurReqnSSPCatalogItem Catalog item ID Optional
PurReqnSSPCrossCatalogItem Catalog item Optional

number
1/30/2023

Documentation
PurReqnSSPRequestor Person who has a Optional

requirement and
on whose behalf
the purchase
requisition was
created. Can differ
from the author in
cases when an
author creates a
PR on behalf of
another user.
CreatedByUser Created by user Optional
PurReqDeliveryAddress Delivery address Optional PurchaseRequisitionRequest_In

for the material or - PurReqDeliveryAddress
service ordered in
the purchase
requisition
PurReqAcctAssignment Account Mandatory PurchaseRequisitionRequest_In

assignment of the – PurReqAcctAssignment
purchase
requisition
TextCollection Text collection Optional PurchaseRequisitionRequest_In

– TextCollection
Attachment Attachment Optional
 Note
Chrome.
PurchaseRequisitionRequest_In - PurReqDeliveryAddress
Nodes and elds of the delivery address
Service Node / Field Description Necessity
AddressName Name of the company or person Optional

in the address
Country Country Optional
FaxNumber Fax number Optional
1/30/2023
PhoneNumber Phone number Optional
AreaID Area ID
SubscriberID Subscriber ID
ExtensionID Extension ID
CountryDiallingCode Country dialling code
AddressRegion Address region Optional
 Note
Chrome.
PurchaseRequisitionRequest_In – PurReqAcctAssignment
Account assignment data elds in a purchase requisition
CostCtrActivityType Cost center activity type: A unit in a Optional

controlling area that classi es the activities
performed in a cost center.
Example: Activity types in production cost
centers are machine hours or nished units.
CreationDate Creation date Optional
EarmarkedFundsDocument Number of earmarked funds document Optional
FixedAsset Fixed asset Optional
Fund Fund Optional
FundsCenter Funds center Optional
GLAccount General ledger account Optional
1/30/2023
GoodsRecipientName Goods recipient name Optional
GrantID Grant ID Optional
IsDeleted Indicator that re ects whether the item in a Optional

purchase requisition has been deleted
MasterFixedAsset Master xed asset: The number which, Optional

together with the asset sub-number,
identi es a xed asset in Asset Accounting
MultipleAcctAssgmtDistrPercent If multiple account assignment distribution Optional

is in place: the percentage value which is
assigned to a single account assignment
line
PurReqnNetAmount Purchase requisition net amount: The value Optional

of a single account assignment line item if
multiple account assignment is used
NetworkActivityInternalID Internal ID of the network activity (not Optional

visible to the user)
OrderID Order ID: Key that uniquely identi es an Optional

order within a client, for example a
production order or a process order
OrderIntBillOfOperationsItem General counter for a production order or a Optional

process order
OrderInternalID Order Internal ID: Number of the routing or Optional

reference operation set used in the order
PartnerAccountNumber Account number of a business partner Optional
ProfitabilitySegment Pro tability segment Optional
ProfitCenter Pro t center Optional
ProjectNetwork Project network Optional
ProjectNetworkInternalID Project network internal ID: Number of the Optional

routing or reference operation set used in
the network order.
PurchaseReqnAcctAssgmtNumber Purchase Requisition Account Assignment Optional

Number: Number that uniquely identi es
the account assignment of a purchasing
document item
PurReqQuantity Purchase Requisition Quantity: quantity Optional

speci c to an account assignment line
RealEstateObject Real estate object Optional
SalesOrderScheduleLine Sales order schedule line Optional
1/30/2023
SettlementReferenceDate Settlement Reference Date: date that is Optional

used to identify the settlement period for
invoice account assignment
UnloadingPointName Unloading point name Optional
WBSElement WBS element Optional
 Note
Chrome.
PurchaseRequisitionRequest_In – TextCollection
Fields and nodes of the text collection of a purchase requisition
TextTypeCode Code identifying the text type Optional
CreationDateTime Creation date and time Optional
ContextText Context of the text Mandatory
BuyerTextElementID (currently not used) n/a
SupplierTextElementID (currently not used) n/a
TextElementLanguage (currently not used) n/a
TextElementText Text of a purchase requisition Mandatory

item
TextElementTextFormat (currently not used) n/a
 Note
Chrome.
Purchase Requisition - Send Status Update Noti cations
Description
Technical name of the service: PurchaseRequesitionStatusNotification_Out
Service Structure
1/30/2023
This outbound SOAP interface enables you to send status noti cations to an external system from the SAP S/4HANA system if
certain changes that are relevant for the business process have been made to a purchase requisition. This includes noti cations
upon creation, blocking and deletion of the purchase requisitions. Furthermore, messages are sent to notify the external
consumer about completion and release status changes. The external consumer receives noti cations about any changes to
the processing status of the purchase requisition. You can use this service only for purchase requisitions that were created via
the inbound web service for purchase requisition creation Purchase Requisition– Create.
This services sends a noti cation message with the following status information to the external consumer:
Purchase Requisition Status Field Description
BANPR This is the processing status of the purchase requisition. The following statuses
are available:
01 (In Process)
02 (Active)
03 (In Release)
04 (For Overall Release)
05 (Release Completed)
08 (Release Refused)
FRGZU This is the release status of the purchase requisition that indicates whether the
purchase requisition has already been approved. It is set automatically if the
release strategy for the purchase requisitions has been applied.
MEMORY Indicates that the purchase requisition has not yet been completed
MEMORYTYPE Shows that the purchase requisition is not yet complete, and indicates the status.
The following statuses are available:
' ' (Document Saved as Complete)
P (Document Parked)
H (Document on Hold)
LOEKZ This is the deletion indicator of the purchase requisition. The following values are
available:
S (Blocked)
L (Deleted)
Service Structure
The request contains a MessageHeader node element, a PurchaseRequesitionHeader node element and a
PurchaseRequesitionItemList node element.
Entities
The entities contain the business data of the service. The PurchaseRequesitionHeader node element contains the ID of
the purchase requisition, as well as its the reference ID. The PurchaseRequesitionItemList contains information on
1/30/2023
purchase requisition items list.
MessageHeader Business Document Message Header PurchaseRequesitionStatusNoti cation_Out:

MessageHeader
PurchaseRequesitionHeader Purchase Requisition Header PurchaseRequesitionStatusNoti cation_Out:

PurchaseRequesitionHeader
PurchaseRequesitionItemList Purchase Requisition Items List PurchaseRequesitionStatusNoti cation_Out:

PurchaseRequesitionItemList
Prerequisites
Mapping of external system and a logical port must exist to provide communication of the external consumer via this service
with the SAP S/4HANA system. You must create a communication user, a communication system and set up a communication
arrangement. To do so, you can use the following applications:
Maintain Communication Users
Maintain Communication Systems
Communication Arrangements
Please note, that an administrator role must be assigned to your user to enable you to perform this con guration.

To be able to monitor messages transferred by this service, user with the Administrator role can use the Message Dashboard
app, that enables the administrator to analyze the root causes of errors, restart or cancel inbound messages.
 Note
You need to assign the following recipients to the user in the app Assign Recipients to Users rst:
For inbound SOAP service PurchaseRequisitionRequest_In:
Namespace: /MMPUR
Recipient Name: MMPUR_PREQN_IN
For outbound SOAP service PurchaseRequesitionStatusNotification_Out:
Namespace: /MMPUR
Recipient Name: MMPUR_PRSTATUSUPDOUT
PurchaseRequesitionStatusNoti cation_Out: MessageHeader
Parameters
1/30/2023
ID Noti cation ID. It is generated in the SAP S/4HANA system and has the length of 35
characters.
UUID Noti cation UUID. It is generated in the SAP S/4HANA system and has the length of
36 characters.
ReferenceID ID of the purchase requisition in the external system
CreationDateTime Date and time when the message has been created.
SenderBusinessSystemID ID of the SAP S/4HANA system
RecipientBusinessSystemID ID of the external system that receives the outbound message.
 Note
Chrome.
PurchaseRequesitionStatusNoti cation_Out:
PurchaseRequesitionHeader
Parameters
ID ID of the purchase requisition in the SAP S/4HANA system
ReferenceID ID of the document in the external system that is referenced by the

purchase requisition in the SAP S/4HANA system
 Note
Chrome.
PurchaseRequesitionStatusNoti cation_Out:
PurchaseRequesitionItemList
Parameters
ID ID of the purchase requisition item in the SAP

S/4HANA system
ReferenceID ID of the purchase requisition item in the external

system
1/30/2023
PurchaseRequesitionStatusList PurchaseRequesitionStatus: Each change of the elds BANPR, FGRZU,

MEMORY, MEMORYTYPE and LOEKZ is noted
PurchaseRequesitionStatusCode
down in this list, one entry per eld. Each entry
PurchaseRequesitionStatusType includes the STATUSCODE and the STATUSTYPE
of the eld change.
LastChangedDateTime Date and time of the last change of the purchase

requisition in the SAP S/4HANA system
 Note
Chrome.
Purchase Requisition – Send Replication Noti cations

Technical name: PurchaseRequisitionReplicationNotification_Out
This service enables you to send noti cations when a purchase requisition is replicated.
Service Structure

created
SenderBusinessSystemID ID of the connected system that sends the

message
RecipientBusinessSystemID ID of the external system that will receive

the message
Service Node: PurchaseRequisition
These service nodes contain the business data of the service.
Service Node Description
ID The ID of the purchase

requisition that the replication
noti cation is valid for
1/30/2023
ReplicationIsCompleted The indicator which tells the

purchase requisition replication
in the connected system is
completed or not.
True (Replication
successful)
False (Replication
failed)
SenderHubBusinessSystemID The ID of the SAP S/4HANA

Cloud hub system that sends
the message
Item
PurchaseRequestReference
ID The ID of the purchase

requisition that got successfully
replicated in the connected
system.
ItemID The ID of the purchase

requisition item that got
successfully replicated in the
connected system.
Service Node: Log
These service nodes contain the log data of the service.
BusinessDocumentProcessingResultCode
MaximumLogItemSeverityCode
Item
TypeID Unique identi cation of the

type of a log entry
CategoryCode
listID
listVersionID
listAgencyID
listAgencySchemeID
listAgencySchemeAgencyID
1/30/2023
SeverityCode Message type in the log:
S (Success)
E (Error)
W (Warning)
I (Info)
A (Abort)
ReferenceObjectNodeSenderTechnicalID
ReferenceMessageElementName
Note A short text for the log

message
NoteTemplateText
LogItemNotePlaceholderSubstitutionList
FirstPlaceholderID
SecondPlaceholderID
ThirdPlaceholderID
FourthPlaceholderID
FirstPlaceholderSubstitutionText
SecondPlaceholderSubstitutionText
ThirdPlaceholderSubstitutionText
FourthPlaceholderSubstitutionText
WebURI
Implementation
In SAP SOA Manager (SOAMANAGER), de ne the endpoint of the receiving system. To do this, con gure a logical port for
consumer proxy Invoice – Send Status Update Noti cations (InvoiceStatusUpdateNotification_Out).

SAP BusinessHub

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SAP BusinessHub

Uploaded by

Copyright:

Available Formats

1/30/2023

APIs for Sourcing and Procurement

SAP S/4HANA Cloud | 2302

Original content: https://help.sap.com/docs/SAP_S4HANA_CLOUD/bb9f1469daf04bd894ab2167f8132a1a?locale=en-

For more information, please visit the https://help.sap.com/docs/disclaimer.

Purchase Order (OData V2)

Create, update or delete purchase orders using this synchronous service.

The service supports the following purchase order item categories:

Purchase Order Item Category Internal Symbol* External Symbol**

Standard 0 ' ' (=blank)

Enhanced Limits (for materials or lean services) A E

The following actions are supported:

Single and Batch Mode

Single mode is supported for the following OData operations:

Single Request Operations

Entity OData Operations

POST PATCH DELETE

A_PurchaseOrder yes yes yes

A_PurchaseOrderNote yes yes yes

A_PurchaseOrderItem yes yes yes

A_PurchaseOrderItemNote yes yes yes

A_PurchaseOrderScheduleLine yes yes yes

A_POSubcontractingComponent yes yes yes

Entity OData Operations

POST PATCH DELETE

A_PurOrdAccountAssignment yes* yes** yes*

A_PurOrdPricingElement yes yes yes

Batch mode is supported for the following OData operations:

Entity OData Operations

POST PATCH DELETE

A_PurchaseOrder yes yes yes

A_PurchaseOrderNote yes yes yes

A_PurchaseOrderItem yes yes yes

A_PurchaseOrderItemNote yes yes yes

A_PurchaseOrderScheduleLine yes yes yes

A_POSubcontractingComponent yes yes yes

A_PurOrdAccountAssignment yes yes yes

A_PurOrdPricingElement yes yes yes

Service Message Header

The entities contain the business data of the service.

Entity Description Link to details

A_PurchaseOrder Header information for purchase order API_PURCHASEORDER_PROCESS_SRV -

Entity Description Link to details

A_PurchaseOrderItem Item information for purchase order API_PURCHASEORDER_PROCESS_SRV -

A_PurchaseOrderScheduleLine Schedule line information for purchase API_PURCHASEORDER_PROCESS_SRV-

A_POSubcontractingComponent Subcontracting component information for Subcontracting Components

A_PurOrdAccountAssignment Account assignment information for API_PURCHASEORDER_PROCESS_SRV -

A_PurOrdPricingElement Pricing information for purchase order API_PURCHASEORDER_PROCESS_SRV -

Determination of Default Values

You have entered a purchase order type that is not supported.

Choose purchase order type "Standard" ("NB") or a customer-

As a con guration expert, you can de ne custom purchase order

Do not change the default eld selection key.

Choose purchase order item category "Standard",

Maintain the required purchase order item category using the

Response(Failure) Self-explanatory detailed messages at the change set level with

More than 1000 purchase orders unless

5. Stock Transfer Order (STO) is not supported.

Authentication with Certi cate

Further information on how to in uence development can be found in 11 .

Operations for Purchase Order

Operation HTML Sample URL

Read GET GET <host>/sap/opu/odata/SAP/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder('4500100268')?$expa

Create POST POST <host>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/A_PurchaseOrder