@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPurchaseContractService") public class DefaultPurchaseContractService extends Object implements 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 API Business Hub
OData Service: | API_PURCHASECONTRACT_PROCESS_SRV |
API Version: | 1 |
Communication Scenario: | Distributed Manufacturing Integration (SAP_COM_0077), Purchase Contract Integration (SAP_COM_0101) |
Scope Items: | Collaborative Manufacturing with SAP Digital Manufacturing Cloud (1NX), Purchase Contract (BMD), Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45), Dynamic Customer Profiling (JC1), Purchase Contract (OMD) |
Authentication Methods: | Basic, x509 |
Business Object: | PurchaseContract |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultPurchaseContractService()
Creates a service using
PurchaseContractService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultPurchaseContractServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
PurchaseContractCreateFluentHelper |
createPurchaseContract(PurchaseContract purchaseContract)
Create a new
PurchaseContract entity and save it to 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. |
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. |
DefaultPurchaseContractService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultPurchaseContractService()
PurchaseContractService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultPurchaseContractService withServicePath(@Nonnull String servicePath)
PurchaseContractService
withServicePath
in interface PurchaseContractService
servicePath
- Service path that will override the default.@Nonnull public DefaultPurchaseContractServiceBatch batch()
batch
in interface BatchService<PurchaseContractServiceBatch>
@Nonnull public PurchaseContractFluentHelper getAllPurchaseContract()
PurchaseContractService
PurchaseContract
entities.getAllPurchaseContract
in interface PurchaseContractService
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.@Nonnull public PurchaseContractByKeyFluentHelper getPurchaseContractByKey(String purchaseContract)
PurchaseContractService
PurchaseContract
entity using key fields.getPurchaseContractByKey
in interface PurchaseContractService
purchaseContract
- Purchasing Contract Header
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public PurchaseContractCreateFluentHelper createPurchaseContract(@Nonnull PurchaseContract purchaseContract)
PurchaseContractService
PurchaseContract
entity and save it to the S/4HANA system.createPurchaseContract
in interface PurchaseContractService
purchaseContract
- PurchaseContract
entity object that will be created in the S/4HANA system.PurchaseContract
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public PurchaseContractItemFluentHelper getAllPurchaseContractItem()
PurchaseContractService
PurchaseContractItem
entities.getAllPurchaseContractItem
in interface PurchaseContractService
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.@Nonnull public PurchaseContractItemByKeyFluentHelper getPurchaseContractItemByKey(String purchaseContract, String purchaseContractItem)
PurchaseContractService
PurchaseContractItem
entity using key fields.getPurchaseContractItemByKey
in interface PurchaseContractService
purchaseContract
- Purchasing Contract Header
Constraints: Not nullable, Maximum length: 10
purchaseContractItem
- Item Number of Purchasing Contract
Constraints: Not nullable, Maximum length: 5
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.@Nonnull public PurContrItemConditionFluentHelper getAllPurContrItemCondition()
PurchaseContractService
PurContrItemCondition
entities.getAllPurContrItemCondition
in interface PurchaseContractService
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.@Nonnull public PurContrItemConditionByKeyFluentHelper getPurContrItemConditionByKey(String purchaseContract, String purchaseContractItem, LocalDateTime conditionValidityEndDate, String conditionType, String conditionRecord, String conditionSequentialNumber)
PurchaseContractService
PurContrItemCondition
entity using key fields.getPurContrItemConditionByKey
in interface PurchaseContractService
purchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
purchaseContractItem
- Specifies the number that uniquely identifies an item in .
Constraints: Not nullable, Maximum length: 5
conditionType
- The key that uniquely identifies the condition.
Constraints: Not nullable, Maximum length: 4
conditionRecord
- Number that uniquely identifies a condition record.
Constraints: Not nullable, Maximum length: 10
conditionSequentialNumber
- The sequential number that uniquely identifies the condition if a condition supplement exists.
Constraints: Not nullable, Maximum length: 2
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.@Nonnull public PurCtrAccountFluentHelper getAllPurCtrAccount()
PurchaseContractService
PurCtrAccount
entities.getAllPurCtrAccount
in interface PurchaseContractService
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.@Nonnull public PurCtrAccountByKeyFluentHelper getPurCtrAccountByKey(String accountAssignment, String purchaseContractItem, String purchaseContract)
PurchaseContractService
PurCtrAccount
entity using key fields.getPurCtrAccountByKey
in interface PurchaseContractService
accountAssignment
- Number uniquely defining the account assignment of a purchase document item.
Constraints: Not nullable, Maximum length: 2
purchaseContractItem
- Specifies the number that uniquely identifies an item in .
Constraints: Not nullable, Maximum length: 5
purchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public PurCtrAddressFluentHelper getAllPurCtrAddress()
PurchaseContractService
PurCtrAddress
entities.getAllPurCtrAddress
in interface PurchaseContractService
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.@Nonnull public PurCtrAddressByKeyFluentHelper getPurCtrAddressByKey(String purchaseContract, String addressID, String purchaseContractItem)
PurchaseContractService
PurCtrAddress
entity using key fields.getPurCtrAddressByKey
in interface PurchaseContractService
purchaseContract
- Purchasing Contract Header
Constraints: Not nullable, Maximum length: 10
addressID
- Internal key for identifying a Business Address Services address.
Constraints: Not nullable, Maximum length: 10
purchaseContractItem
- Item Number of Purchasing Contract
Constraints: Not nullable, Maximum length: 5
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.@Nonnull public PurCtrPartnersFluentHelper getAllPurCtrPartners()
PurchaseContractService
PurCtrPartners
entities.getAllPurCtrPartners
in interface PurchaseContractService
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.@Nonnull public PurCtrPartnersByKeyFluentHelper getPurCtrPartnersByKey(String purchaseContract, String purchaseContractItem, String purchasingOrganization, String partnerFunction, String plant, String supplierSubrange, String partnerCounter)
PurchaseContractService
PurCtrPartners
entity using key fields.getPurCtrPartnersByKey
in interface PurchaseContractService
purchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
purchaseContractItem
- Specifies the number that uniquely identifies an item in .
Constraints: Not nullable, Maximum length: 5
purchasingOrganization
- Denotes the purchasing organization.
Constraints: Not nullable, Maximum length: 4
partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
plant
- Key uniquely identifying a plant.
Constraints: Not nullable, Maximum length: 4
supplierSubrange
- Subdivision of a supplier's overall product range according to various criteria.
Constraints: Not nullable, Maximum length: 6
partnerCounter
- The sequential number that the system applies when there is more than one partner for a particular
partner function.
Constraints: Not nullable, Maximum length: 3
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.Copyright © 2021 SAP SE. All rights reserved.