Class DefaultPurchaseContractService
- All Implemented Interfaces:
BatchService<PurchaseContractServiceBatch>,PurchaseContractService
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 Cloud. The service contains header, item, item conditions, account assignment, address and partner nodes. .
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | API_PURCHASECONTRACT_PROCESS_SRV |
| API Version: | 1.1.0 |
| Minimum ERP Version: | 2208 |
| Communication Scenario: | Distributed Manufacturing Integration(SAP_COM_0077), Purchase Contract Integration(SAP_COM_0101) |
| Scope Items: | Collaborative Manufacturing with SAP Digital Manufacturing Cloud(1NX), Dynamic Customer Profiling(JC1), Consumable Purchasing(BNX), Service and Material Procurement - Project-Based Services(J13), Procurement of Direct Materials(J45), Procurement of Direct Materials(O45), Consumable Purchasing(ONX), Purchase Contract(BMD), Purchase Contract(OMD) |
| Business Object: | Purchase Contract |
-
Field Summary
Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PurchaseContractService
DEFAULT_SERVICE_PATH -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Creates a service usingPurchaseContractService.DEFAULT_SERVICE_PATHto send the requests. -
Method Summary
Modifier and TypeMethodDescriptionapproveDocument(String purchaseContract) Deprecated.Creates a fluent helper for the ApproveDocument OData function import.batch()Deprecated.createPurchaseContract(PurchaseContract purchaseContract) Deprecated.Create a newPurchaseContractentity and save it to the S/4HANA system.createPurchaseContractItem(PurchaseContractItem purchaseContractItem) Deprecated.Create a newPurchaseContractItementity and save it to the S/4HANA system.createPurCtrAccount(PurCtrAccount purCtrAccount) Deprecated.Create a newPurCtrAccountentity and save it to the S/4HANA system.createPurCtrAddress(PurCtrAddress purCtrAddress) Deprecated.Create a newPurCtrAddressentity and save it to the S/4HANA system.createPurCtrPartners(PurCtrPartners purCtrPartners) Deprecated.Create a newPurCtrPartnersentity and save it to the S/4HANA system.Deprecated.Fetch multiplePurchaseContractentities.Deprecated.Fetch multiplePurchaseContractItementities.Deprecated.Fetch multiplePurContrItemConditionentities.Deprecated.Fetch multiplePurCtrAccountentities.Deprecated.Fetch multiplePurCtrAddressentities.Deprecated.Fetch multiplePurCtrPartnersentities.getPurchaseContractByKey(String purchaseContract) Deprecated.Fetch a singlePurchaseContractentity using key fields.getPurchaseContractItemByKey(String purchaseContract, String purchaseContractItem) Deprecated.Fetch a singlePurchaseContractItementity using key fields.getPurContrItemConditionByKey(String purchaseContract, String purchaseContractItem, LocalDateTime conditionValidityEndDate, String conditionType, String conditionRecord, String conditionSequentialNumber) Deprecated.Fetch a singlePurContrItemConditionentity using key fields.getPurCtrAccountByKey(String accountAssignment, String purchaseContractItem, String purchaseContract) Deprecated.Fetch a singlePurCtrAccountentity using key fields.getPurCtrAddressByKey(String purchaseContract, String addressID, String purchaseContractItem) Deprecated.Fetch a singlePurCtrAddressentity using key fields.getPurCtrPartnersByKey(String purchaseContract, String purchaseContractItem, String purchasingOrganization, String partnerFunction, String plant, String supplierSubrange, String partnerCounter) Deprecated.Fetch a singlePurCtrPartnersentity using key fields.rejectDocument(String purchaseContract) Deprecated.Creates a fluent helper for the RejectDocument OData function import.updatePurchaseContract(PurchaseContract purchaseContract) Deprecated.Update an existingPurchaseContractentity and save it to the S/4HANA system.updatePurchaseContractItem(PurchaseContractItem purchaseContractItem) Deprecated.Update an existingPurchaseContractItementity and save it to the S/4HANA system.updatePurCtrAccount(PurCtrAccount purCtrAccount) Deprecated.Update an existingPurCtrAccountentity and save it to the S/4HANA system.updatePurCtrAddress(PurCtrAddress purCtrAddress) Deprecated.Update an existingPurCtrAddressentity and save it to the S/4HANA system.updatePurCtrPartners(PurCtrPartners purCtrPartners) Deprecated.Update an existingPurCtrPartnersentity and save it to the S/4HANA system.withdrawFromApproval(String purchaseContract) Deprecated.Creates a fluent helper for the WithdrawFromApproval OData function import.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Constructor Details
-
DefaultPurchaseContractService
public DefaultPurchaseContractService()Deprecated.Creates a service usingPurchaseContractService.DEFAULT_SERVICE_PATHto send the requests.
-
-
Method Details
-
withServicePath
Deprecated.Description copied from interface:PurchaseContractServiceOverrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Specified by:
withServicePathin interfacePurchaseContractService- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
batch
Deprecated.- Specified by:
batchin interfaceBatchService<PurchaseContractServiceBatch>
-
getAllPurchaseContract
Deprecated.Description copied from interface:PurchaseContractServiceFetch multiplePurchaseContractentities.- Specified by:
getAllPurchaseContractin interfacePurchaseContractService- Returns:
- A fluent helper to fetch multiple
PurchaseContractentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getPurchaseContractByKey
Deprecated.Description copied from interface:PurchaseContractServiceFetch a singlePurchaseContractentity using key fields.- Specified by:
getPurchaseContractByKeyin interfacePurchaseContractService- Parameters:
purchaseContract- Purchasing Contract HeaderConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
PurchaseContractentity 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 theexecutemethod on the fluent helper object.
-
createPurchaseContract
@Nonnull public PurchaseContractCreateFluentHelper createPurchaseContract(@Nonnull PurchaseContract purchaseContract) Deprecated.Description copied from interface:PurchaseContractServiceCreate a newPurchaseContractentity and save it to the S/4HANA system.- Specified by:
createPurchaseContractin interfacePurchaseContractService- Parameters:
purchaseContract-PurchaseContractentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
PurchaseContractentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updatePurchaseContract
@Nonnull public PurchaseContractUpdateFluentHelper updatePurchaseContract(@Nonnull PurchaseContract purchaseContract) Deprecated.Description copied from interface:PurchaseContractServiceUpdate an existingPurchaseContractentity and save it to the S/4HANA system.- Specified by:
updatePurchaseContractin interfacePurchaseContractService- Parameters:
purchaseContract-PurchaseContractentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
PurchaseContractentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllPurchaseContractItem
Deprecated.Description copied from interface:PurchaseContractServiceFetch multiplePurchaseContractItementities.- Specified by:
getAllPurchaseContractItemin interfacePurchaseContractService- Returns:
- A fluent helper to fetch multiple
PurchaseContractItementities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getPurchaseContractItemByKey
@Nonnull public PurchaseContractItemByKeyFluentHelper getPurchaseContractItemByKey(String purchaseContract, String purchaseContractItem) Deprecated.Description copied from interface:PurchaseContractServiceFetch a singlePurchaseContractItementity using key fields.- Specified by:
getPurchaseContractItemByKeyin interfacePurchaseContractService- Parameters:
purchaseContract- Purchasing Contract HeaderConstraints: Not nullable, Maximum length: 10
purchaseContractItem- Item Number of Purchasing ContractConstraints: Not nullable, Maximum length: 5
- Returns:
- A fluent helper to fetch a single
PurchaseContractItementity 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 theexecutemethod on the fluent helper object.
-
createPurchaseContractItem
@Nonnull public PurchaseContractItemCreateFluentHelper createPurchaseContractItem(@Nonnull PurchaseContractItem purchaseContractItem) Deprecated.Description copied from interface:PurchaseContractServiceCreate a newPurchaseContractItementity and save it to the S/4HANA system.- Specified by:
createPurchaseContractItemin interfacePurchaseContractService- Parameters:
purchaseContractItem-PurchaseContractItementity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
PurchaseContractItementity. To perform execution, call theexecutemethod on the fluent helper object.
-
updatePurchaseContractItem
@Nonnull public PurchaseContractItemUpdateFluentHelper updatePurchaseContractItem(@Nonnull PurchaseContractItem purchaseContractItem) Deprecated.Description copied from interface:PurchaseContractServiceUpdate an existingPurchaseContractItementity and save it to the S/4HANA system.- Specified by:
updatePurchaseContractItemin interfacePurchaseContractService- Parameters:
purchaseContractItem-PurchaseContractItementity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
PurchaseContractItementity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllPurContrItemCondition
Deprecated.Description copied from interface:PurchaseContractServiceFetch multiplePurContrItemConditionentities.- Specified by:
getAllPurContrItemConditionin interfacePurchaseContractService- Returns:
- A fluent helper to fetch multiple
PurContrItemConditionentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getPurContrItemConditionByKey
@Nonnull public PurContrItemConditionByKeyFluentHelper getPurContrItemConditionByKey(String purchaseContract, String purchaseContractItem, LocalDateTime conditionValidityEndDate, String conditionType, String conditionRecord, String conditionSequentialNumber) Deprecated.Description copied from interface:PurchaseContractServiceFetch a singlePurContrItemConditionentity using key fields.- Specified by:
getPurContrItemConditionByKeyin interfacePurchaseContractService- Parameters:
purchaseContract- Purchasing Document NumberConstraints: Not nullable, Maximum length: 10
purchaseContractItem- Item Number of Purchasing DocumentConstraints: Not nullable, Maximum length: 5
conditionType- Condition TypeConstraints: Not nullable, Maximum length: 4
conditionRecord- Number of Condition RecordConstraints: Not nullable, Maximum length: 10
conditionSequentialNumber- Sequential number of the conditionConstraints: Not nullable, Maximum length: 2
- Returns:
- A fluent helper to fetch a single
PurContrItemConditionentity 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 theexecutemethod on the fluent helper object.
-
getAllPurCtrAccount
Deprecated.Description copied from interface:PurchaseContractServiceFetch multiplePurCtrAccountentities.- Specified by:
getAllPurCtrAccountin interfacePurchaseContractService- Returns:
- A fluent helper to fetch multiple
PurCtrAccountentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getPurCtrAccountByKey
@Nonnull public PurCtrAccountByKeyFluentHelper getPurCtrAccountByKey(String accountAssignment, String purchaseContractItem, String purchaseContract) Deprecated.Description copied from interface:PurchaseContractServiceFetch a singlePurCtrAccountentity using key fields.- Specified by:
getPurCtrAccountByKeyin interfacePurchaseContractService- Parameters:
accountAssignment- Sequential Number of Account AssignmentConstraints: Not nullable, Maximum length: 2
purchaseContractItem- Item Number of Purchasing DocumentConstraints: Not nullable, Maximum length: 5
purchaseContract- Purchasing Document NumberConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
PurCtrAccountentity 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 theexecutemethod on the fluent helper object.
-
createPurCtrAccount
@Nonnull public PurCtrAccountCreateFluentHelper createPurCtrAccount(@Nonnull PurCtrAccount purCtrAccount) Deprecated.Description copied from interface:PurchaseContractServiceCreate a newPurCtrAccountentity and save it to the S/4HANA system.- Specified by:
createPurCtrAccountin interfacePurchaseContractService- Parameters:
purCtrAccount-PurCtrAccountentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
PurCtrAccountentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updatePurCtrAccount
@Nonnull public PurCtrAccountUpdateFluentHelper updatePurCtrAccount(@Nonnull PurCtrAccount purCtrAccount) Deprecated.Description copied from interface:PurchaseContractServiceUpdate an existingPurCtrAccountentity and save it to the S/4HANA system.- Specified by:
updatePurCtrAccountin interfacePurchaseContractService- Parameters:
purCtrAccount-PurCtrAccountentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
PurCtrAccountentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllPurCtrAddress
Deprecated.Description copied from interface:PurchaseContractServiceFetch multiplePurCtrAddressentities.- Specified by:
getAllPurCtrAddressin interfacePurchaseContractService- Returns:
- A fluent helper to fetch multiple
PurCtrAddressentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getPurCtrAddressByKey
@Nonnull public PurCtrAddressByKeyFluentHelper getPurCtrAddressByKey(String purchaseContract, String addressID, String purchaseContractItem) Deprecated.Description copied from interface:PurchaseContractServiceFetch a singlePurCtrAddressentity using key fields.- Specified by:
getPurCtrAddressByKeyin interfacePurchaseContractService- Parameters:
purchaseContract- Purchasing Contract HeaderConstraints: Not nullable, Maximum length: 10
addressID- Address NumberConstraints: Not nullable, Maximum length: 10
purchaseContractItem- Item Number of Purchasing ContractConstraints: Not nullable, Maximum length: 5
- Returns:
- A fluent helper to fetch a single
PurCtrAddressentity 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 theexecutemethod on the fluent helper object.
-
createPurCtrAddress
@Nonnull public PurCtrAddressCreateFluentHelper createPurCtrAddress(@Nonnull PurCtrAddress purCtrAddress) Deprecated.Description copied from interface:PurchaseContractServiceCreate a newPurCtrAddressentity and save it to the S/4HANA system.- Specified by:
createPurCtrAddressin interfacePurchaseContractService- Parameters:
purCtrAddress-PurCtrAddressentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
PurCtrAddressentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updatePurCtrAddress
@Nonnull public PurCtrAddressUpdateFluentHelper updatePurCtrAddress(@Nonnull PurCtrAddress purCtrAddress) Deprecated.Description copied from interface:PurchaseContractServiceUpdate an existingPurCtrAddressentity and save it to the S/4HANA system.- Specified by:
updatePurCtrAddressin interfacePurchaseContractService- Parameters:
purCtrAddress-PurCtrAddressentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
PurCtrAddressentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllPurCtrPartners
Deprecated.Description copied from interface:PurchaseContractServiceFetch multiplePurCtrPartnersentities.- Specified by:
getAllPurCtrPartnersin interfacePurchaseContractService- Returns:
- A fluent helper to fetch multiple
PurCtrPartnersentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getPurCtrPartnersByKey
@Nonnull public PurCtrPartnersByKeyFluentHelper getPurCtrPartnersByKey(String purchaseContract, String purchaseContractItem, String purchasingOrganization, String partnerFunction, String plant, String supplierSubrange, String partnerCounter) Deprecated.Description copied from interface:PurchaseContractServiceFetch a singlePurCtrPartnersentity using key fields.- Specified by:
getPurCtrPartnersByKeyin interfacePurchaseContractService- Parameters:
purchaseContract- Purchasing Document NumberConstraints: Not nullable, Maximum length: 10
purchaseContractItem- Item Number of Purchasing DocumentConstraints: Not nullable, Maximum length: 5
purchasingOrganization- Purchasing OrganizationConstraints: Not nullable, Maximum length: 4
partnerFunction- Partner FunctionConstraints: Not nullable, Maximum length: 2
plant- PlantConstraints: Not nullable, Maximum length: 4
supplierSubrange- Supplier SubrangeConstraints: Not nullable, Maximum length: 6
partnerCounter- Partner counterConstraints: Not nullable, Maximum length: 3
- Returns:
- A fluent helper to fetch a single
PurCtrPartnersentity 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 theexecutemethod on the fluent helper object.
-
createPurCtrPartners
@Nonnull public PurCtrPartnersCreateFluentHelper createPurCtrPartners(@Nonnull PurCtrPartners purCtrPartners) Deprecated.Description copied from interface:PurchaseContractServiceCreate a newPurCtrPartnersentity and save it to the S/4HANA system.- Specified by:
createPurCtrPartnersin interfacePurchaseContractService- Parameters:
purCtrPartners-PurCtrPartnersentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
PurCtrPartnersentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updatePurCtrPartners
@Nonnull public PurCtrPartnersUpdateFluentHelper updatePurCtrPartners(@Nonnull PurCtrPartners purCtrPartners) Deprecated.Description copied from interface:PurchaseContractServiceUpdate an existingPurCtrPartnersentity and save it to the S/4HANA system.- Specified by:
updatePurCtrPartnersin interfacePurchaseContractService- Parameters:
purCtrPartners-PurCtrPartnersentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
PurCtrPartnersentity. To perform execution, call theexecutemethod on the fluent helper object.
-
withdrawFromApproval
@Nonnull public WithdrawFromApprovalFluentHelper withdrawFromApproval(@Nonnull String purchaseContract) Deprecated.Description copied from interface:PurchaseContractServiceCreates a fluent helper for the WithdrawFromApproval OData function import.
- Specified by:
withdrawFromApprovalin interfacePurchaseContractService- Parameters:
purchaseContract- Constraints: Not nullable, Maximum length: 10Original parameter name from the Odata EDM: PurchaseContract
- Returns:
- A fluent helper object that will execute the WithdrawFromApproval OData function import with the
provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
rejectDocument
Deprecated.Description copied from interface:PurchaseContractServiceCreates a fluent helper for the RejectDocument OData function import.
- Specified by:
rejectDocumentin interfacePurchaseContractService- Parameters:
purchaseContract- Constraints: Not nullable, Maximum length: 10Original parameter name from the Odata EDM: PurchaseContract
- Returns:
- A fluent helper object that will execute the RejectDocument OData function import with the
provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
approveDocument
Deprecated.Description copied from interface:PurchaseContractServiceCreates a fluent helper for the ApproveDocument OData function import.
- Specified by:
approveDocumentin interfacePurchaseContractService- Parameters:
purchaseContract- Constraints: Not nullable, Maximum length: 10Original parameter name from the Odata EDM: PurchaseContract
- Returns:
- A fluent helper object that will execute the ApproveDocument OData function import with the
provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-