PurchaseRequisitionService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultPurchaseRequisitionService

public interface PurchaseRequisitionService

This service enables you to create purchase requisitions through an API call from a source system outside SAP S/4HANA Cloud or SAP S/4HANA on- Premise. Furthermore, the service enables you to read, update and delete existing purchase requisition data from the SAP S/4HANA Cloud or SAP S/4HANA on- Premise system.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PURCHASEREQ_PROCESS_SRV
API Version:	1
Communication Scenario:	Purchase Requisition Integration (SAP_COM_0102)
Scope Items:	Returnables Processing - Intercompany (18J), Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45)

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
`PurchaseRequisitionHeaderCreateFluentHelper`	`createPurchaseRequisitionHeader(PurchaseRequisitionHeader purchaseRequisitionHeader)` Create a new `PurchaseRequisitionHeader` entity and save it to the S/4HANA system.
`PurchaseRequisitionItemCreateFluentHelper`	`createPurchaseRequisitionItem(PurchaseRequisitionItem purchaseRequisitionItem)` Create a new `PurchaseRequisitionItem` entity and save it to the S/4HANA system.
`PurReqAddDeliveryCreateFluentHelper`	`createPurReqAddDelivery(PurReqAddDelivery purReqAddDelivery)` Create a new `PurReqAddDelivery` entity and save it to the S/4HANA system.
`PurReqnAcctAssgmtCreateFluentHelper`	`createPurReqnAcctAssgmt(PurReqnAcctAssgmt purReqnAcctAssgmt)` Create a new `PurReqnAcctAssgmt` entity and save it to the S/4HANA system.
`PurchaseRequisitionHeaderDeleteFluentHelper`	`deletePurchaseRequisitionHeader(PurchaseRequisitionHeader purchaseRequisitionHeader)` Deletes an existing `PurchaseRequisitionHeader` entity in the S/4HANA system.
`PurchaseRequisitionItemDeleteFluentHelper`	`deletePurchaseRequisitionItem(PurchaseRequisitionItem purchaseRequisitionItem)` Deletes an existing `PurchaseRequisitionItem` entity in the S/4HANA system.
`PurReqAddDeliveryDeleteFluentHelper`	`deletePurReqAddDelivery(PurReqAddDelivery purReqAddDelivery)` Deletes an existing `PurReqAddDelivery` entity in the S/4HANA system.
`PurReqnAcctAssgmtDeleteFluentHelper`	`deletePurReqnAcctAssgmt(PurReqnAcctAssgmt purReqnAcctAssgmt)` Deletes an existing `PurReqnAcctAssgmt` entity in the S/4HANA system.
`PurchaseRequisitionHeaderFluentHelper`	`getAllPurchaseRequisitionHeader()` Fetch multiple `PurchaseRequisitionHeader` entities.
`PurchaseRequisitionItemFluentHelper`	`getAllPurchaseRequisitionItem()` Fetch multiple `PurchaseRequisitionItem` entities.
`PurReqAddDeliveryFluentHelper`	`getAllPurReqAddDelivery()` Fetch multiple `PurReqAddDelivery` entities.
`PurReqnAcctAssgmtFluentHelper`	`getAllPurReqnAcctAssgmt()` Fetch multiple `PurReqnAcctAssgmt` entities.
`PurchaseRequisitionHeaderByKeyFluentHelper`	`getPurchaseRequisitionHeaderByKey(String purchaseRequisition)` Fetch a single `PurchaseRequisitionHeader` entity using key fields.
`PurchaseRequisitionItemByKeyFluentHelper`	`getPurchaseRequisitionItemByKey(String purchaseRequisition, String purchaseRequisitionItem)` Fetch a single `PurchaseRequisitionItem` entity using key fields.
`PurReqAddDeliveryByKeyFluentHelper`	`getPurReqAddDeliveryByKey(String purchaseRequisition, String purchaseRequisitionItem)` Fetch a single `PurReqAddDelivery` entity using key fields.
`PurReqnAcctAssgmtByKeyFluentHelper`	`getPurReqnAcctAssgmtByKey(String purchaseRequisition, String purchaseRequisitionItem, String purchaseReqnAcctAssgmtNumber)` Fetch a single `PurReqnAcctAssgmt` entity using key fields.
`PurchaseRequisitionHeaderUpdateFluentHelper`	`updatePurchaseRequisitionHeader(PurchaseRequisitionHeader purchaseRequisitionHeader)` Update an existing `PurchaseRequisitionHeader` entity and save it to the S/4HANA system.
`PurchaseRequisitionItemUpdateFluentHelper`	`updatePurchaseRequisitionItem(PurchaseRequisitionItem purchaseRequisitionItem)` Update an existing `PurchaseRequisitionItem` entity and save it to the S/4HANA system.
`PurReqAddDeliveryUpdateFluentHelper`	`updatePurReqAddDelivery(PurReqAddDelivery purReqAddDelivery)` Update an existing `PurReqAddDelivery` entity and save it to the S/4HANA system.
`PurReqnAcctAssgmtUpdateFluentHelper`	`updatePurReqnAcctAssgmt(PurReqnAcctAssgmt purReqnAcctAssgmt)` Update an existing `PurReqnAcctAssgmt` entity and save it to the S/4HANA system.
`PurchaseRequisitionService`	`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
```
PurchaseRequisitionService 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
  - getAllPurReqAddDelivery
