PurchaseOrderService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultPurchaseOrderService

public interface PurchaseOrderService

This synchronous inbound service enables you to create, update, and delete purchase orders with the data provided in a payload. It is based on the OData protocol and can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PURCHASEORDER_PROCESS_SRV
API Version:	1
Communication Scenario:	Distributed Manufacturing Integration (SAP_COM_0077), Purchase Order Integration (SAP_COM_0053)
Scope Items:	Integration with SAP Distributed Manufacturing with SAP S/4HANA Cloud (1NX), Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45)
Authentication Methods:	Basic, x509
Business Object:	PurchaseOrder

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_SERVICE_PATH` If no other path was provided via the `withServicePath(String)` method, this is the default service path used to access the endpoint.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PurchaseOrderCreateFluentHelper`	`createPurchaseOrder(PurchaseOrder purchaseOrder)` Create a new `PurchaseOrder` entity and save it to the S/4HANA system.
`PurchaseOrderItemCreateFluentHelper`	`createPurchaseOrderItem(PurchaseOrderItem purchaseOrderItem)` Create a new `PurchaseOrderItem` entity and save it to the S/4HANA system.
`PurchaseOrderDeleteFluentHelper`	`deletePurchaseOrder(PurchaseOrder purchaseOrder)` Deletes an existing `PurchaseOrder` entity in the S/4HANA system.
`PurchaseOrderItemDeleteFluentHelper`	`deletePurchaseOrderItem(PurchaseOrderItem purchaseOrderItem)` Deletes an existing `PurchaseOrderItem` entity in the S/4HANA system.
`PurchaseOrderFluentHelper`	`getAllPurchaseOrder()` Fetch multiple `PurchaseOrder` entities.
`PurchaseOrderItemFluentHelper`	`getAllPurchaseOrderItem()` Fetch multiple `PurchaseOrderItem` entities.
`PurchaseOrderScheduleLineFluentHelper`	`getAllPurchaseOrderScheduleLine()` Fetch multiple `PurchaseOrderScheduleLine` entities.
`PurOrdAccountAssignmentFluentHelper`	`getAllPurOrdAccountAssignment()` Fetch multiple `PurOrdAccountAssignment` entities.
`PurOrdPricingElementFluentHelper`	`getAllPurOrdPricingElement()` Fetch multiple `PurOrdPricingElement` entities.
`PurchaseOrderByKeyFluentHelper`	`getPurchaseOrderByKey(String purchaseOrder)` Fetch a single `PurchaseOrder` entity using key fields.
`PurchaseOrderItemByKeyFluentHelper`	`getPurchaseOrderItemByKey(String purchaseOrder, String purchaseOrderItem)` Fetch a single `PurchaseOrderItem` entity using key fields.
`PurchaseOrderScheduleLineByKeyFluentHelper`	`getPurchaseOrderScheduleLineByKey(String purchasingDocument, String purchasingDocumentItem, String scheduleLine)` Fetch a single `PurchaseOrderScheduleLine` entity using key fields.
`PurOrdAccountAssignmentByKeyFluentHelper`	`getPurOrdAccountAssignmentByKey(String purchaseOrder, String purchaseOrderItem, String accountAssignmentNumber)` Fetch a single `PurOrdAccountAssignment` entity using key fields.
`PurOrdPricingElementByKeyFluentHelper`	`getPurOrdPricingElementByKey(String purchaseOrder, String purchaseOrderItem, String pricingDocument, String pricingDocumentItem, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `PurOrdPricingElement` entity using key fields.
`PurchaseOrderUpdateFluentHelper`	`updatePurchaseOrder(PurchaseOrder purchaseOrder)` Update an existing `PurchaseOrder` entity and save it to the S/4HANA system.
`PurchaseOrderItemUpdateFluentHelper`	`updatePurchaseOrderItem(PurchaseOrderItem purchaseOrderItem)` Update an existing `PurchaseOrderItem` entity and save it to the S/4HANA system.
`PurchaseOrderScheduleLineUpdateFluentHelper`	`updatePurchaseOrderScheduleLine(PurchaseOrderScheduleLine purchaseOrderScheduleLine)` Update an existing `PurchaseOrderScheduleLine` entity and save it to the S/4HANA system.
`PurOrdAccountAssignmentUpdateFluentHelper`	`updatePurOrdAccountAssignment(PurOrdAccountAssignment purOrdAccountAssignment)` Update an existing `PurOrdAccountAssignment` entity and save it to the S/4HANA system.
`PurchaseOrderService`	`withServicePath(String servicePath)` Overrides the default service path and returns a new service instance with the specified service path.

- Field Detail
  - DEFAULT_SERVICE_PATH
```
static final String DEFAULT_SERVICE_PATH
```
    If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - withServicePath
```
@Nonnull
PurchaseOrderService withServicePath(@Nonnull
                                              String servicePath)
