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

Interface PurchaseContractService

All Superinterfaces:

BatchService<PurchaseContractServiceBatch>

All Known Implementing Classes:

DefaultPurchaseContractService

public interface PurchaseContractService
extends BatchService<PurchaseContractServiceBatch>

This service is based on the OData protocol. It enables you to read, create, and update purchase contracts through an API call from a source system outside SAP S/4HANA. The service contains header, item, item conditions, account assignment, address, and partner nodes. Note: Certain elements and entities can only be used if you activate thebusiness function ISR_RETAILSYSTEM. For more information, see Business Documentation..

Business Documentation

Reference: SAP API Business Hub

Details:

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

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
PurchaseContractCreateFluentHelper	createPurchaseContract(PurchaseContract purchaseContract) Create a new PurchaseContract entity and save it to the S/4HANA system.
PurchaseContractItemCreateFluentHelper	createPurchaseContractItem(PurchaseContractItem purchaseContractItem) Create a new PurchaseContractItem entity and save it to the S/4HANA system.
ValAddedSrvcMMCreateFluentHelper	createValAddedSrvcMM(ValAddedSrvcMM valAddedSrvcMM) Create a new ValAddedSrvcMM entity and save it to the S/4HANA system.
ValAddedSrvcMMDeleteFluentHelper	deleteValAddedSrvcMM(ValAddedSrvcMM valAddedSrvcMM) Deletes an existing ValAddedSrvcMM entity in the S/4HANA system.
PurchaseContractFluentHelper	getAllPurchaseContract() Fetch multiple PurchaseContract entities.
PurchaseContractItemFluentHelper	getAllPurchaseContractItem() Fetch multiple PurchaseContractItem entities.
PurContrItemConditionFluentHelper	getAllPurContrItemCondition() Fetch multiple PurContrItemCondition entities.
PurCtrAccountFluentHelper	getAllPurCtrAccount() Fetch multiple PurCtrAccount entities.
PurCtrAddressFluentHelper	getAllPurCtrAddress() Fetch multiple PurCtrAddress entities.
PurCtrPartnersFluentHelper	getAllPurCtrPartners() Fetch multiple PurCtrPartners entities.
ValAddedSrvcMMFluentHelper	getAllValAddedSrvcMM() Fetch multiple ValAddedSrvcMM entities.
PurchaseContractByKeyFluentHelper	getPurchaseContractByKey(String purchaseContract) Fetch a single PurchaseContract entity using key fields.
PurchaseContractItemByKeyFluentHelper	getPurchaseContractItemByKey(String purchaseContract, String purchaseContractItem) Fetch a single PurchaseContractItem entity using key fields.
PurContrItemConditionByKeyFluentHelper	getPurContrItemConditionByKey(String purchaseContract, String purchaseContractItem, LocalDateTime conditionValidityEndDate, String conditionType, String conditionRecord, String conditionSequentialNumber) Fetch a single PurContrItemCondition entity using key fields.
PurCtrAccountByKeyFluentHelper	getPurCtrAccountByKey(String accountAssignment, String purchaseContractItem, String purchaseContract) Fetch a single PurCtrAccount entity using key fields.
PurCtrAddressByKeyFluentHelper	getPurCtrAddressByKey(String purchaseContract, String addressID, String purchaseContractItem) Fetch a single PurCtrAddress entity using key fields.
PurCtrPartnersByKeyFluentHelper	getPurCtrPartnersByKey(String purchaseContract, String purchaseContractItem, String purchasingOrganization, String partnerFunction, String plant, String supplierSubrange, String partnerCounter) Fetch a single PurCtrPartners entity using key fields.
ValAddedSrvcMMByKeyFluentHelper	getValAddedSrvcMMByKey(String valAddedSrvcTransactionNumber, String valAddedSrvcItemGroup, String valAddedSrvcItemNumber, String valueAddedServiceType, String valueAddedSubServiceType) Fetch a single ValAddedSrvcMM entity using key fields.
ValAddedSrvcMMUpdateFluentHelper	updateValAddedSrvcMM(ValAddedSrvcMM valAddedSrvcMM) Update an existing ValAddedSrvcMM entity and save it to the S/4HANA system.
PurchaseContractService	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
PurchaseContractService 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.

