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

Interface PurchaseRequisitionService

All Known Implementing Classes:

DefaultPurchaseRequisitionService

public interface PurchaseRequisitionService

This inbound service enables you to create, read, update, and delete purchase requisitions through an API call from a source system inside as well as outside SAP S/4HANA Cloud or SAP S/4HANA onPremise.

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), SAP S/4HANA Procurement Hub - Ariba GB - Hub to Ariba GB Integration (SAP_COM_0292)
Scope Items:	Requisitioning (18J), Guided Buying Integration (2NV), Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45)
Authentication Methods:	Basic, x509

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
PurchaseRequisitionHeaderCreateFluentHelper	createPurchaseRequisitionHeader(PurchaseRequisitionHeader purchaseRequisitionHeader) Create a new PurchaseRequisitionHeader entity and save it to 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.
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.

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.

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.

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.

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.

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 - Specifies the number that uniquely identifies an item in .

Constraints: Not nullable, Maximum length: 5

purchaseRequisition - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

purchaseReqnAcctAssgmtNumber - Specifies the serial number of the account assignment item in the purchase requisition.

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.

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.