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 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 |
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. |
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull PurchaseContractService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull PurchaseContractFluentHelper getAllPurchaseContract()
PurchaseContract
entities.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 PurchaseContractByKeyFluentHelper getPurchaseContractByKey(String purchaseContract)
PurchaseContract
entity using key fields.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 PurchaseContractCreateFluentHelper createPurchaseContract(@Nonnull PurchaseContract purchaseContract)
PurchaseContract
entity and save it to the S/4HANA system.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 PurchaseContractItemFluentHelper getAllPurchaseContractItem()
PurchaseContractItem
entities.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 PurchaseContractItemByKeyFluentHelper getPurchaseContractItemByKey(String purchaseContract, String purchaseContractItem)
PurchaseContractItem
entity using key fields.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 PurContrItemConditionFluentHelper getAllPurContrItemCondition()
PurContrItemCondition
entities.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 PurContrItemConditionByKeyFluentHelper getPurContrItemConditionByKey(String purchaseContract, String purchaseContractItem, LocalDateTime conditionValidityEndDate, String conditionType, String conditionRecord, String conditionSequentialNumber)
PurContrItemCondition
entity using key fields.conditionSequentialNumber
- The sequential number that uniquely identifies the condition if a condition supplement exists.
Constraints: Not nullable, Maximum length: 2
conditionValidityEndDate
- purchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
conditionType
- The key that uniquely identifies the condition.
Constraints: Not nullable, Maximum length: 4
purchaseContractItem
- Specifies the number that uniquely identifies an item in .
Constraints: Not nullable, Maximum length: 5
conditionRecord
- Number that uniquely identifies a condition record.
Constraints: Not nullable, Maximum length: 10
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 PurCtrAccountFluentHelper getAllPurCtrAccount()
PurCtrAccount
entities.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 PurCtrAccountByKeyFluentHelper getPurCtrAccountByKey(String accountAssignment, String purchaseContractItem, String purchaseContract)
PurCtrAccount
entity using key fields.purchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
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
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 PurCtrAddressFluentHelper getAllPurCtrAddress()
PurCtrAddress
entities.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 PurCtrAddressByKeyFluentHelper getPurCtrAddressByKey(String purchaseContract, String addressID, String purchaseContractItem)
PurCtrAddress
entity using key fields.purchaseContract
- Purchasing Contract Header
Constraints: Not nullable, Maximum length: 10
purchaseContractItem
- Item Number of Purchasing Contract
Constraints: Not nullable, Maximum length: 5
addressID
- Internal key for identifying a Business Address Services address.
Constraints: Not nullable, Maximum length: 10
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 PurCtrPartnersFluentHelper getAllPurCtrPartners()
PurCtrPartners
entities.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 PurCtrPartnersByKeyFluentHelper getPurCtrPartnersByKey(String purchaseContract, String purchaseContractItem, String purchasingOrganization, String partnerFunction, String plant, String supplierSubrange, String partnerCounter)
PurCtrPartners
entity using key fields.partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
purchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
plant
- Key uniquely identifying a plant.
Constraints: Not nullable, Maximum length: 4
purchasingOrganization
- Denotes the purchasing organization.
Constraints: Not nullable, Maximum length: 4
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
purchaseContractItem
- Specifies the number that uniquely identifies an item in .
Constraints: Not nullable, Maximum length: 5
supplierSubrange
- Subdivision of a supplier's overall product range according to various criteria.
Constraints: Not nullable, Maximum length: 6
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.