getAllPurchaseContract

@Nonnull
PurchaseContractFluentHelper getAllPurchaseContract()

Fetch multiple PurchaseContract entities.

Returns:

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

getPurchaseContractByKey

@Nonnull
PurchaseContractByKeyFluentHelper getPurchaseContractByKey(String purchaseContract)

Fetch a single PurchaseContract entity using key fields.

Parameters:

purchaseContract - Purchasing Contract Header

Constraints: Not nullable, Maximum length: 10

Returns:

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

createPurchaseContract

@Nonnull
PurchaseContractCreateFluentHelper createPurchaseContract(@Nonnull
                                                                   PurchaseContract purchaseContract)

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

Parameters:

purchaseContract - PurchaseContract entity object that will be created in the S/4HANA system.

Returns:

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

getAllPurchaseContractItem

@Nonnull
PurchaseContractItemFluentHelper getAllPurchaseContractItem()

Fetch multiple PurchaseContractItem entities.

Returns:

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

getPurchaseContractItemByKey

@Nonnull
PurchaseContractItemByKeyFluentHelper getPurchaseContractItemByKey(String purchaseContract,
                                                                            String purchaseContractItem)

Fetch a single PurchaseContractItem entity using key fields.

Parameters:

purchaseContract - Purchasing Contract Header

Constraints: Not nullable, Maximum length: 10

purchaseContractItem - Item Number of Purchasing Contract

Constraints: Not nullable, Maximum length: 5

Returns:

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

createPurchaseContractItem

@Nonnull
PurchaseContractItemCreateFluentHelper createPurchaseContractItem(@Nonnull
                                                                           PurchaseContractItem purchaseContractItem)

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

Parameters:

purchaseContractItem - PurchaseContractItem entity object that will be created in the S/4HANA system.

Returns:

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

getAllPurContrItemCondition

@Nonnull
PurContrItemConditionFluentHelper getAllPurContrItemCondition()

Fetch multiple PurContrItemCondition entities.

Returns:

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

getPurContrItemConditionByKey

@Nonnull
PurContrItemConditionByKeyFluentHelper getPurContrItemConditionByKey(String purchaseContract,
                                                                              String purchaseContractItem,
                                                                              LocalDateTime conditionValidityEndDate,
                                                                              String conditionType,
                                                                              String conditionRecord,
                                                                              String conditionSequentialNumber)

Fetch a single PurContrItemCondition entity using key fields.

Parameters:

conditionSequentialNumber - Sequential number of the condition

Constraints: Not nullable, Maximum length: 2

conditionValidityEndDate -

purchaseContract - Purchasing Document Number

Constraints: Not nullable, Maximum length: 10

conditionType - Condition Type

Constraints: Not nullable, Maximum length: 4

purchaseContractItem - Item Number of Purchasing Document

Constraints: Not nullable, Maximum length: 5

conditionRecord - Number of the Condition Record

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllPurCtrAccount

@Nonnull
PurCtrAccountFluentHelper getAllPurCtrAccount()

Fetch multiple PurCtrAccount entities.

Returns:

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

getPurCtrAccountByKey

@Nonnull
PurCtrAccountByKeyFluentHelper getPurCtrAccountByKey(String accountAssignment,
                                                              String purchaseContractItem,
                                                              String purchaseContract)

Fetch a single PurCtrAccount entity using key fields.

Parameters:

purchaseContract - Purchasing Document Number

Constraints: Not nullable, Maximum length: 10

accountAssignment - Sequential Number of Account Assignment

Constraints: Not nullable, Maximum length: 2

purchaseContractItem - Item Number of Purchasing Document

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllPurCtrAddress

@Nonnull
PurCtrAddressFluentHelper getAllPurCtrAddress()

Fetch multiple PurCtrAddress entities.

Returns:

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

