public interface CentralPurchaseContractService extends BatchService<CentralPurchaseContractServiceBatch>
This service is based on the OData protocol. It allows purchasers from various parts of the company at different locations to take advantage of the negotiated global agreement with suppliers. This service contains header, item, item distribution entities, distribution messages, header notes, item notes, and version history.
Reference: SAP API Business Hub
OData Service: | API_CENTRAL_PURCHASECONTRACT_SRV |
API Version: | 1 |
Communication Scenario: | SAP S/4HANA Procurement Hub - Central Contract Management Integration (SAP_COM_0243) |
Scope Items: | Central Purchase Contracts (2ME) |
Authentication Methods: | Basic, x509 |
Business Object: | CentralPurchaseContract |
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 CentralPurchaseContractService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull CentralPurchaseContractFluentHelper getAllCentralPurchaseContract()
CentralPurchaseContract
entities.CentralPurchaseContract
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 CentralPurchaseContractByKeyFluentHelper getCentralPurchaseContractByKey(String centralPurchaseContract)
CentralPurchaseContract
entity using key fields.centralPurchaseContract
- The active purchasing document number of a purchasing document.
Constraints: Not nullable, Maximum length: 10
CentralPurchaseContract
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 CentralPurchaseContractCreateFluentHelper createCentralPurchaseContract(@Nonnull CentralPurchaseContract centralPurchaseContract)
CentralPurchaseContract
entity and save it to the S/4HANA system.centralPurchaseContract
- CentralPurchaseContract
entity object that will be created in the S/4HANA system.CentralPurchaseContract
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CntrlPurchaseContractItemFluentHelper getAllCntrlPurchaseContractItem()
CntrlPurchaseContractItem
entities.CntrlPurchaseContractItem
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 CntrlPurchaseContractItemByKeyFluentHelper getCntrlPurchaseContractItemByKey(String centralPurchaseContract, String centralPurchaseContractItem)
CntrlPurchaseContractItem
entity using key fields.centralPurchaseContract
- Central Purchase Contract
Constraints: Not nullable, Maximum length: 10
centralPurchaseContractItem
- Central Purchase Contract Item
Constraints: Not nullable, Maximum length: 5
CntrlPurchaseContractItem
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 CntrlPurContractHeaderNotesFluentHelper getAllCntrlPurContractHeaderNotes()
CntrlPurContractHeaderNotes
entities.CntrlPurContractHeaderNotes
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 CntrlPurContractHeaderNotesByKeyFluentHelper getCntrlPurContractHeaderNotesByKey(String purchasingDocumentNoteObjectID, String purchasingDocumentNoteType, String purchasingDocumentNoteLanguage)
CntrlPurContractHeaderNotes
entity using key fields.purchasingDocumentNoteLanguage
- Language
Constraints: Not nullable, Maximum length: 2
purchasingDocumentNoteObjectID
- Application Object ID
Constraints: Not nullable, Maximum length: 90
purchasingDocumentNoteType
- Name of Note Type
Constraints: Not nullable, Maximum length: 20
CntrlPurContractHeaderNotes
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 CntrlPurContractItemNotesFluentHelper getAllCntrlPurContractItemNotes()
CntrlPurContractItemNotes
entities.CntrlPurContractItemNotes
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 CntrlPurContractItemNotesByKeyFluentHelper getCntrlPurContractItemNotesByKey(String purchasingDocumentNoteObjectID, String purchasingDocumentNoteType, String purchasingDocumentNoteLanguage)
CntrlPurContractItemNotes
entity using key fields.purchasingDocumentNoteLanguage
- Language
Constraints: Not nullable, Maximum length: 2
purchasingDocumentNoteObjectID
- Application Object ID
Constraints: Not nullable, Maximum length: 90
purchasingDocumentNoteType
- Name of Note Type
Constraints: Not nullable, Maximum length: 20
CntrlPurContractItemNotes
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 CntrlPurContrDistrMessagesFluentHelper getAllCntrlPurContrDistrMessages()
CntrlPurContrDistrMessages
entities.CntrlPurContrDistrMessages
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 CntrlPurContrDistrMessagesByKeyFluentHelper getCntrlPurContrDistrMessagesByKey(String sequenceNumber, UUID distrResponseMessageUUID)
CntrlPurContrDistrMessages
entity using key fields.sequenceNumber
- Sequence No. of Message during Contract Distribution
Constraints: Not nullable, Maximum length: 4
distrResponseMessageUUID
- Generic Data Element for GUID Fields (X16)
Constraints: Not nullable
CntrlPurContrDistrMessages
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 CntrlPurContrHdrDistributionFluentHelper getAllCntrlPurContrHdrDistribution()
CntrlPurContrHdrDistribution
entities.CntrlPurContrHdrDistribution
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 CntrlPurContrHdrDistributionByKeyFluentHelper getCntrlPurContrHdrDistributionByKey(String centralPurchaseContract, String distributionKey)
CntrlPurContrHdrDistribution
entity using key fields.distributionKey
- Distribution Number of Central Purchasing Document
Constraints: Not nullable, Maximum length: 4
centralPurchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
CntrlPurContrHdrDistribution
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 CntrlPurContrHeaderPartnerFluentHelper getAllCntrlPurContrHeaderPartner()
CntrlPurContrHeaderPartner
entities.CntrlPurContrHeaderPartner
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 CntrlPurContrHeaderPartnerByKeyFluentHelper getCntrlPurContrHeaderPartnerByKey(String centralPurchaseContract, String distributionKey, String partnerCounter)
CntrlPurContrHeaderPartner
entity using key fields.distributionKey
- Distribution Number of Central Purchasing Document
Constraints: Not nullable, Maximum length: 4
centralPurchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
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
CntrlPurContrHeaderPartner
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 CntrlPurContrItemPartnerFluentHelper getAllCntrlPurContrItemPartner()
CntrlPurContrItemPartner
entities.CntrlPurContrItemPartner
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 CntrlPurContrItemPartnerByKeyFluentHelper getCntrlPurContrItemPartnerByKey(String centralPurchaseContract, String centralPurchaseContractItem, String distributionKey, String partnerCounter)
CntrlPurContrItemPartner
entity using key fields.distributionKey
- Distribution Number of Central Purchasing Document
Constraints: Not nullable, Maximum length: 4
centralPurchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
centralPurchaseContractItem
- Specifies the number that uniquely identifies an item in .
Constraints: Not nullable, Maximum length: 5
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
CntrlPurContrItemPartner
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 CntrlPurContrItmCndnAmountFluentHelper getAllCntrlPurContrItmCndnAmount()
CntrlPurContrItmCndnAmount
entities.CntrlPurContrItmCndnAmount
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 CntrlPurContrItmCndnAmountByKeyFluentHelper getCntrlPurContrItmCndnAmountByKey(String centralPurchaseContract, String centralPurchaseContractItem, String conditionRecord, LocalDateTime conditionValidityEndDate, String conditionSequentialNumber)
CntrlPurContrItmCndnAmount
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
- The date up to which the condition is valid.
Constraints: Not nullable, Precision: 0
centralPurchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
centralPurchaseContractItem
- 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
CntrlPurContrItmCndnAmount
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 CntrlPurContrItmCndnScalesFluentHelper getAllCntrlPurContrItmCndnScales()
CntrlPurContrItmCndnScales
entities.CntrlPurContrItmCndnScales
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 CntrlPurContrItmCndnScalesByKeyFluentHelper getCntrlPurContrItmCndnScalesByKey(String centralPurchaseContract, String centralPurchaseContractItem, String conditionRecord, String conditionSequentialNumber, LocalDateTime conditionValidityEndDate, String conditionScaleLine)
CntrlPurContrItmCndnScales
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
- The date up to which the condition is valid.
Constraints: Not nullable, Precision: 0
centralPurchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
centralPurchaseContractItem
- 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
conditionScaleLine
- Identifies the sequence of lines within a scale.
Constraints: Not nullable, Maximum length: 4
CntrlPurContrItmCndnScales
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 CntrlPurContrItmCndnValdtyFluentHelper getAllCntrlPurContrItmCndnValdty()
CntrlPurContrItmCndnValdty
entities.CntrlPurContrItmCndnValdty
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 CntrlPurContrItmCndnValdtyByKeyFluentHelper getCntrlPurContrItmCndnValdtyByKey(String centralPurchaseContract, String centralPurchaseContractItem, String conditionRecord, LocalDateTime conditionValidityEndDate)
CntrlPurContrItmCndnValdty
entity using key fields.conditionValidityEndDate
- The date up to which the condition is valid.
Constraints: Not nullable, Precision: 0
centralPurchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
centralPurchaseContractItem
- 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
CntrlPurContrItmCndnValdty
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 CntrlPurContrItmDistributionFluentHelper getAllCntrlPurContrItmDistribution()
CntrlPurContrItmDistribution
entities.CntrlPurContrItmDistribution
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 CntrlPurContrItmDistributionByKeyFluentHelper getCntrlPurContrItmDistributionByKey(String centralPurchaseContract, String centralPurchaseContractItem, String distributionKey)
CntrlPurContrItmDistribution
entity using key fields.distributionKey
- Distribution Number of Central Purchasing Document
Constraints: Not nullable, Maximum length: 4
centralPurchaseContract
- Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
centralPurchaseContractItem
- Specifies the number that uniquely identifies an item in .
Constraints: Not nullable, Maximum length: 5
CntrlPurContrItmDistribution
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 CntrlPurContrLegalTransFluentHelper getAllCntrlPurContrLegalTrans()
CntrlPurContrLegalTrans
entities.CntrlPurContrLegalTrans
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 CntrlPurContrLegalTransByKeyFluentHelper getCntrlPurContrLegalTransByKey(String centralPurchaseContract, String legalTransaction)
CntrlPurContrLegalTrans
entity using key fields.centralPurchaseContract
- Central Purchase Contract
Constraints: Not nullable, Maximum length: 10
legalTransaction
- Legal Transaction ID
Constraints: Not nullable, Maximum length: 10
CntrlPurContrLegalTrans
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 CntrlPurContrVersionHistoryFluentHelper getAllCntrlPurContrVersionHistory()
CntrlPurContrVersionHistory
entities.CntrlPurContrVersionHistory
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 CntrlPurContrVersionHistoryByKeyFluentHelper getCntrlPurContrVersionHistoryByKey(String centralPurchaseContract, String purchasingDocumentVersion)
CntrlPurContrVersionHistory
entity using key fields.purchasingDocumentVersion
- Number uniquely identifying a version of a purchasing document.
Constraints: Not nullable, Maximum length: 8
centralPurchaseContract
- The active purchasing document number of a purchasing document.
Constraints: Not nullable, Maximum length: 10
CntrlPurContrVersionHistory
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 SubordinateCntrlContractFluentHelper getAllSubordinateCntrlContract()
SubordinateCntrlContract
entities.SubordinateCntrlContract
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 SubordinateCntrlContractByKeyFluentHelper getSubordinateCntrlContractByKey(String purchasingParentDocument, String subordCntrlPurContract, String procmtHubCompanyCodeGroupingID)
SubordinateCntrlContract
entity using key fields.purchasingParentDocument
- The parent document ID of a subordinate purchasing document.
Constraints: Not nullable, Maximum length: 10
subordCntrlPurContract
- The active purchasing document number of a purchasing document.
Constraints: Not nullable, Maximum length: 10
procmtHubCompanyCodeGroupingID
- The ID of the collection under which company codes of different connected systems are grouped.
Constraints: Not nullable, Maximum length: 3
SubordinateCntrlContract
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 WithdrawFromApprovalFluentHelper withdrawFromApproval(@Nonnull String centralPurchaseContract)
Creates a fluent helper for the WithdrawFromApproval OData function import.
centralPurchaseContract
- Central Purchase Contract
Constraints: none
Original parameter name from the Odata EDM: CentralPurchaseContract
execute
method on the fluent helper object.@Nonnull AssignLegalTransactionFluentHelper assignLegalTransaction(@Nonnull String legalTransactionId, @Nonnull String centralPurchaseContract)
Creates a fluent helper for the AssignLegalTransaction OData function import.
centralPurchaseContract
- Constraints: none
Original parameter name from the Odata EDM: CentralPurchaseContract
legalTransactionId
- Constraints: none
Original parameter name from the Odata EDM: LegalTransactionId
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.