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

Interface PurchaseContractService

All Superinterfaces:
BatchService<PurchaseContractServiceBatch>
All Known Implementing Classes:
DefaultPurchaseContractService
@Deprecated public interface PurchaseContractService extends BatchService<PurchaseContractServiceBatch>
Deprecated.
The service and all its related classes are deprecated as of release 2202 (Feb 2022). Please use the odata generator to generate the VDM.

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. .

Business Documentation

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 Details

  • Method Details

    • withServicePath

      @Nonnull PurchaseContractService withServicePath(@Nonnull String servicePath)
      Deprecated.
      Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.

    • getAllPurchaseContract

      @Nonnull PurchaseContractFluentHelper getAllPurchaseContract()
      Deprecated.
      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

      @Nonnull PurchaseContractByKeyFluentHelper getPurchaseContractByKey(String purchaseContract)
      Deprecated.
      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

      @Nonnull PurchaseContractCreateFluentHelper createPurchaseContract(@Nonnull PurchaseContract purchaseContract)
      Deprecated.
      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

      @Nonnull PurchaseContractUpdateFluentHelper updatePurchaseContract(@Nonnull PurchaseContract purchaseContract)
      Deprecated.
      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.

    • getAllPurchaseContractItem

      @Nonnull PurchaseContractItemFluentHelper getAllPurchaseContractItem()
      Deprecated.
      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

      @Nonnull PurchaseContractItemByKeyFluentHelper getPurchaseContractItemByKey(String purchaseContract, String purchaseContractItem)
      Deprecated.
      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

      @Nonnull PurchaseContractItemCreateFluentHelper createPurchaseContractItem(@Nonnull PurchaseContractItem purchaseContractItem)
      Deprecated.
      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

      @Nonnull PurchaseContractItemUpdateFluentHelper updatePurchaseContractItem(@Nonnull PurchaseContractItem purchaseContractItem)
      Deprecated.
      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.

    • getAllPurContrItemCondition

      @Nonnull PurContrItemConditionFluentHelper getAllPurContrItemCondition()
      Deprecated.
      Fetch multiple PurContrItemCondition entities.
      Returns:
      A fluent helper to fetch multiple 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.

    • getPurContrItemConditionByKey

      @Nonnull PurContrItemConditionByKeyFluentHelper getPurContrItemConditionByKey(String purchaseContract, String purchaseContractItem, LocalDateTime conditionValidityEndDate, String conditionType, String conditionRecord, String conditionSequentialNumber)
      Deprecated.
      Fetch a single PurContrItemCondition entity using key fields.
      Parameters:
      conditionSequentialNumber - Sequential number of the condition

      Constraints: Not nullable, Maximum length: 2

      conditionValidityEndDate -
      purchaseContract - Purchasing Document Number

      Constraints: Not nullable, Maximum length: 10

      conditionType - Condition Type

      Constraints: Not nullable, Maximum length: 4

      purchaseContractItem - Item Number of Purchasing Document

      Constraints: Not nullable, Maximum length: 5

      conditionRecord - Number of Condition Record

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A fluent helper to fetch a single 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.

    • getAllPurCtrAccount

      @Nonnull PurCtrAccountFluentHelper getAllPurCtrAccount()
      Deprecated.
      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

      @Nonnull PurCtrAccountByKeyFluentHelper getPurCtrAccountByKey(String accountAssignment, String purchaseContractItem, String purchaseContract)
      Deprecated.
      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

      @Nonnull PurCtrAccountCreateFluentHelper createPurCtrAccount(@Nonnull PurCtrAccount purCtrAccount)
      Deprecated.
      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

      @Nonnull PurCtrAccountUpdateFluentHelper updatePurCtrAccount(@Nonnull PurCtrAccount purCtrAccount)
      Deprecated.
      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.

    • getAllPurCtrAddress

      @Nonnull PurCtrAddressFluentHelper getAllPurCtrAddress()
      Deprecated.
      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

      @Nonnull PurCtrAddressByKeyFluentHelper getPurCtrAddressByKey(String purchaseContract, String addressID, String purchaseContractItem)
      Deprecated.
      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

      @Nonnull PurCtrAddressCreateFluentHelper createPurCtrAddress(@Nonnull PurCtrAddress purCtrAddress)
      Deprecated.
      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

      @Nonnull PurCtrAddressUpdateFluentHelper updatePurCtrAddress(@Nonnull PurCtrAddress purCtrAddress)
      Deprecated.
      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.

    • getAllPurCtrPartners

      @Nonnull PurCtrPartnersFluentHelper getAllPurCtrPartners()
      Deprecated.
      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

      @Nonnull PurCtrPartnersByKeyFluentHelper getPurCtrPartnersByKey(String purchaseContract, String purchaseContractItem, String purchasingOrganization, String partnerFunction, String plant, String supplierSubrange, String partnerCounter)
      Deprecated.
      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

      @Nonnull PurCtrPartnersCreateFluentHelper createPurCtrPartners(@Nonnull PurCtrPartners purCtrPartners)
      Deprecated.
      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

      @Nonnull PurCtrPartnersUpdateFluentHelper updatePurCtrPartners(@Nonnull PurCtrPartners purCtrPartners)
      Deprecated.
      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.

    • withdrawFromApproval

      @Nonnull WithdrawFromApprovalFluentHelper withdrawFromApproval(@Nonnull String purchaseContract)
      Deprecated.

      Creates a fluent helper for the WithdrawFromApproval OData function import.

      Parameters:
      purchaseContract - Constraints: Not nullable, Maximum length: 10

      Original 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 execute method on the fluent helper object.

    • rejectDocument

      @Nonnull RejectDocumentFluentHelper rejectDocument(@Nonnull String purchaseContract)
      Deprecated.

      Creates a fluent helper for the RejectDocument OData function import.

      Parameters:
      purchaseContract - Constraints: Not nullable, Maximum length: 10

      Original 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 execute method on the fluent helper object.

    • approveDocument

      @Nonnull ApproveDocumentFluentHelper approveDocument(@Nonnull String purchaseContract)
      Deprecated.

      Creates a fluent helper for the ApproveDocument OData function import.

      Parameters:
      purchaseContract - Constraints: Not nullable, Maximum length: 10

      Original 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 execute method on the fluent helper object.