com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services

Interface PurchaseRequisitionService

All Superinterfaces:

BatchService<PurchaseRequisitionServiceBatch>

All Known Implementing Classes:

DefaultPurchaseRequisitionService

public interface PurchaseRequisitionService
extends BatchService<PurchaseRequisitionServiceBatch>

This service helps you to create, read, update and delete purchase requisitions through an API call from a source system outside SAP S/4HANA. The service contains header, item, account assignment, delivery address, and item text nodes. The information is sent in the request as a payload. The information is used when creating, reading or updating a purchase requisition, with appropriate checks for restricted values and authorizations. Note: Certain elements can only be used if you activate the business function ISR_RETAILSYSTEM. For more information, see Business Documentation. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_PURCHASEREQ_PROCESS_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Purchase Requisition

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

Modifier and Type	Method and Description
PurchaseReqnItemTextCreateFluentHelper	createPurchaseReqnItemText(PurchaseReqnItemText purchaseReqnItemText) Create a new PurchaseReqnItemText entity and save it to the S/4HANA system.
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.
PurReqnAcctAssgmtCreateFluentHelper	createPurReqnAcctAssgmt(PurReqnAcctAssgmt purReqnAcctAssgmt) Create a new PurReqnAcctAssgmt entity and save it to the S/4HANA system.
PurchaseReqnItemTextDeleteFluentHelper	deletePurchaseReqnItemText(PurchaseReqnItemText purchaseReqnItemText) Deletes an existing PurchaseReqnItemText entity in the S/4HANA system.
DiscardFromPurchasingFluentHelper	discardFromPurchasing(String purchaseRequisitionItem, String purchaseRequisition) Creates a fluent helper for the DiscardFromPurchasing OData function import.
EnableForPurchasingFluentHelper	enableForPurchasing(String purchaseRequisitionItem, String purchaseRequisition) Creates a fluent helper for the EnableForPurchasing OData function import.
PurchaseReqnItemTextFluentHelper	getAllPurchaseReqnItemText() Fetch multiple PurchaseReqnItemText entities.
PurchaseRequisitionHeaderFluentHelper	getAllPurchaseRequisitionHeader() Fetch multiple PurchaseRequisitionHeader entities.
PurchaseRequisitionItemFluentHelper	getAllPurchaseRequisitionItem() Fetch multiple PurchaseRequisitionItem entities.
PurReqAddDeliveryFluentHelper	getAllPurReqAddDelivery() Fetch multiple PurReqAddDelivery entities.
PurReqnAcctAssgmtFluentHelper	getAllPurReqnAcctAssgmt() Fetch multiple PurReqnAcctAssgmt entities.
PurchaseReqnItemTextByKeyFluentHelper	getPurchaseReqnItemTextByKey(String purchaseRequisition, String purchaseRequisitionItem, String documentText, String technicalObjectType, String language) Fetch a single PurchaseReqnItemText entity using key fields.
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.
PurchaseReqnItemTextUpdateFluentHelper	updatePurchaseReqnItemText(PurchaseReqnItemText purchaseReqnItemText) Update an existing PurchaseReqnItemText entity and save it to the S/4HANA system.
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.
ValidateFluentHelper	validate(String purchaseRequisition) Creates a fluent helper for the Validate OData function import.
PurchaseRequisitionService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

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
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.

getAllPurchaseReqnItemText

@Nonnull
PurchaseReqnItemTextFluentHelper getAllPurchaseReqnItemText()

Fetch multiple PurchaseReqnItemText entities.

Returns:

A fluent helper to fetch multiple PurchaseReqnItemText 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.

getPurchaseReqnItemTextByKey

@Nonnull
PurchaseReqnItemTextByKeyFluentHelper getPurchaseReqnItemTextByKey(String purchaseRequisition,
                                                                            String purchaseRequisitionItem,
                                                                            String documentText,
                                                                            String technicalObjectType,
                                                                            String language)

Fetch a single PurchaseReqnItemText entity using key fields.

Parameters:

technicalObjectType - Texts: Application Object

Constraints: Not nullable, Maximum length: 10

purchaseRequisitionItem - Item number of purchase requisition

Constraints: Not nullable, Maximum length: 5

documentText - Text ID

Constraints: Not nullable, Maximum length: 4

language - Language Key

Constraints: Not nullable, Maximum length: 2

purchaseRequisition - Purchase Requisition Number

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single PurchaseReqnItemText 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.

createPurchaseReqnItemText

@Nonnull
PurchaseReqnItemTextCreateFluentHelper createPurchaseReqnItemText(@Nonnull
                                                                           PurchaseReqnItemText purchaseReqnItemText)

Create a new PurchaseReqnItemText entity and save it to the S/4HANA system.

Parameters:

purchaseReqnItemText - PurchaseReqnItemText entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new PurchaseReqnItemText entity. To perform execution, call the execute method on the fluent helper object.

updatePurchaseReqnItemText

@Nonnull
PurchaseReqnItemTextUpdateFluentHelper updatePurchaseReqnItemText(@Nonnull
                                                                           PurchaseReqnItemText purchaseReqnItemText)

Update an existing PurchaseReqnItemText entity and save it to the S/4HANA system.

Parameters:

purchaseReqnItemText - PurchaseReqnItemText entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing PurchaseReqnItemText entity. To perform execution, call the execute method on the fluent helper object.

deletePurchaseReqnItemText

@Nonnull
PurchaseReqnItemTextDeleteFluentHelper deletePurchaseReqnItemText(@Nonnull
                                                                           PurchaseReqnItemText purchaseReqnItemText)

Deletes an existing PurchaseReqnItemText entity in the S/4HANA system.

Parameters:

purchaseReqnItemText - PurchaseReqnItemText entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing PurchaseReqnItemText 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.

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.

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.

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.

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.

validate

@Nonnull
ValidateFluentHelper validate(String purchaseRequisition)

Creates a fluent helper for the Validate OData function import.

Parameters:

purchaseRequisition - Constraints: none

Original parameter name from the Odata EDM: PurchaseRequisition

Returns:

A fluent helper object that will execute the Validate OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

discardFromPurchasing

@Nonnull
DiscardFromPurchasingFluentHelper discardFromPurchasing(String purchaseRequisitionItem,
                                                                 String purchaseRequisition)

Creates a fluent helper for the DiscardFromPurchasing OData function import.

Parameters:

purchaseRequisitionItem - Constraints: none

Original parameter name from the Odata EDM: PurchaseRequisitionItem

purchaseRequisition - Constraints: none

Original parameter name from the Odata EDM: PurchaseRequisition

Returns:

A fluent helper object that will execute the DiscardFromPurchasing OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

enableForPurchasing

@Nonnull
EnableForPurchasingFluentHelper enableForPurchasing(String purchaseRequisitionItem,
                                                             String purchaseRequisition)

Creates a fluent helper for the EnableForPurchasing OData function import.

Parameters:

purchaseRequisitionItem - Constraints: none

Original parameter name from the Odata EDM: PurchaseRequisitionItem

purchaseRequisition - Constraints: none

Original parameter name from the Odata EDM: PurchaseRequisition

Returns:

A fluent helper object that will execute the EnableForPurchasing OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.