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

Interface PurchaseContractService

All Known Implementing Classes:

DefaultPurchaseContractService

public interface PurchaseContractService

This service enables you to create Purchase Contracts 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 Contract 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_PURCHASECONTRACT_PROCESS_SRV
API Version:	1
Communication Scenario:	Purchase Contract Integration (SAP_COM_0101)
Scope Items:	Purchase Contract (BMD), Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45)

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.
PurCtrAccountCreateFluentHelper	createPurCtrAccount(PurCtrAccount purCtrAccount) Create a new PurCtrAccount entity and save it to the S/4HANA system.
PurCtrAddressCreateFluentHelper	createPurCtrAddress(PurCtrAddress purCtrAddress) Create a new PurCtrAddress entity and save it to the S/4HANA system.
PurCtrPartnersCreateFluentHelper	createPurCtrPartners(PurCtrPartners purCtrPartners) Create a new PurCtrPartners entity and save it to the S/4HANA system.
PurchaseContractDeleteFluentHelper	deletePurchaseContract(PurchaseContract purchaseContract) Deletes an existing PurchaseContract entity in the S/4HANA system.
PurchaseContractItemDeleteFluentHelper	deletePurchaseContractItem(PurchaseContractItem purchaseContractItem) Deletes an existing PurchaseContractItem entity in the S/4HANA system.
PurCtrAccountDeleteFluentHelper	deletePurCtrAccount(PurCtrAccount purCtrAccount) Deletes an existing PurCtrAccount entity in the S/4HANA system.
PurCtrAddressDeleteFluentHelper	deletePurCtrAddress(PurCtrAddress purCtrAddress) Deletes an existing PurCtrAddress entity in the S/4HANA system.
PurCtrPartnersDeleteFluentHelper	deletePurCtrPartners(PurCtrPartners purCtrPartners) Deletes an existing PurCtrPartners entity in the S/4HANA system.
PurchaseContractFluentHelper	getAllPurchaseContract() Fetch multiple PurchaseContract entities.
PurchaseContractItemFluentHelper	getAllPurchaseContractItem() Fetch multiple PurchaseContractItem entities.
PurCtrAccountFluentHelper	getAllPurCtrAccount() Fetch multiple PurCtrAccount entities.
PurCtrAddressFluentHelper	getAllPurCtrAddress() Fetch multiple PurCtrAddress entities.
PurCtrPartnersFluentHelper	getAllPurCtrPartners() Fetch multiple PurCtrPartners 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.
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.
PurchaseContractUpdateFluentHelper	updatePurchaseContract(PurchaseContract purchaseContract) Update an existing PurchaseContract entity and save it to the S/4HANA system.
PurchaseContractItemUpdateFluentHelper	updatePurchaseContractItem(PurchaseContractItem purchaseContractItem) Update an existing PurchaseContractItem entity and save it to the S/4HANA system.
PurCtrAccountUpdateFluentHelper	updatePurCtrAccount(PurCtrAccount purCtrAccount) Update an existing PurCtrAccount entity and save it to the S/4HANA system.
PurCtrAddressUpdateFluentHelper	updatePurCtrAddress(PurCtrAddress purCtrAddress) Update an existing PurCtrAddress entity and save it to the S/4HANA system.
PurCtrPartnersUpdateFluentHelper	updatePurCtrPartners(PurCtrPartners purCtrPartners) Update an existing PurCtrPartners entity and save it to the S/4HANA system.

Method Detail

getAllPurCtrAccount

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

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.

createPurCtrAccount

PurCtrAccountCreateFluentHelper createPurCtrAccount(PurCtrAccount purCtrAccount)

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

Parameters:

purCtrAccount - PurCtrAccount entity object that will be created in the S/4HANA system.

Returns:

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

updatePurCtrAccount

PurCtrAccountUpdateFluentHelper updatePurCtrAccount(PurCtrAccount purCtrAccount)

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

Parameters:

purCtrAccount - PurCtrAccount entity object that will be updated in the S/4HANA system.

Returns:

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

deletePurCtrAccount

PurCtrAccountDeleteFluentHelper deletePurCtrAccount(PurCtrAccount purCtrAccount)

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

Parameters:

purCtrAccount - PurCtrAccount entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllPurCtrAddress

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

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.

createPurCtrAddress

PurCtrAddressCreateFluentHelper createPurCtrAddress(PurCtrAddress purCtrAddress)

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

Parameters:

purCtrAddress - PurCtrAddress entity object that will be created in the S/4HANA system.

Returns:

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

updatePurCtrAddress

PurCtrAddressUpdateFluentHelper updatePurCtrAddress(PurCtrAddress purCtrAddress)

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

Parameters:

purCtrAddress - PurCtrAddress entity object that will be updated in the S/4HANA system.

Returns:

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

deletePurCtrAddress

PurCtrAddressDeleteFluentHelper deletePurCtrAddress(PurCtrAddress purCtrAddress)

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

Parameters:

purCtrAddress - PurCtrAddress entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllPurCtrPartners

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

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.

createPurCtrPartners

PurCtrPartnersCreateFluentHelper createPurCtrPartners(PurCtrPartners purCtrPartners)

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

Parameters:

purCtrPartners - PurCtrPartners entity object that will be created in the S/4HANA system.

Returns:

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

updatePurCtrPartners

PurCtrPartnersUpdateFluentHelper updatePurCtrPartners(PurCtrPartners purCtrPartners)

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

Parameters:

purCtrPartners - PurCtrPartners entity object that will be updated in the S/4HANA system.

Returns:

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

deletePurCtrPartners

PurCtrPartnersDeleteFluentHelper deletePurCtrPartners(PurCtrPartners purCtrPartners)

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

Parameters:

purCtrPartners - PurCtrPartners entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllPurchaseContract

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

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

PurchaseContractCreateFluentHelper createPurchaseContract(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.

updatePurchaseContract

PurchaseContractUpdateFluentHelper updatePurchaseContract(PurchaseContract purchaseContract)

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

Parameters:

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

Returns:

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

deletePurchaseContract

PurchaseContractDeleteFluentHelper deletePurchaseContract(PurchaseContract purchaseContract)

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

Parameters:

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

Returns:

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

getAllPurchaseContractItem

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

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

PurchaseContractItemCreateFluentHelper createPurchaseContractItem(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.

updatePurchaseContractItem

PurchaseContractItemUpdateFluentHelper updatePurchaseContractItem(PurchaseContractItem purchaseContractItem)

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

Parameters:

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

Returns:

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

deletePurchaseContractItem

PurchaseContractItemDeleteFluentHelper deletePurchaseContractItem(PurchaseContractItem purchaseContractItem)

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

Parameters:

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

Returns:

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