```
@Nonnull
PurReqAddDeliveryFluentHelper getAllPurReqAddDelivery()
```
    Fetch multiple PurReqAddDelivery entities.
    
    Returns:
    
    A fluent helper to fetch multiple PurReqAddDelivery 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.
  - getPurReqAddDeliveryByKey
```
@Nonnull
PurReqAddDeliveryByKeyFluentHelper getPurReqAddDeliveryByKey(String purchaseRequisition,
                                                                      String purchaseRequisitionItem)
```
    Fetch a single PurReqAddDelivery entity using key fields.
    
    Parameters:
    
    purchaseRequisitionItem - Item number of purchase requisition
    Constraints: Not nullable, Maximum length: 5
    
    purchaseRequisition - Purchase requisition number
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single PurReqAddDelivery 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.
  - createPurReqAddDelivery
```
@Nonnull
PurReqAddDeliveryCreateFluentHelper createPurReqAddDelivery(@Nonnull
                                                                     PurReqAddDelivery purReqAddDelivery)
```
    Create a new PurReqAddDelivery entity and save it to the S/4HANA system.
    
    Parameters:
    
    purReqAddDelivery - PurReqAddDelivery entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurReqAddDelivery entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurReqAddDelivery
```
@Nonnull
PurReqAddDeliveryUpdateFluentHelper updatePurReqAddDelivery(@Nonnull
                                                                     PurReqAddDelivery purReqAddDelivery)
```
    Update an existing PurReqAddDelivery entity and save it to the S/4HANA system.
    
    Parameters:
    
    purReqAddDelivery - PurReqAddDelivery entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurReqAddDelivery entity. To perform execution, call the execute method on the fluent helper object.
  - deletePurReqAddDelivery
```
@Nonnull
PurReqAddDeliveryDeleteFluentHelper deletePurReqAddDelivery(@Nonnull
                                                                     PurReqAddDelivery purReqAddDelivery)
```
    Deletes an existing PurReqAddDelivery entity in the S/4HANA system.
    
    Parameters:
    
    purReqAddDelivery - PurReqAddDelivery entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PurReqAddDelivery entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurReqnAcctAssgmt
```
@Nonnull
PurReqnAcctAssgmtFluentHelper getAllPurReqnAcctAssgmt()
```
    Fetch multiple PurReqnAcctAssgmt entities.
    
    Returns:
    
    A fluent helper to fetch multiple PurReqnAcctAssgmt 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.
  - getPurReqnAcctAssgmtByKey
