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

Interface SalesContractService

All Known Implementing Classes:

DefaultSalesContractService

public interface SalesContractService

This service enables external applications to integrate with read read methods for processing sales contracts in SAP S/4HANA Cloud. It enables you to retrieve sales contracts in an API call.

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)
Business Object:	SalesContract

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getAllSalesContract

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

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.

getAllSalesContractItem

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

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.

getAllSalesContractItemPartner

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

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.

getAllSalesContractItemPrcgElmnt

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

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.

getAllSalesContractPartner

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

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.

getAllSalesContractPrcgElmnt

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

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.