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

Interface SalesContractService

All Superinterfaces:
BatchService<SalesContractServiceBatch>
All Known Implementing Classes:
DefaultSalesContractService
@Deprecated public interface SalesContractService extends BatchService<SalesContractServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

The service contains header and item entities, as well as their sub-entities for partners and pricing elements. Once the sales contract has been created, the sales contract number is sent in the response with the data included in the sales contract. If there are any issues when creating, retrieving, updating, or deleting the sales contract, the system displays error messages in the response.

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_SALES_CONTRACT_SRV
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Sales Contract Integration(SAP_COM_0119)
Scope Items: Sales Contract Management(I9I)
Authentication Methods: x509
Business Object: Sales Contract

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull SalesContractService 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.

    • getAllSalesContract

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

    • getSalesContractByKey

      @Nonnull SalesContractByKeyFluentHelper getSalesContractByKey(String salesContract)
      Deprecated.
      Fetch a single SalesContract entity using key fields.
      Parameters:
      salesContract - Sales Contract

      Constraints: Not nullable, Maximum length: 10

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

    • createSalesContract

      @Nonnull SalesContractCreateFluentHelper createSalesContract(@Nonnull SalesContract salesContract)
      Deprecated.
      Create a new SalesContract entity and save it to the S/4HANA system.
      Parameters:
      salesContract - SalesContract entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new SalesContract entity. To perform execution, call the execute method on the fluent helper object.

    • updateSalesContract

      @Nonnull SalesContractUpdateFluentHelper updateSalesContract(@Nonnull SalesContract salesContract)
      Deprecated.
      Update an existing SalesContract entity and save it to the S/4HANA system.
      Parameters:
      salesContract - SalesContract entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesContract entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesContract

      @Nonnull SalesContractDeleteFluentHelper deleteSalesContract(@Nonnull SalesContract salesContract)
      Deprecated.
      Deletes an existing SalesContract entity in the S/4HANA system.
      Parameters:
      salesContract - SalesContract entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesContract entity. To perform execution, call the execute method on the fluent helper object.

    • getAllSalesContractItem

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

    • getSalesContractItemByKey

      @Nonnull SalesContractItemByKeyFluentHelper getSalesContractItemByKey(String salesContract, String salesContractItem)
      Deprecated.
      Fetch a single SalesContractItem entity using key fields.
      Parameters:
      salesContractItem - Sales Contract Item

      Constraints: Not nullable, Maximum length: 6

      salesContract - Sales Contract

      Constraints: Not nullable, Maximum length: 10

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

    • createSalesContractItem

      @Nonnull SalesContractItemCreateFluentHelper createSalesContractItem(@Nonnull SalesContractItem salesContractItem)
      Deprecated.
      Create a new SalesContractItem entity and save it to the S/4HANA system.
      Parameters:
      salesContractItem - SalesContractItem entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new SalesContractItem entity. To perform execution, call the execute method on the fluent helper object.

    • updateSalesContractItem

      @Nonnull SalesContractItemUpdateFluentHelper updateSalesContractItem(@Nonnull SalesContractItem salesContractItem)
      Deprecated.
      Update an existing SalesContractItem entity and save it to the S/4HANA system.
      Parameters:
      salesContractItem - SalesContractItem entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesContractItem entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesContractItem

      @Nonnull SalesContractItemDeleteFluentHelper deleteSalesContractItem(@Nonnull SalesContractItem salesContractItem)
      Deprecated.
      Deletes an existing SalesContractItem entity in the S/4HANA system.
      Parameters:
      salesContractItem - SalesContractItem entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesContractItem entity. To perform execution, call the execute method on the fluent helper object.

    • getAllSalesContractItemPartner

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

    • getSalesContractItemPartnerByKey

      @Nonnull SalesContractItemPartnerByKeyFluentHelper getSalesContractItemPartnerByKey(String salesContract, String salesContractItem, String partnerFunction)
      Deprecated.
      Fetch a single SalesContractItemPartner entity using key fields.
      Parameters:
      salesContractItem - Sales Contract Item

      Constraints: Not nullable, Maximum length: 6

      partnerFunction - Partner Function

      Constraints: Not nullable, Maximum length: 2

      salesContract - Sales Contract

      Constraints: Not nullable, Maximum length: 10

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

    • updateSalesContractItemPartner

      @Nonnull SalesContractItemPartnerUpdateFluentHelper updateSalesContractItemPartner(@Nonnull SalesContractItemPartner salesContractItemPartner)
      Deprecated.
      Update an existing SalesContractItemPartner entity and save it to the S/4HANA system.
      Parameters:
      salesContractItemPartner - SalesContractItemPartner entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesContractItemPartner entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesContractItemPartner

      @Nonnull SalesContractItemPartnerDeleteFluentHelper deleteSalesContractItemPartner(@Nonnull SalesContractItemPartner salesContractItemPartner)
      Deprecated.
      Deletes an existing SalesContractItemPartner entity in the S/4HANA system.
      Parameters:
      salesContractItemPartner - SalesContractItemPartner entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesContractItemPartner entity. To perform execution, call the execute method on the fluent helper object.

    • getAllSalesContractItemPrcgElmnt

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

    • getSalesContractItemPrcgElmntByKey

      @Nonnull SalesContractItemPrcgElmntByKeyFluentHelper getSalesContractItemPrcgElmntByKey(String salesContract, String salesContractItem, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single SalesContractItemPrcgElmnt entity using key fields.
      Parameters:
      salesContractItem - Sales Contract Item

      Constraints: Not nullable, Maximum length: 6

      salesContract - Sales Contract

      Constraints: Not nullable, Maximum length: 10

      pricingProcedureCounter - Condition Counter

      Constraints: Not nullable, Maximum length: 3

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

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

    • updateSalesContractItemPrcgElmnt

      @Nonnull SalesContractItemPrcgElmntUpdateFluentHelper updateSalesContractItemPrcgElmnt(@Nonnull SalesContractItemPrcgElmnt salesContractItemPrcgElmnt)
      Deprecated.
      Update an existing SalesContractItemPrcgElmnt entity and save it to the S/4HANA system.
      Parameters:
      salesContractItemPrcgElmnt - SalesContractItemPrcgElmnt entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesContractItemPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesContractItemPrcgElmnt

      @Nonnull SalesContractItemPrcgElmntDeleteFluentHelper deleteSalesContractItemPrcgElmnt(@Nonnull SalesContractItemPrcgElmnt salesContractItemPrcgElmnt)
      Deprecated.
      Deletes an existing SalesContractItemPrcgElmnt entity in the S/4HANA system.
      Parameters:
      salesContractItemPrcgElmnt - SalesContractItemPrcgElmnt entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesContractItemPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.

    • getAllSalesContractItemText

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

    • getSalesContractItemTextByKey

      @Nonnull SalesContractItemTextByKeyFluentHelper getSalesContractItemTextByKey(String salesContract, String salesContractItem, String language, String longTextID)
      Deprecated.
      Fetch a single SalesContractItemText entity using key fields.
      Parameters:
      salesContractItem - Sales Contract Item

      Constraints: Not nullable, Maximum length: 6

      salesContract - Sales Contract

      Constraints: Not nullable, Maximum length: 10

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      longTextID - Text ID

      Constraints: Not nullable, Maximum length: 4

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

    • updateSalesContractItemText

      @Nonnull SalesContractItemTextUpdateFluentHelper updateSalesContractItemText(@Nonnull SalesContractItemText salesContractItemText)
      Deprecated.
      Update an existing SalesContractItemText entity and save it to the S/4HANA system.
      Parameters:
      salesContractItemText - SalesContractItemText entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesContractItemText entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesContractItemText

      @Nonnull SalesContractItemTextDeleteFluentHelper deleteSalesContractItemText(@Nonnull SalesContractItemText salesContractItemText)
      Deprecated.
      Deletes an existing SalesContractItemText entity in the S/4HANA system.
      Parameters:
      salesContractItemText - SalesContractItemText entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesContractItemText entity. To perform execution, call the execute method on the fluent helper object.

    • getAllSalesContractPartner

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

    • getSalesContractPartnerByKey

      @Nonnull SalesContractPartnerByKeyFluentHelper getSalesContractPartnerByKey(String salesContract, String partnerFunction)
      Deprecated.
      Fetch a single SalesContractPartner entity using key fields.
      Parameters:
      partnerFunction - Partner Function

      Constraints: Not nullable, Maximum length: 2

      salesContract - Sales Contract

      Constraints: Not nullable, Maximum length: 10

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

    • createSalesContractPartner

      @Nonnull SalesContractPartnerCreateFluentHelper createSalesContractPartner(@Nonnull SalesContractPartner salesContractPartner)
      Deprecated.
      Create a new SalesContractPartner entity and save it to the S/4HANA system.
      Parameters:
      salesContractPartner - SalesContractPartner entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new SalesContractPartner entity. To perform execution, call the execute method on the fluent helper object.

    • updateSalesContractPartner

      @Nonnull SalesContractPartnerUpdateFluentHelper updateSalesContractPartner(@Nonnull SalesContractPartner salesContractPartner)
      Deprecated.
      Update an existing SalesContractPartner entity and save it to the S/4HANA system.
      Parameters:
      salesContractPartner - SalesContractPartner entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesContractPartner entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesContractPartner

      @Nonnull SalesContractPartnerDeleteFluentHelper deleteSalesContractPartner(@Nonnull SalesContractPartner salesContractPartner)
      Deprecated.
      Deletes an existing SalesContractPartner entity in the S/4HANA system.
      Parameters:
      salesContractPartner - SalesContractPartner entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesContractPartner entity. To perform execution, call the execute method on the fluent helper object.

    • getAllSalesContractPrcgElmnt

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

    • getSalesContractPrcgElmntByKey

      @Nonnull SalesContractPrcgElmntByKeyFluentHelper getSalesContractPrcgElmntByKey(String salesContract, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single SalesContractPrcgElmnt entity using key fields.
      Parameters:
      salesContract - Sales Contract

      Constraints: Not nullable, Maximum length: 10

      pricingProcedureCounter - Condition Counter

      Constraints: Not nullable, Maximum length: 3

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

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

    • updateSalesContractPrcgElmnt

      @Nonnull SalesContractPrcgElmntUpdateFluentHelper updateSalesContractPrcgElmnt(@Nonnull SalesContractPrcgElmnt salesContractPrcgElmnt)
      Deprecated.
      Update an existing SalesContractPrcgElmnt entity and save it to the S/4HANA system.
      Parameters:
      salesContractPrcgElmnt - SalesContractPrcgElmnt entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesContractPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesContractPrcgElmnt

      @Nonnull SalesContractPrcgElmntDeleteFluentHelper deleteSalesContractPrcgElmnt(@Nonnull SalesContractPrcgElmnt salesContractPrcgElmnt)
      Deprecated.
      Deletes an existing SalesContractPrcgElmnt entity in the S/4HANA system.
      Parameters:
      salesContractPrcgElmnt - SalesContractPrcgElmnt entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesContractPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.

    • getAllSalesContractText

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

    • getSalesContractTextByKey

      @Nonnull SalesContractTextByKeyFluentHelper getSalesContractTextByKey(String salesContract, String language, String longTextID)
      Deprecated.
      Fetch a single SalesContractText entity using key fields.
      Parameters:
      salesContract - Sales Contract

      Constraints: Not nullable, Maximum length: 10

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      longTextID - Text ID

      Constraints: Not nullable, Maximum length: 4

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

    • updateSalesContractText

      @Nonnull SalesContractTextUpdateFluentHelper updateSalesContractText(@Nonnull SalesContractText salesContractText)
      Deprecated.
      Update an existing SalesContractText entity and save it to the S/4HANA system.
      Parameters:
      salesContractText - SalesContractText entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesContractText entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesContractText

      @Nonnull SalesContractTextDeleteFluentHelper deleteSalesContractText(@Nonnull SalesContractText salesContractText)
      Deprecated.
      Deletes an existing SalesContractText entity in the S/4HANA system.
      Parameters:
      salesContractText - SalesContractText entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesContractText entity. To perform execution, call the execute method on the fluent helper object.

    • releaseApprovalRequest

      @Nonnull ReleaseApprovalRequestFluentHelper releaseApprovalRequest(@Nonnull String salesContract)
      Deprecated.

      Creates a fluent helper for the releaseApprovalRequest OData function import.

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

      Original parameter name from the Odata EDM: SalesContract

      Returns:
      A fluent helper object that will execute the releaseApprovalRequest OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

    • rejectApprovalRequest

      @Nonnull RejectApprovalRequestFluentHelper rejectApprovalRequest(@Nonnull String salesContract)
      Deprecated.

      Creates a fluent helper for the rejectApprovalRequest OData function import.

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

      Original parameter name from the Odata EDM: SalesContract

      Returns:
      A fluent helper object that will execute the rejectApprovalRequest OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.