```
@Nonnull
PurReqnAcctAssgmtByKeyFluentHelper getPurReqnAcctAssgmtByKey(String purchaseRequisition,
                                                                      String purchaseRequisitionItem,
                                                                      String purchaseReqnAcctAssgmtNumber)
```
    Fetch a single PurReqnAcctAssgmt entity using key fields.
    
    Parameters:
    
    purchaseRequisitionItem - Item Number of Purchase Requisition
    Constraints: Not nullable, Maximum length: 5
    
    purchaseRequisition - Purchase Requisition Number
    Constraints: Not nullable, Maximum length: 10
    
    purchaseReqnAcctAssgmtNumber - Serial number for PReq account assignment segment
    Constraints: Not nullable, Maximum length: 2
    
    Returns:
    
    A fluent helper to fetch a single PurReqnAcctAssgmt 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.
  - createPurReqnAcctAssgmt
```
@Nonnull
PurReqnAcctAssgmtCreateFluentHelper createPurReqnAcctAssgmt(@Nonnull
                                                                     PurReqnAcctAssgmt purReqnAcctAssgmt)
```
    Create a new PurReqnAcctAssgmt entity and save it to the S/4HANA system.
    
    Parameters:
    
    purReqnAcctAssgmt - PurReqnAcctAssgmt entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurReqnAcctAssgmt entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurReqnAcctAssgmt
```
@Nonnull
PurReqnAcctAssgmtUpdateFluentHelper updatePurReqnAcctAssgmt(@Nonnull
                                                                     PurReqnAcctAssgmt purReqnAcctAssgmt)
```
    Update an existing PurReqnAcctAssgmt entity and save it to the S/4HANA system.
    
    Parameters:
    
    purReqnAcctAssgmt - PurReqnAcctAssgmt entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurReqnAcctAssgmt entity. To perform execution, call the execute method on the fluent helper object.
  - deletePurReqnAcctAssgmt
```
@Nonnull
PurReqnAcctAssgmtDeleteFluentHelper deletePurReqnAcctAssgmt(@Nonnull
                                                                     PurReqnAcctAssgmt purReqnAcctAssgmt)
```
    Deletes an existing PurReqnAcctAssgmt entity in the S/4HANA system.
    
    Parameters:
    
    purReqnAcctAssgmt - PurReqnAcctAssgmt entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PurReqnAcctAssgmt entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurchaseRequisitionHeader
```
@Nonnull
PurchaseRequisitionHeaderFluentHelper getAllPurchaseRequisitionHeader()
```
    Fetch multiple PurchaseRequisitionHeader entities.
    
    Returns:
    
    A fluent helper to fetch multiple PurchaseRequisitionHeader 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.
  - getPurchaseRequisitionHeaderByKey
```
@Nonnull
PurchaseRequisitionHeaderByKeyFluentHelper getPurchaseRequisitionHeaderByKey(String purchaseRequisition)
```
    Fetch a single PurchaseRequisitionHeader entity using key fields.
    
    Parameters:
    
    purchaseRequisition - Purchase requisition number
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single PurchaseRequisitionHeader 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.
  - createPurchaseRequisitionHeader
```
@Nonnull
PurchaseRequisitionHeaderCreateFluentHelper createPurchaseRequisitionHeader(@Nonnull
                                                                                     PurchaseRequisitionHeader purchaseRequisitionHeader)
```
    Create a new PurchaseRequisitionHeader entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseRequisitionHeader - PurchaseRequisitionHeader entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurchaseRequisitionHeader entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurchaseRequisitionHeader
