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

Interface SalesOrderSimulateService

All Superinterfaces:

BatchService<SalesOrderSimulateServiceBatch>

All Known Implementing Classes:

DefaultSalesOrderSimulateService

public interface SalesOrderSimulateService
extends BatchService<SalesOrderSimulateServiceBatch>

The API gives you information about pricing, material availability, and the customer's credit limit. The response is provided synchronously. The simulated sales order is not saved.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_SALES_ORDER_SIMULATION_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Sales Order

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
SalesOrderSimulationCreateFluentHelper	createSalesOrderSimulation(SalesOrderSimulation salesOrderSimulation) Create a new SalesOrderSimulation entity and save it to the S/4HANA system.
SalesOrderCreditSimulationFluentHelper	getAllSalesOrderCreditSimulation() Fetch multiple SalesOrderCreditSimulation entities.
SalesOrderItemPartnerSimlnFluentHelper	getAllSalesOrderItemPartnerSimln() Fetch multiple SalesOrderItemPartnerSimln entities.
SalesOrderItemSimulationFluentHelper	getAllSalesOrderItemSimulation() Fetch multiple SalesOrderItemSimulation entities.
SalesOrderItmPrcgElmntSimlnFluentHelper	getAllSalesOrderItmPrcgElmntSimln() Fetch multiple SalesOrderItmPrcgElmntSimln entities.
SalesOrderPartnerSimulationFluentHelper	getAllSalesOrderPartnerSimulation() Fetch multiple SalesOrderPartnerSimulation entities.
SalesOrderPrcgElmntSimlnFluentHelper	getAllSalesOrderPrcgElmntSimln() Fetch multiple SalesOrderPrcgElmntSimln entities.
SalesOrderPricingSimulationFluentHelper	getAllSalesOrderPricingSimulation() Fetch multiple SalesOrderPricingSimulation entities.
SalesOrderScheduleLineSimlnFluentHelper	getAllSalesOrderScheduleLineSimln() Fetch multiple SalesOrderScheduleLineSimln entities.
SalesOrderSimulationFluentHelper	getAllSalesOrderSimulation() Fetch multiple SalesOrderSimulation entities.
SalesOrderCreditSimulationByKeyFluentHelper	getSalesOrderCreditSimulationByKey(String salesOrder) Fetch a single SalesOrderCreditSimulation entity using key fields.
SalesOrderItemPartnerSimlnByKeyFluentHelper	getSalesOrderItemPartnerSimlnByKey(String salesOrder, String salesOrderItem, String partnerFunction) Fetch a single SalesOrderItemPartnerSimln entity using key fields.
SalesOrderItemSimulationByKeyFluentHelper	getSalesOrderItemSimulationByKey(String salesOrder, String salesOrderItem) Fetch a single SalesOrderItemSimulation entity using key fields.
SalesOrderItmPrcgElmntSimlnByKeyFluentHelper	getSalesOrderItmPrcgElmntSimlnByKey(String salesOrder, String salesOrderItem, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single SalesOrderItmPrcgElmntSimln entity using key fields.
SalesOrderPartnerSimulationByKeyFluentHelper	getSalesOrderPartnerSimulationByKey(String salesOrder, String partnerFunction) Fetch a single SalesOrderPartnerSimulation entity using key fields.
SalesOrderPrcgElmntSimlnByKeyFluentHelper	getSalesOrderPrcgElmntSimlnByKey(String salesOrder, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single SalesOrderPrcgElmntSimln entity using key fields.
SalesOrderPricingSimulationByKeyFluentHelper	getSalesOrderPricingSimulationByKey(String salesOrder) Fetch a single SalesOrderPricingSimulation entity using key fields.
SalesOrderScheduleLineSimlnByKeyFluentHelper	getSalesOrderScheduleLineSimlnByKey(String salesOrder, String salesOrderItem, String scheduleLine) Fetch a single SalesOrderScheduleLineSimln entity using key fields.
SalesOrderSimulationByKeyFluentHelper	getSalesOrderSimulationByKey(String salesOrder) Fetch a single SalesOrderSimulation entity using key fields.
SalesOrderSimulateService	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
SalesOrderSimulateService 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.

getAllSalesOrderCreditSimulation

@Nonnull
SalesOrderCreditSimulationFluentHelper getAllSalesOrderCreditSimulation()

Fetch multiple SalesOrderCreditSimulation entities.

Returns:

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

getSalesOrderCreditSimulationByKey

@Nonnull
SalesOrderCreditSimulationByKeyFluentHelper getSalesOrderCreditSimulationByKey(String salesOrder)

Fetch a single SalesOrderCreditSimulation entity using key fields.

Parameters:

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllSalesOrderItemPartnerSimln

@Nonnull
SalesOrderItemPartnerSimlnFluentHelper getAllSalesOrderItemPartnerSimln()

Fetch multiple SalesOrderItemPartnerSimln entities.

Returns:

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

getSalesOrderItemPartnerSimlnByKey

@Nonnull
SalesOrderItemPartnerSimlnByKeyFluentHelper getSalesOrderItemPartnerSimlnByKey(String salesOrder,
                                                                                        String salesOrderItem,
                                                                                        String partnerFunction)

Fetch a single SalesOrderItemPartnerSimln entity using key fields.

Parameters:

partnerFunction - Partner Function

Constraints: Not nullable, Maximum length: 2

salesOrderItem - Sales Order Item

Constraints: Not nullable, Maximum length: 6

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllSalesOrderItemSimulation

@Nonnull
SalesOrderItemSimulationFluentHelper getAllSalesOrderItemSimulation()

Fetch multiple SalesOrderItemSimulation entities.

Returns:

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

getSalesOrderItemSimulationByKey

@Nonnull
SalesOrderItemSimulationByKeyFluentHelper getSalesOrderItemSimulationByKey(String salesOrder,
                                                                                    String salesOrderItem)

Fetch a single SalesOrderItemSimulation entity using key fields.

Parameters:

salesOrderItem - Sales Order Item

Constraints: Not nullable, Maximum length: 6

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllSalesOrderItmPrcgElmntSimln

@Nonnull
SalesOrderItmPrcgElmntSimlnFluentHelper getAllSalesOrderItmPrcgElmntSimln()

Fetch multiple SalesOrderItmPrcgElmntSimln entities.

Returns:

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

getSalesOrderItmPrcgElmntSimlnByKey

@Nonnull
SalesOrderItmPrcgElmntSimlnByKeyFluentHelper getSalesOrderItmPrcgElmntSimlnByKey(String salesOrder,
                                                                                          String salesOrderItem,
                                                                                          String pricingProcedureStep,
                                                                                          String pricingProcedureCounter)

Fetch a single SalesOrderItmPrcgElmntSimln entity using key fields.

Parameters:

salesOrderItem - Sales Order Item

Constraints: Not nullable, Maximum length: 6

pricingProcedureCounter - Condition Counter

Constraints: Not nullable, Maximum length: 3

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Step Number

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllSalesOrderPartnerSimulation

@Nonnull
SalesOrderPartnerSimulationFluentHelper getAllSalesOrderPartnerSimulation()

Fetch multiple SalesOrderPartnerSimulation entities.

Returns:

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

getSalesOrderPartnerSimulationByKey

@Nonnull
SalesOrderPartnerSimulationByKeyFluentHelper getSalesOrderPartnerSimulationByKey(String salesOrder,
                                                                                          String partnerFunction)

Fetch a single SalesOrderPartnerSimulation entity using key fields.

Parameters:

partnerFunction - Partner Function

Constraints: Not nullable, Maximum length: 2

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllSalesOrderPrcgElmntSimln

@Nonnull
SalesOrderPrcgElmntSimlnFluentHelper getAllSalesOrderPrcgElmntSimln()

Fetch multiple SalesOrderPrcgElmntSimln entities.

Returns:

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

getSalesOrderPrcgElmntSimlnByKey

@Nonnull
SalesOrderPrcgElmntSimlnByKeyFluentHelper getSalesOrderPrcgElmntSimlnByKey(String salesOrder,
                                                                                    String pricingProcedureStep,
                                                                                    String pricingProcedureCounter)

Fetch a single SalesOrderPrcgElmntSimln entity using key fields.

Parameters:

pricingProcedureCounter - Condition Counter

Constraints: Not nullable, Maximum length: 3

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Step Number

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllSalesOrderPricingSimulation

@Nonnull
SalesOrderPricingSimulationFluentHelper getAllSalesOrderPricingSimulation()

Fetch multiple SalesOrderPricingSimulation entities.

Returns:

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

getSalesOrderPricingSimulationByKey

@Nonnull
SalesOrderPricingSimulationByKeyFluentHelper getSalesOrderPricingSimulationByKey(String salesOrder)

Fetch a single SalesOrderPricingSimulation entity using key fields.

Parameters:

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllSalesOrderScheduleLineSimln

@Nonnull
SalesOrderScheduleLineSimlnFluentHelper getAllSalesOrderScheduleLineSimln()

Fetch multiple SalesOrderScheduleLineSimln entities.

Returns:

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

getSalesOrderScheduleLineSimlnByKey

@Nonnull
SalesOrderScheduleLineSimlnByKeyFluentHelper getSalesOrderScheduleLineSimlnByKey(String salesOrder,
                                                                                          String salesOrderItem,
                                                                                          String scheduleLine)

Fetch a single SalesOrderScheduleLineSimln entity using key fields.

Parameters:

salesOrderItem - Sales Document Item

Constraints: Not nullable, Maximum length: 6

scheduleLine - Schedule Line Number

Constraints: Not nullable, Maximum length: 4

salesOrder - Sales Document

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllSalesOrderSimulation

@Nonnull
SalesOrderSimulationFluentHelper getAllSalesOrderSimulation()

Fetch multiple SalesOrderSimulation entities.

Returns:

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

getSalesOrderSimulationByKey

@Nonnull
SalesOrderSimulationByKeyFluentHelper getSalesOrderSimulationByKey(String salesOrder)

Fetch a single SalesOrderSimulation entity using key fields.

Parameters:

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

createSalesOrderSimulation

@Nonnull
SalesOrderSimulationCreateFluentHelper createSalesOrderSimulation(@Nonnull
                                                                           SalesOrderSimulation salesOrderSimulation)

Create a new SalesOrderSimulation entity and save it to the S/4HANA system.

Parameters:

salesOrderSimulation - SalesOrderSimulation entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new SalesOrderSimulation entity. To perform execution, call the execute method on the fluent helper object.