SalesContractService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultSalesContractService

public interface SalesContractService

You can use this service to integrate external applications with sales contract processing in SAP S/4HANA Cloud. In every API call, you can make use of the following operations: - You can retrieve sales contracts. Apply any of the filters provided or retrieve all existing data. - You can create sales contracts. Note that you must use “deep insert” requests (a header plus the following entities: header partner, header pricing element, item, item partner, and item pricing element). You cannot create entities without including any related entities. - For existing sales contracts, you can create new items. Note that you must use “deep insert” requests (with the following entities: item partner and item pricing element). You cannot create entities without including any related entities. - For existing sales contracts, you can update the header, header partner, header pricing element, item, item partner, and item pricing element. - For existing sales contracts, you can delete the header, header partner, header pricing element, item, item partner, and item pricing element..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SALES_CONTRACT_SRV
API Version:	1
Communication Scenario:	Sales Contract Integration (SAP_COM_0119)
Scope Items:	Sales Contract Management (I9I)
Authentication Methods:	Basic, x509
Business Object:	SalesContract

Field Summary

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`SalesContractCreateFluentHelper`	`createSalesContract(SalesContract salesContract)` Create a new `SalesContract` entity and save it to the S/4HANA system.
`SalesContractItemCreateFluentHelper`	`createSalesContractItem(SalesContractItem salesContractItem)` Create a new `SalesContractItem` entity and save it to the S/4HANA system.
`SalesContractDeleteFluentHelper`	`deleteSalesContract(SalesContract salesContract)` Deletes an existing `SalesContract` entity in the S/4HANA system.
`SalesContractItemDeleteFluentHelper`	`deleteSalesContractItem(SalesContractItem salesContractItem)` Deletes an existing `SalesContractItem` entity in the S/4HANA system.
`SalesContractItemPartnerDeleteFluentHelper`	`deleteSalesContractItemPartner(SalesContractItemPartner salesContractItemPartner)` Deletes an existing `SalesContractItemPartner` entity in the S/4HANA system.
`SalesContractItemPrcgElmntDeleteFluentHelper`	`deleteSalesContractItemPrcgElmnt(SalesContractItemPrcgElmnt salesContractItemPrcgElmnt)` Deletes an existing `SalesContractItemPrcgElmnt` entity in the S/4HANA system.
`SalesContractPartnerDeleteFluentHelper`	`deleteSalesContractPartner(SalesContractPartner salesContractPartner)` Deletes an existing `SalesContractPartner` entity in the S/4HANA system.
`SalesContractPrcgElmntDeleteFluentHelper`	`deleteSalesContractPrcgElmnt(SalesContractPrcgElmnt salesContractPrcgElmnt)` Deletes an existing `SalesContractPrcgElmnt` entity in the S/4HANA system.
`SalesContractFluentHelper`	`getAllSalesContract()` Fetch multiple `SalesContract` entities.
`SalesContractItemFluentHelper`	`getAllSalesContractItem()` Fetch multiple `SalesContractItem` entities.
`SalesContractItemPartnerFluentHelper`	`getAllSalesContractItemPartner()` Fetch multiple `SalesContractItemPartner` entities.
`SalesContractItemPrcgElmntFluentHelper`	`getAllSalesContractItemPrcgElmnt()` Fetch multiple `SalesContractItemPrcgElmnt` entities.
`SalesContractPartnerFluentHelper`	`getAllSalesContractPartner()` Fetch multiple `SalesContractPartner` entities.
`SalesContractPrcgElmntFluentHelper`	`getAllSalesContractPrcgElmnt()` Fetch multiple `SalesContractPrcgElmnt` entities.
`SalesContractByKeyFluentHelper`	`getSalesContractByKey(String salesContract)` Fetch a single `SalesContract` entity using key fields.
`SalesContractItemByKeyFluentHelper`	`getSalesContractItemByKey(String salesContract, String salesContractItem)` Fetch a single `SalesContractItem` entity using key fields.
`SalesContractItemPartnerByKeyFluentHelper`	`getSalesContractItemPartnerByKey(String salesContract, String salesContractItem, String partnerFunction)` Fetch a single `SalesContractItemPartner` entity using key fields.
`SalesContractItemPrcgElmntByKeyFluentHelper`	`getSalesContractItemPrcgElmntByKey(String salesContract, String salesContractItem, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `SalesContractItemPrcgElmnt` entity using key fields.
`SalesContractPartnerByKeyFluentHelper`	`getSalesContractPartnerByKey(String salesContract, String partnerFunction)` Fetch a single `SalesContractPartner` entity using key fields.
`SalesContractPrcgElmntByKeyFluentHelper`	`getSalesContractPrcgElmntByKey(String salesContract, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `SalesContractPrcgElmnt` entity using key fields.
`SalesContractUpdateFluentHelper`	`updateSalesContract(SalesContract salesContract)` Update an existing `SalesContract` entity and save it to the S/4HANA system.
`SalesContractItemUpdateFluentHelper`	`updateSalesContractItem(SalesContractItem salesContractItem)` Update an existing `SalesContractItem` entity and save it to the S/4HANA system.
`SalesContractItemPartnerUpdateFluentHelper`	`updateSalesContractItemPartner(SalesContractItemPartner salesContractItemPartner)` Update an existing `SalesContractItemPartner` entity and save it to the S/4HANA system.
`SalesContractItemPrcgElmntUpdateFluentHelper`	`updateSalesContractItemPrcgElmnt(SalesContractItemPrcgElmnt salesContractItemPrcgElmnt)` Update an existing `SalesContractItemPrcgElmnt` entity and save it to the S/4HANA system.
`SalesContractPartnerUpdateFluentHelper`	`updateSalesContractPartner(SalesContractPartner salesContractPartner)` Update an existing `SalesContractPartner` entity and save it to the S/4HANA system.
`SalesContractPrcgElmntUpdateFluentHelper`	`updateSalesContractPrcgElmnt(SalesContractPrcgElmnt salesContractPrcgElmnt)` Update an existing `SalesContractPrcgElmnt` entity and save it to the S/4HANA system.
`SalesContractService`	`withServicePath(String servicePath)` Overrides the default service path and returns a new service instance with the specified service path.

- Field Detail
  - DEFAULT_SERVICE_PATH
```
static final 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.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - withServicePath
```
@Nonnull
SalesContractService withServicePath(@Nonnull
                                              String servicePath)
```
    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()
```
    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)
