PurchaseOrderService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultPurchaseOrderService

public interface PurchaseOrderService

Purchase Order.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PURCHASEORDER_PROCESS_SRV
API Version:	1
Communication Scenario:	Purchase Order Integration (SAP_COM_0053)
Scope Items:	Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45)

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.
`PurchaseOrderScheduleLineCreateFluentHelper`	`createPurchaseOrderScheduleLine(PurchaseOrderScheduleLine purchaseOrderScheduleLine)` Create a new `PurchaseOrderScheduleLine` entity and save it to the S/4HANA system.
`PurOrdAccountAssignmentCreateFluentHelper`	`createPurOrdAccountAssignment(PurOrdAccountAssignment purOrdAccountAssignment)` Create a new `PurOrdAccountAssignment` entity and save it to the S/4HANA system.
`PurOrdPricingElementCreateFluentHelper`	`createPurOrdPricingElement(PurOrdPricingElement purOrdPricingElement)` Create a new `PurOrdPricingElement` 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.
`PurchaseOrderScheduleLineDeleteFluentHelper`	`deletePurchaseOrderScheduleLine(PurchaseOrderScheduleLine purchaseOrderScheduleLine)` Deletes an existing `PurchaseOrderScheduleLine` entity in the S/4HANA system.
`PurOrdAccountAssignmentDeleteFluentHelper`	`deletePurOrdAccountAssignment(PurOrdAccountAssignment purOrdAccountAssignment)` Deletes an existing `PurOrdAccountAssignment` entity in the S/4HANA system.
`PurOrdPricingElementDeleteFluentHelper`	`deletePurOrdPricingElement(PurOrdPricingElement purOrdPricingElement)` Deletes an existing `PurOrdPricingElement` 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.
`PurOrdPricingElementUpdateFluentHelper`	`updatePurOrdPricingElement(PurOrdPricingElement purOrdPricingElement)` Update an existing `PurOrdPricingElement` entity and save it to the S/4HANA system.

- Method Detail
  - getAllPurchaseOrder
```
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
```
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
```
PurchaseOrderCreateFluentHelper createPurchaseOrder(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
```
PurchaseOrderUpdateFluentHelper updatePurchaseOrder(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
```
PurchaseOrderDeleteFluentHelper deletePurchaseOrder(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
```
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
```
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
```
PurchaseOrderItemCreateFluentHelper createPurchaseOrderItem(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
```
PurchaseOrderItemUpdateFluentHelper updatePurchaseOrderItem(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
```
PurchaseOrderItemDeleteFluentHelper deletePurchaseOrderItem(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
```
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
```
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.
  - createPurchaseOrderScheduleLine
```
PurchaseOrderScheduleLineCreateFluentHelper createPurchaseOrderScheduleLine(PurchaseOrderScheduleLine purchaseOrderScheduleLine)
```
    Create a new PurchaseOrderScheduleLine entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseOrderScheduleLine - PurchaseOrderScheduleLine entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurchaseOrderScheduleLine entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurchaseOrderScheduleLine
```
PurchaseOrderScheduleLineUpdateFluentHelper updatePurchaseOrderScheduleLine(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.
  - deletePurchaseOrderScheduleLine
```
PurchaseOrderScheduleLineDeleteFluentHelper deletePurchaseOrderScheduleLine(PurchaseOrderScheduleLine purchaseOrderScheduleLine)
```
    Deletes an existing PurchaseOrderScheduleLine entity in the S/4HANA system.
    
    Parameters:
    
    purchaseOrderScheduleLine - PurchaseOrderScheduleLine entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PurchaseOrderScheduleLine entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurOrdAccountAssignment
```
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
```
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.
  - createPurOrdAccountAssignment
```
PurOrdAccountAssignmentCreateFluentHelper createPurOrdAccountAssignment(PurOrdAccountAssignment purOrdAccountAssignment)
```
    Create a new PurOrdAccountAssignment entity and save it to the S/4HANA system.
    
    Parameters:
    
    purOrdAccountAssignment - PurOrdAccountAssignment entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurOrdAccountAssignment entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurOrdAccountAssignment
```
PurOrdAccountAssignmentUpdateFluentHelper updatePurOrdAccountAssignment(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.
  - deletePurOrdAccountAssignment
```
PurOrdAccountAssignmentDeleteFluentHelper deletePurOrdAccountAssignment(PurOrdAccountAssignment purOrdAccountAssignment)
```
    Deletes an existing PurOrdAccountAssignment entity in the S/4HANA system.
    
    Parameters:
    
    purOrdAccountAssignment - PurOrdAccountAssignment entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PurOrdAccountAssignment entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurOrdPricingElement
```
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
```
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.
  - createPurOrdPricingElement
```
PurOrdPricingElementCreateFluentHelper createPurOrdPricingElement(PurOrdPricingElement purOrdPricingElement)
```
    Create a new PurOrdPricingElement entity and save it to the S/4HANA system.
    
    Parameters:
    
    purOrdPricingElement - PurOrdPricingElement entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurOrdPricingElement entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurOrdPricingElement
```
PurOrdPricingElementUpdateFluentHelper updatePurOrdPricingElement(PurOrdPricingElement purOrdPricingElement)
```
    Update an existing PurOrdPricingElement entity and save it to the S/4HANA system.
    
    Parameters:
    
    purOrdPricingElement - PurOrdPricingElement entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurOrdPricingElement entity. To perform execution, call the execute method on the fluent helper object.
  - deletePurOrdPricingElement
```
PurOrdPricingElementDeleteFluentHelper deletePurOrdPricingElement(PurOrdPricingElement purOrdPricingElement)
```
    Deletes an existing PurOrdPricingElement entity in the S/4HANA system.
    
    Parameters:
    
    purOrdPricingElement - PurOrdPricingElement entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PurOrdPricingElement entity. To perform execution, call the execute method on the fluent helper object.

Interface PurchaseOrderService

Details:

Method Summary

Method Detail

getAllPurchaseOrder

getPurchaseOrderByKey

createPurchaseOrder

updatePurchaseOrder

deletePurchaseOrder

getAllPurchaseOrderItem

getPurchaseOrderItemByKey

createPurchaseOrderItem

updatePurchaseOrderItem

deletePurchaseOrderItem

getAllPurchaseOrderScheduleLine

getPurchaseOrderScheduleLineByKey

createPurchaseOrderScheduleLine

updatePurchaseOrderScheduleLine

deletePurchaseOrderScheduleLine

getAllPurOrdAccountAssignment

getPurOrdAccountAssignmentByKey

createPurOrdAccountAssignment

updatePurOrdAccountAssignment

deletePurOrdAccountAssignment

getAllPurOrdPricingElement

getPurOrdPricingElementByKey

createPurOrdPricingElement

updatePurOrdPricingElement

deletePurOrdPricingElement