```
    Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
    
    Parameters:
    
    servicePath - Service path that will override the default.
    
    Returns:
    
    A new service instance with the specified service path.
  - getAllPurchaseOrder
```
@Nonnull
PurchaseOrderFluentHelper getAllPurchaseOrder()
```
    Fetch multiple PurchaseOrder entities.
    
    Returns:
    
    A fluent helper to fetch multiple PurchaseOrder entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getPurchaseOrderByKey
```
@Nonnull
PurchaseOrderByKeyFluentHelper getPurchaseOrderByKey(String purchaseOrder)
```
    Fetch a single PurchaseOrder entity using key fields.
    
    Parameters:
    
    purchaseOrder - Purchase Order Number
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single PurchaseOrder entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - createPurchaseOrder
```
@Nonnull
PurchaseOrderCreateFluentHelper createPurchaseOrder(@Nonnull
                                                             PurchaseOrder purchaseOrder)
```
    Create a new PurchaseOrder entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseOrder - PurchaseOrder entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurchaseOrder entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurchaseOrder
```
@Nonnull
PurchaseOrderUpdateFluentHelper updatePurchaseOrder(@Nonnull
                                                             PurchaseOrder purchaseOrder)
```
    Update an existing PurchaseOrder entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseOrder - PurchaseOrder entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurchaseOrder entity. To perform execution, call the execute method on the fluent helper object.
  - deletePurchaseOrder
```
@Nonnull
PurchaseOrderDeleteFluentHelper deletePurchaseOrder(@Nonnull
                                                             PurchaseOrder purchaseOrder)
```
    Deletes an existing PurchaseOrder entity in the S/4HANA system.
    
    Parameters:
    
    purchaseOrder - PurchaseOrder entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PurchaseOrder entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurchaseOrderItem
```
@Nonnull
PurchaseOrderItemFluentHelper getAllPurchaseOrderItem()
```
    Fetch multiple PurchaseOrderItem entities.
    
    Returns:
    
    A fluent helper to fetch multiple PurchaseOrderItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getPurchaseOrderItemByKey
```
@Nonnull
PurchaseOrderItemByKeyFluentHelper getPurchaseOrderItemByKey(String purchaseOrder,
                                                                      String purchaseOrderItem)
```
    Fetch a single PurchaseOrderItem entity using key fields.
    
    Parameters:
    
    purchaseOrder - Alphanumeric key uniquely identifying the document.
    Constraints: Not nullable, Maximum length: 10
    
    purchaseOrderItem - Item Number of Purchase Order
    Constraints: Not nullable, Maximum length: 5
    
    Returns:
    
    A fluent helper to fetch a single PurchaseOrderItem entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - createPurchaseOrderItem
```
@Nonnull
PurchaseOrderItemCreateFluentHelper createPurchaseOrderItem(@Nonnull
                                                                     PurchaseOrderItem purchaseOrderItem)
```
    Create a new PurchaseOrderItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseOrderItem - PurchaseOrderItem entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurchaseOrderItem entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurchaseOrderItem
```
@Nonnull
PurchaseOrderItemUpdateFluentHelper updatePurchaseOrderItem(@Nonnull
                                                                     PurchaseOrderItem purchaseOrderItem)
```
    Update an existing PurchaseOrderItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseOrderItem - PurchaseOrderItem entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurchaseOrderItem entity. To perform execution, call the execute method on the fluent helper object.
  - deletePurchaseOrderItem
```
@Nonnull
PurchaseOrderItemDeleteFluentHelper deletePurchaseOrderItem(@Nonnull
                                                                     PurchaseOrderItem purchaseOrderItem)
```
    Deletes an existing PurchaseOrderItem entity in the S/4HANA system.
    
    Parameters:
    
    purchaseOrderItem - PurchaseOrderItem entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PurchaseOrderItem entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurchaseOrderScheduleLine
```
@Nonnull
PurchaseOrderScheduleLineFluentHelper getAllPurchaseOrderScheduleLine()
```
    Fetch multiple PurchaseOrderScheduleLine entities.
    
    Returns:
    
    A fluent helper to fetch multiple PurchaseOrderScheduleLine entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getPurchaseOrderScheduleLineByKey
```
@Nonnull
PurchaseOrderScheduleLineByKeyFluentHelper getPurchaseOrderScheduleLineByKey(String purchasingDocument,
                                                                                      String purchasingDocumentItem,
                                                                                      String scheduleLine)