getPurCtrAddressByKey

@Nonnull
PurCtrAddressByKeyFluentHelper getPurCtrAddressByKey(String purchaseContract,
                                                              String addressID,
                                                              String purchaseContractItem)

Fetch a single PurCtrAddress entity using key fields.

Parameters:

purchaseContract - Purchasing Contract Header

Constraints: Not nullable, Maximum length: 10

purchaseContractItem - Item Number of Purchasing Contract

Constraints: Not nullable, Maximum length: 5

addressID - Address Number

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllPurCtrPartners

@Nonnull
PurCtrPartnersFluentHelper getAllPurCtrPartners()

Fetch multiple PurCtrPartners entities.

Returns:

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

getPurCtrPartnersByKey

@Nonnull
PurCtrPartnersByKeyFluentHelper getPurCtrPartnersByKey(String purchaseContract,
                                                                String purchaseContractItem,
                                                                String purchasingOrganization,
                                                                String partnerFunction,
                                                                String plant,
                                                                String supplierSubrange,
                                                                String partnerCounter)

Fetch a single PurCtrPartners entity using key fields.

Parameters:

partnerFunction - Partner Function

Constraints: Not nullable, Maximum length: 2

purchaseContract - Purchasing Document Number

Constraints: Not nullable, Maximum length: 10

plant - Plant

Constraints: Not nullable, Maximum length: 4

purchasingOrganization - Purchasing organization

Constraints: Not nullable, Maximum length: 4

partnerCounter - Partner counter

Constraints: Not nullable, Maximum length: 3

purchaseContractItem - Item Number of Purchasing Document

Constraints: Not nullable, Maximum length: 5

supplierSubrange - Supplier Subrange

Constraints: Not nullable, Maximum length: 6

Returns:

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

getAllValAddedSrvcMM

@Nonnull
ValAddedSrvcMMFluentHelper getAllValAddedSrvcMM()

Fetch multiple ValAddedSrvcMM entities.

Returns:

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

getValAddedSrvcMMByKey

@Nonnull
ValAddedSrvcMMByKeyFluentHelper getValAddedSrvcMMByKey(String valAddedSrvcTransactionNumber,
                                                                String valAddedSrvcItemGroup,
                                                                String valAddedSrvcItemNumber,
                                                                String valueAddedServiceType,
                                                                String valueAddedSubServiceType)

Fetch a single ValAddedSrvcMM entity using key fields.

Parameters:

valueAddedServiceType - VAS Service Types

Constraints: Not nullable, Maximum length: 2

valAddedSrvcItemNumber - Item Number

Constraints: Not nullable, Maximum length: 5

valAddedSrvcTransactionNumber - Transaction Number

Constraints: Not nullable, Maximum length: 10

valAddedSrvcItemGroup - Item Group

Constraints: Not nullable, Maximum length: 5

valueAddedSubServiceType - VAS Sub Services

Constraints: Not nullable, Maximum length: 5

Returns:

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

createValAddedSrvcMM

@Nonnull
ValAddedSrvcMMCreateFluentHelper createValAddedSrvcMM(@Nonnull
                                                               ValAddedSrvcMM valAddedSrvcMM)

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

Parameters:

valAddedSrvcMM - ValAddedSrvcMM entity object that will be created in the S/4HANA system.

Returns:

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

updateValAddedSrvcMM

@Nonnull
ValAddedSrvcMMUpdateFluentHelper updateValAddedSrvcMM(@Nonnull
                                                               ValAddedSrvcMM valAddedSrvcMM)

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

Parameters:

valAddedSrvcMM - ValAddedSrvcMM entity object that will be updated in the S/4HANA system.

Returns:

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

deleteValAddedSrvcMM

@Nonnull
ValAddedSrvcMMDeleteFluentHelper deleteValAddedSrvcMM(@Nonnull
                                                               ValAddedSrvcMM valAddedSrvcMM)

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

Parameters:

valAddedSrvcMM - ValAddedSrvcMM entity object that will be deleted in the S/4HANA system.

Returns:

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