```
@Nonnull
PurchaseRequisitionHeaderUpdateFluentHelper updatePurchaseRequisitionHeader(@Nonnull
                                                                                     PurchaseRequisitionHeader purchaseRequisitionHeader)
```
    Update an existing PurchaseRequisitionHeader entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseRequisitionHeader - PurchaseRequisitionHeader entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurchaseRequisitionHeader entity. To perform execution, call the execute method on the fluent helper object.
  - deletePurchaseRequisitionHeader
```
@Nonnull
PurchaseRequisitionHeaderDeleteFluentHelper deletePurchaseRequisitionHeader(@Nonnull
                                                                                     PurchaseRequisitionHeader purchaseRequisitionHeader)
```
    Deletes an existing PurchaseRequisitionHeader entity in the S/4HANA system.
    
    Parameters:
    
    purchaseRequisitionHeader - PurchaseRequisitionHeader entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PurchaseRequisitionHeader entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurchaseRequisitionItem
```
@Nonnull
PurchaseRequisitionItemFluentHelper getAllPurchaseRequisitionItem()
```
    Fetch multiple PurchaseRequisitionItem entities.
    
    Returns:
    
    A fluent helper to fetch multiple PurchaseRequisitionItem 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.
  - getPurchaseRequisitionItemByKey
```
@Nonnull
PurchaseRequisitionItemByKeyFluentHelper getPurchaseRequisitionItemByKey(String purchaseRequisition,
                                                                                  String purchaseRequisitionItem)
```
    Fetch a single PurchaseRequisitionItem entity using key fields.
    
    Parameters:
    
    purchaseRequisitionItem - Item number of purchase requisition
    Constraints: Not nullable, Maximum length: 5
    
    purchaseRequisition - Purchase requisition number
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single PurchaseRequisitionItem 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.
  - createPurchaseRequisitionItem
```
@Nonnull
PurchaseRequisitionItemCreateFluentHelper createPurchaseRequisitionItem(@Nonnull
                                                                                 PurchaseRequisitionItem purchaseRequisitionItem)
```
    Create a new PurchaseRequisitionItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseRequisitionItem - PurchaseRequisitionItem entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurchaseRequisitionItem entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurchaseRequisitionItem
```
@Nonnull
PurchaseRequisitionItemUpdateFluentHelper updatePurchaseRequisitionItem(@Nonnull
                                                                                 PurchaseRequisitionItem purchaseRequisitionItem)
```
    Update an existing PurchaseRequisitionItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    purchaseRequisitionItem - PurchaseRequisitionItem entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurchaseRequisitionItem entity. To perform execution, call the execute method on the fluent helper object.
  - deletePurchaseRequisitionItem
```
@Nonnull
PurchaseRequisitionItemDeleteFluentHelper deletePurchaseRequisitionItem(@Nonnull
                                                                                 PurchaseRequisitionItem purchaseRequisitionItem)
```
    Deletes an existing PurchaseRequisitionItem entity in the S/4HANA system.
    
    Parameters:
    
    purchaseRequisitionItem - PurchaseRequisitionItem entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PurchaseRequisitionItem entity. To perform execution, call the execute method on the fluent helper object.

Interface PurchaseRequisitionService

Details:

Field Summary

Method Summary

Field Detail

DEFAULT_SERVICE_PATH

Method Detail

withServicePath

getAllPurReqAddDelivery

getPurReqAddDeliveryByKey

createPurReqAddDelivery

updatePurReqAddDelivery

deletePurReqAddDelivery

getAllPurReqnAcctAssgmt

getPurReqnAcctAssgmtByKey

createPurReqnAcctAssgmt

updatePurReqnAcctAssgmt

deletePurReqnAcctAssgmt

getAllPurchaseRequisitionHeader

getPurchaseRequisitionHeaderByKey

createPurchaseRequisitionHeader

updatePurchaseRequisitionHeader

deletePurchaseRequisitionHeader

getAllPurchaseRequisitionItem

getPurchaseRequisitionItemByKey

createPurchaseRequisitionItem

updatePurchaseRequisitionItem

deletePurchaseRequisitionItem