```
    Fetch a single PurchaseOrderScheduleLine entity using key fields.
    
    Parameters:
    
    purchasingDocument - Alphanumeric key uniquely identifying the document.
    Constraints: Not nullable, Maximum length: 10
    
    scheduleLine - Alphanumeric key uniquely identifying the document.
    Constraints: Not nullable, Maximum length: 4
    
    purchasingDocumentItem - Specifies the number that uniquely identifies an item in .
    Constraints: Not nullable, Maximum length: 5
    
    Returns:
    
    A fluent helper to fetch a single PurchaseOrderScheduleLine entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - updatePurchaseOrderScheduleLine
```
@Nonnull
PurchaseOrderScheduleLineUpdateFluentHelper updatePurchaseOrderScheduleLine(@Nonnull
                                                                                     PurchaseOrderScheduleLine purchaseOrderScheduleLine)
```
    Update an existing PurchaseOrderScheduleLine entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseOrderScheduleLine - PurchaseOrderScheduleLine entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurchaseOrderScheduleLine entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurOrdAccountAssignment
```
@Nonnull
PurOrdAccountAssignmentFluentHelper getAllPurOrdAccountAssignment()
```
    Fetch multiple PurOrdAccountAssignment entities.
    
    Returns:
    
    A fluent helper to fetch multiple PurOrdAccountAssignment entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getPurOrdAccountAssignmentByKey
```
@Nonnull
PurOrdAccountAssignmentByKeyFluentHelper getPurOrdAccountAssignmentByKey(String purchaseOrder,
                                                                                  String purchaseOrderItem,
                                                                                  String accountAssignmentNumber)
```
    Fetch a single PurOrdAccountAssignment entity using key fields.
    
    Parameters:
    
    purchaseOrder - Alphanumeric key uniquely identifying the document.
    Constraints: Not nullable, Maximum length: 10
    
    accountAssignmentNumber - Number uniquely defining the account assignment of a purchase document item.
    Constraints: Not nullable, Maximum length: 2
    
    purchaseOrderItem - Specifies the number that uniquely identifies an item in .
    Constraints: Not nullable, Maximum length: 5
    
    Returns:
    
    A fluent helper to fetch a single PurOrdAccountAssignment entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - updatePurOrdAccountAssignment
```
@Nonnull
PurOrdAccountAssignmentUpdateFluentHelper updatePurOrdAccountAssignment(@Nonnull
                                                                                 PurOrdAccountAssignment purOrdAccountAssignment)
```
    Update an existing PurOrdAccountAssignment entity and save it to the S/4HANA system.
    
    Parameters:
    
    purOrdAccountAssignment - PurOrdAccountAssignment entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurOrdAccountAssignment entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurOrdPricingElement
```
@Nonnull
PurOrdPricingElementFluentHelper getAllPurOrdPricingElement()
```
    Fetch multiple PurOrdPricingElement entities.
    
    Returns:
    
    A fluent helper to fetch multiple PurOrdPricingElement entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getPurOrdPricingElementByKey
```
@Nonnull
PurOrdPricingElementByKeyFluentHelper getPurOrdPricingElementByKey(String purchaseOrder,
                                                                            String purchaseOrderItem,
                                                                            String pricingDocument,
                                                                            String pricingDocumentItem,
                                                                            String pricingProcedureStep,
                                                                            String pricingProcedureCounter)
```
    Fetch a single PurOrdPricingElement entity using key fields.
    
    Parameters:
    
    pricingDocumentItem - The number that uniquely identifies the condition item.
    Constraints: Not nullable, Maximum length: 6
    
    pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.
    Constraints: Not nullable, Maximum length: 3
    
    purchaseOrder - Alphanumeric key uniquely identifying the document.
    Constraints: Not nullable, Maximum length: 10
    
    purchaseOrderItem - Specifies the number that uniquely identifies an item in .
    Constraints: Not nullable, Maximum length: 5
    
    pricingProcedureStep - Number that determines the sequence of the condition within a procedure.
    Constraints: Not nullable, Maximum length: 3
    
    pricingDocument - The internal number under which the system saves conditions that apply to a sales order, for example.
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single PurOrdPricingElement entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

Interface PurchaseOrderService

Details:

Field Summary

Method Summary

Field Detail

DEFAULT_SERVICE_PATH

Method Detail

withServicePath

getAllPurchaseOrder

getPurchaseOrderByKey

createPurchaseOrder

updatePurchaseOrder

deletePurchaseOrder

getAllPurchaseOrderItem

getPurchaseOrderItemByKey

createPurchaseOrderItem

updatePurchaseOrderItem

deletePurchaseOrderItem

getAllPurchaseOrderScheduleLine

getPurchaseOrderScheduleLineByKey

updatePurchaseOrderScheduleLine

getAllPurOrdAccountAssignment

getPurOrdAccountAssignmentByKey

updatePurOrdAccountAssignment

getAllPurOrdPricingElement

getPurOrdPricingElementByKey