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

Interface SalesInquiryService

All Superinterfaces:

BatchService<SalesInquiryServiceBatch>

All Known Implementing Classes:

DefaultSalesInquiryService

public interface SalesInquiryService
extends BatchService<SalesInquiryServiceBatch>

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

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SALES_INQUIRY_SRV
API Version:	1
Communication Scenario:	Sales Inquiry Integration (SAP_COM_0117)
Scope Items:	Sales Inquiry (1IQ)
Authentication Methods:	Basic, x509
Business Object:	SalesInquiry

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

Modifier and Type	Method and Description
SalesInquiryFluentHelper	getAllSalesInquiry() Fetch multiple SalesInquiry entities.
SalesInquiryItemFluentHelper	getAllSalesInquiryItem() Fetch multiple SalesInquiryItem entities.
SalesInquiryItemPartnerFluentHelper	getAllSalesInquiryItemPartner() Fetch multiple SalesInquiryItemPartner entities.
SalesInquiryItemPrcgElmntFluentHelper	getAllSalesInquiryItemPrcgElmnt() Fetch multiple SalesInquiryItemPrcgElmnt entities.
SalesInquiryPartnerFluentHelper	getAllSalesInquiryPartner() Fetch multiple SalesInquiryPartner entities.
SalesInquiryPrcgElmntFluentHelper	getAllSalesInquiryPrcgElmnt() Fetch multiple SalesInquiryPrcgElmnt entities.
SalesInquiryByKeyFluentHelper	getSalesInquiryByKey(String salesInquiry) Fetch a single SalesInquiry entity using key fields.
SalesInquiryItemByKeyFluentHelper	getSalesInquiryItemByKey(String salesInquiry, String salesInquiryItem) Fetch a single SalesInquiryItem entity using key fields.
SalesInquiryItemPartnerByKeyFluentHelper	getSalesInquiryItemPartnerByKey(String salesInquiry, String salesInquiryItem, String partnerFunction) Fetch a single SalesInquiryItemPartner entity using key fields.
SalesInquiryItemPrcgElmntByKeyFluentHelper	getSalesInquiryItemPrcgElmntByKey(String salesInquiry, String salesInquiryItem, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single SalesInquiryItemPrcgElmnt entity using key fields.
SalesInquiryPartnerByKeyFluentHelper	getSalesInquiryPartnerByKey(String salesInquiry, String partnerFunction) Fetch a single SalesInquiryPartner entity using key fields.
SalesInquiryPrcgElmntByKeyFluentHelper	getSalesInquiryPrcgElmntByKey(String salesInquiry, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single SalesInquiryPrcgElmnt entity using key fields.
SalesInquiryService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

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

getAllSalesInquiry

@Nonnull
SalesInquiryFluentHelper getAllSalesInquiry()

Fetch multiple SalesInquiry entities.

Returns:

A fluent helper to fetch multiple SalesInquiry 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.

getSalesInquiryByKey

@Nonnull
SalesInquiryByKeyFluentHelper getSalesInquiryByKey(String salesInquiry)

Fetch a single SalesInquiry entity using key fields.

Parameters:

salesInquiry - Sales Inquiry

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllSalesInquiryItem

@Nonnull
SalesInquiryItemFluentHelper getAllSalesInquiryItem()

Fetch multiple SalesInquiryItem entities.

Returns:

A fluent helper to fetch multiple SalesInquiryItem 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.

getSalesInquiryItemByKey

@Nonnull
SalesInquiryItemByKeyFluentHelper getSalesInquiryItemByKey(String salesInquiry,
                                                                     String salesInquiryItem)

Fetch a single SalesInquiryItem entity using key fields.

Parameters:

salesInquiry - Sales Inquiry

Constraints: Not nullable, Maximum length: 10

salesInquiryItem - Sales Inquiry Item

Constraints: Not nullable, Maximum length: 6

Returns:

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

getAllSalesInquiryItemPartner

@Nonnull
SalesInquiryItemPartnerFluentHelper getAllSalesInquiryItemPartner()

Fetch multiple SalesInquiryItemPartner entities.

Returns:

A fluent helper to fetch multiple SalesInquiryItemPartner 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.

getSalesInquiryItemPartnerByKey

@Nonnull
SalesInquiryItemPartnerByKeyFluentHelper getSalesInquiryItemPartnerByKey(String salesInquiry,
                                                                                   String salesInquiryItem,
                                                                                   String partnerFunction)

Fetch a single SalesInquiryItemPartner entity using key fields.

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

Constraints: Not nullable, Maximum length: 2

salesInquiry - The number that uniquely identifies the sales, delivery, or billing document.

Constraints: Not nullable, Maximum length: 10

salesInquiryItem - The number that uniquely identifies the item in the sales, shipping, or billing document.

Constraints: Not nullable, Maximum length: 6

Returns:

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

getAllSalesInquiryItemPrcgElmnt

@Nonnull
SalesInquiryItemPrcgElmntFluentHelper getAllSalesInquiryItemPrcgElmnt()

Fetch multiple SalesInquiryItemPrcgElmnt entities.

Returns:

A fluent helper to fetch multiple SalesInquiryItemPrcgElmnt 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.

getSalesInquiryItemPrcgElmntByKey

@Nonnull
SalesInquiryItemPrcgElmntByKeyFluentHelper getSalesInquiryItemPrcgElmntByKey(String salesInquiry,
                                                                                       String salesInquiryItem,
                                                                                       String pricingProcedureStep,
                                                                                       String pricingProcedureCounter)

Fetch a single SalesInquiryItemPrcgElmnt entity using key fields.

Parameters:

pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.

Constraints: Not nullable, Maximum length: 3

salesInquiry - The number that uniquely identifies the sales document.

Constraints: Not nullable, Maximum length: 10

salesInquiryItem - The number that uniquely identifies the condition item.

Constraints: Not nullable, Maximum length: 6

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

getAllSalesInquiryPartner

@Nonnull
SalesInquiryPartnerFluentHelper getAllSalesInquiryPartner()

Fetch multiple SalesInquiryPartner entities.

Returns:

A fluent helper to fetch multiple SalesInquiryPartner 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.

getSalesInquiryPartnerByKey

@Nonnull
SalesInquiryPartnerByKeyFluentHelper getSalesInquiryPartnerByKey(String salesInquiry,
                                                                           String partnerFunction)

Fetch a single SalesInquiryPartner entity using key fields.

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

Constraints: Not nullable, Maximum length: 2

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

getAllSalesInquiryPrcgElmnt

@Nonnull
SalesInquiryPrcgElmntFluentHelper getAllSalesInquiryPrcgElmnt()

Fetch multiple SalesInquiryPrcgElmnt entities.

Returns:

A fluent helper to fetch multiple SalesInquiryPrcgElmnt 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.

getSalesInquiryPrcgElmntByKey

@Nonnull
SalesInquiryPrcgElmntByKeyFluentHelper getSalesInquiryPrcgElmntByKey(String salesInquiry,
                                                                               String pricingProcedureStep,
                                                                               String pricingProcedureCounter)

Fetch a single SalesInquiryPrcgElmnt entity using key fields.

Parameters:

pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.

Constraints: Not nullable, Maximum length: 3

salesInquiry - The number that uniquely identifies the sales document.

Constraints: Not nullable, Maximum length: 10

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