```
    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)
```
    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)
```
    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)
```
    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()
```
    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)
```
    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)
```
    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)
```
    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)
```
    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()
```
    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)
```
    Fetch a single SalesContractItemPartner entity using key fields.
    
    Parameters:
    
    salesContractItem - The number that uniquely identifies the item in the sales, shipping, or billing document.
    Constraints: Not nullable, Maximum length: 6
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    salesContract - The number that uniquely identifies the sales, delivery, or billing document.
    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)
```
    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)
```
    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()
```
    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)
```
    Fetch a single SalesContractItemPrcgElmnt entity using key fields.
    
    Parameters:
    
    salesContractItem - The number that uniquely identifies the condition item.
    Constraints: Not nullable, Maximum length: 6
    
    salesContract - The number that uniquely identifies the sales document.
    Constraints: Not nullable, Maximum length: 10
    
    pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.
    Constraints: Not nullable, Maximum length: 3
    
    pricingProcedureStep - Number that determines the sequence of the condition within a procedure.
    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)
```
    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)
```
    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.
  - getAllSalesContractPartner
```
@Nonnull
SalesContractPartnerFluentHelper getAllSalesContractPartner()
```
    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)
```
    Fetch a single SalesContractPartner entity using key fields.
    
    Parameters:
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    salesContract - Sales Order
    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.
  - updateSalesContractPartner
```
@Nonnull
SalesContractPartnerUpdateFluentHelper updateSalesContractPartner(@Nonnull
                                                                           SalesContractPartner salesContractPartner)
```
    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)
```
    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()
```
    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)
```
    Fetch a single SalesContractPrcgElmnt entity using key fields.
    
    Parameters:
    
    salesContract - The number that uniquely identifies the sales document.
    Constraints: Not nullable, Maximum length: 10
    
    pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.
    Constraints: Not nullable, Maximum length: 3
    
    pricingProcedureStep - Number that determines the sequence of the condition within a procedure.
    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)
```
    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)
```
    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.

Interface SalesContractService

Details:

Field Summary

Method Summary

Field Detail

DEFAULT_SERVICE_PATH

Method Detail

withServicePath

getAllSalesContract

getSalesContractByKey

createSalesContract

updateSalesContract

deleteSalesContract

getAllSalesContractItem

getSalesContractItemByKey

createSalesContractItem

updateSalesContractItem

deleteSalesContractItem

getAllSalesContractItemPartner

getSalesContractItemPartnerByKey

updateSalesContractItemPartner

deleteSalesContractItemPartner

getAllSalesContractItemPrcgElmnt

getSalesContractItemPrcgElmntByKey

updateSalesContractItemPrcgElmnt

deleteSalesContractItemPrcgElmnt

getAllSalesContractPartner

getSalesContractPartnerByKey

updateSalesContractPartner

deleteSalesContractPartner

getAllSalesContractPrcgElmnt

getSalesContractPrcgElmntByKey

updateSalesContractPrcgElmnt

deleteSalesContractPrcgElmnt