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

Interface SalesOrderWithoutChargeService

All Superinterfaces:

BatchService<SalesOrderWithoutChargeServiceBatch>

All Known Implementing Classes:

DefaultSalesOrderWithoutChargeService

public interface SalesOrderWithoutChargeService
extends BatchService<SalesOrderWithoutChargeServiceBatch>

In every API call, you can make use of the following operations: - You can read entire sales orders without charge or only parts of the data, using the provided filters. - You can create sales orders without charge. Note that you must use “deep insert” requests (a header plus the following entities: header partner, item and item partner). You cannot create entities without including any related entities. - For existing sales orders without charge, you can create new items. Note that you must use “deep insert” requests (with the entity: item partner). You cannot create entities without including any related entities. - For existing sales orders without charge, you can update the header, header partner, item and item partner. - For existing sales orders without charge, you can delete the header, header partner, item and item partner..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SALES_ORDER_WITHOUT_CHARGE_SRV
API Version:	1
Communication Scenario:	Sales Order Without Charge Integration (SAP_COM_0334)
Scope Items:	Free of Charge Delivery (BDA)
Authentication Methods:	Basic, x509
Business Object:	SalesOrderWithoutCharge

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
SalesOrderWithoutChargeCreateFluentHelper	createSalesOrderWithoutCharge(SalesOrderWithoutCharge salesOrderWithoutCharge) Create a new SalesOrderWithoutCharge entity and save it to the S/4HANA system.
SalesOrderWithoutChargeItemCreateFluentHelper	createSalesOrderWithoutChargeItem(SalesOrderWithoutChargeItem salesOrderWithoutChargeItem) Create a new SalesOrderWithoutChargeItem entity and save it to the S/4HANA system.
SalesOrderWithoutChargeDeleteFluentHelper	deleteSalesOrderWithoutCharge(SalesOrderWithoutCharge salesOrderWithoutCharge) Deletes an existing SalesOrderWithoutCharge entity in the S/4HANA system.
SalesOrderWithoutChargeItemDeleteFluentHelper	deleteSalesOrderWithoutChargeItem(SalesOrderWithoutChargeItem salesOrderWithoutChargeItem) Deletes an existing SalesOrderWithoutChargeItem entity in the S/4HANA system.
SlsOrdWthoutChrgItmPartnerDeleteFluentHelper	deleteSlsOrdWthoutChrgItmPartner(SlsOrdWthoutChrgItmPartner slsOrdWthoutChrgItmPartner) Deletes an existing SlsOrdWthoutChrgItmPartner entity in the S/4HANA system.
SlsOrdWthoutChrgPartnerDeleteFluentHelper	deleteSlsOrdWthoutChrgPartner(SlsOrdWthoutChrgPartner slsOrdWthoutChrgPartner) Deletes an existing SlsOrdWthoutChrgPartner entity in the S/4HANA system.
SalesOrderWithoutChargeFluentHelper	getAllSalesOrderWithoutCharge() Fetch multiple SalesOrderWithoutCharge entities.
SalesOrderWithoutChargeItemFluentHelper	getAllSalesOrderWithoutChargeItem() Fetch multiple SalesOrderWithoutChargeItem entities.
SlsOrdWthoutChrgItmPartnerFluentHelper	getAllSlsOrdWthoutChrgItmPartner() Fetch multiple SlsOrdWthoutChrgItmPartner entities.
SlsOrdWthoutChrgPartnerFluentHelper	getAllSlsOrdWthoutChrgPartner() Fetch multiple SlsOrdWthoutChrgPartner entities.
SlsOrdWthoutChrgSchedLineFluentHelper	getAllSlsOrdWthoutChrgSchedLine() Fetch multiple SlsOrdWthoutChrgSchedLine entities.
SalesOrderWithoutChargeByKeyFluentHelper	getSalesOrderWithoutChargeByKey(String salesOrderWithoutCharge) Fetch a single SalesOrderWithoutCharge entity using key fields.
SalesOrderWithoutChargeItemByKeyFluentHelper	getSalesOrderWithoutChargeItemByKey(String salesOrderWithoutCharge, String salesOrderWithoutChargeItem) Fetch a single SalesOrderWithoutChargeItem entity using key fields.
SlsOrdWthoutChrgItmPartnerByKeyFluentHelper	getSlsOrdWthoutChrgItmPartnerByKey(String salesOrderWithoutCharge, String salesOrderWithoutChargeItem, String partnerFunction) Fetch a single SlsOrdWthoutChrgItmPartner entity using key fields.
SlsOrdWthoutChrgPartnerByKeyFluentHelper	getSlsOrdWthoutChrgPartnerByKey(String salesOrderWithoutCharge, String partnerFunction) Fetch a single SlsOrdWthoutChrgPartner entity using key fields.
SlsOrdWthoutChrgSchedLineByKeyFluentHelper	getSlsOrdWthoutChrgSchedLineByKey(String salesOrderWithoutCharge, String salesOrderWithoutChargeItem, String scheduleLine) Fetch a single SlsOrdWthoutChrgSchedLine entity using key fields.
SalesOrderWithoutChargeUpdateFluentHelper	updateSalesOrderWithoutCharge(SalesOrderWithoutCharge salesOrderWithoutCharge) Update an existing SalesOrderWithoutCharge entity and save it to the S/4HANA system.
SalesOrderWithoutChargeItemUpdateFluentHelper	updateSalesOrderWithoutChargeItem(SalesOrderWithoutChargeItem salesOrderWithoutChargeItem) Update an existing SalesOrderWithoutChargeItem entity and save it to the S/4HANA system.
SlsOrdWthoutChrgItmPartnerUpdateFluentHelper	updateSlsOrdWthoutChrgItmPartner(SlsOrdWthoutChrgItmPartner slsOrdWthoutChrgItmPartner) Update an existing SlsOrdWthoutChrgItmPartner entity and save it to the S/4HANA system.
SlsOrdWthoutChrgPartnerUpdateFluentHelper	updateSlsOrdWthoutChrgPartner(SlsOrdWthoutChrgPartner slsOrdWthoutChrgPartner) Update an existing SlsOrdWthoutChrgPartner entity and save it to the S/4HANA system.
SalesOrderWithoutChargeService	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
SalesOrderWithoutChargeService 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.

getAllSalesOrderWithoutCharge

@Nonnull
SalesOrderWithoutChargeFluentHelper getAllSalesOrderWithoutCharge()

Fetch multiple SalesOrderWithoutCharge entities.

Returns:

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

getSalesOrderWithoutChargeByKey

@Nonnull
SalesOrderWithoutChargeByKeyFluentHelper getSalesOrderWithoutChargeByKey(String salesOrderWithoutCharge)

Fetch a single SalesOrderWithoutCharge entity using key fields.

Parameters:

salesOrderWithoutCharge - Sales Order Without Charge

Constraints: Not nullable, Maximum length: 10

Returns:

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

createSalesOrderWithoutCharge

@Nonnull
SalesOrderWithoutChargeCreateFluentHelper createSalesOrderWithoutCharge(@Nonnull
                                                                                 SalesOrderWithoutCharge salesOrderWithoutCharge)

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

Parameters:

salesOrderWithoutCharge - SalesOrderWithoutCharge entity object that will be created in the S/4HANA system.

Returns:

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

updateSalesOrderWithoutCharge

@Nonnull
SalesOrderWithoutChargeUpdateFluentHelper updateSalesOrderWithoutCharge(@Nonnull
                                                                                 SalesOrderWithoutCharge salesOrderWithoutCharge)

Update an existing SalesOrderWithoutCharge entity and save it to the S/4HANA system.

Parameters:

salesOrderWithoutCharge - SalesOrderWithoutCharge entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing SalesOrderWithoutCharge entity. To perform execution, call the execute method on the fluent helper object.

deleteSalesOrderWithoutCharge

@Nonnull
SalesOrderWithoutChargeDeleteFluentHelper deleteSalesOrderWithoutCharge(@Nonnull
                                                                                 SalesOrderWithoutCharge salesOrderWithoutCharge)

Deletes an existing SalesOrderWithoutCharge entity in the S/4HANA system.

Parameters:

salesOrderWithoutCharge - SalesOrderWithoutCharge entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing SalesOrderWithoutCharge entity. To perform execution, call the execute method on the fluent helper object.

getAllSalesOrderWithoutChargeItem

@Nonnull
SalesOrderWithoutChargeItemFluentHelper getAllSalesOrderWithoutChargeItem()

Fetch multiple SalesOrderWithoutChargeItem entities.

Returns:

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

getSalesOrderWithoutChargeItemByKey

@Nonnull
SalesOrderWithoutChargeItemByKeyFluentHelper getSalesOrderWithoutChargeItemByKey(String salesOrderWithoutCharge,
                                                                                          String salesOrderWithoutChargeItem)

Fetch a single SalesOrderWithoutChargeItem entity using key fields.

Parameters:

salesOrderWithoutChargeItem - The number that uniquely identifies the item in the sales document.

Constraints: Not nullable, Maximum length: 6

salesOrderWithoutCharge - The number that uniquely identifies the sales document.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createSalesOrderWithoutChargeItem

@Nonnull
SalesOrderWithoutChargeItemCreateFluentHelper createSalesOrderWithoutChargeItem(@Nonnull
                                                                                         SalesOrderWithoutChargeItem salesOrderWithoutChargeItem)

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

Parameters:

salesOrderWithoutChargeItem - SalesOrderWithoutChargeItem entity object that will be created in the S/4HANA system.

Returns:

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

updateSalesOrderWithoutChargeItem

@Nonnull
SalesOrderWithoutChargeItemUpdateFluentHelper updateSalesOrderWithoutChargeItem(@Nonnull
                                                                                         SalesOrderWithoutChargeItem salesOrderWithoutChargeItem)

Update an existing SalesOrderWithoutChargeItem entity and save it to the S/4HANA system.

Parameters:

salesOrderWithoutChargeItem - SalesOrderWithoutChargeItem entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing SalesOrderWithoutChargeItem entity. To perform execution, call the execute method on the fluent helper object.

deleteSalesOrderWithoutChargeItem

@Nonnull
SalesOrderWithoutChargeItemDeleteFluentHelper deleteSalesOrderWithoutChargeItem(@Nonnull
                                                                                         SalesOrderWithoutChargeItem salesOrderWithoutChargeItem)

Deletes an existing SalesOrderWithoutChargeItem entity in the S/4HANA system.

Parameters:

salesOrderWithoutChargeItem - SalesOrderWithoutChargeItem entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing SalesOrderWithoutChargeItem entity. To perform execution, call the execute method on the fluent helper object.

getAllSlsOrdWthoutChrgItmPartner

@Nonnull
SlsOrdWthoutChrgItmPartnerFluentHelper getAllSlsOrdWthoutChrgItmPartner()

Fetch multiple SlsOrdWthoutChrgItmPartner entities.

Returns:

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

getSlsOrdWthoutChrgItmPartnerByKey

@Nonnull
SlsOrdWthoutChrgItmPartnerByKeyFluentHelper getSlsOrdWthoutChrgItmPartnerByKey(String salesOrderWithoutCharge,
                                                                                        String salesOrderWithoutChargeItem,
                                                                                        String partnerFunction)

Fetch a single SlsOrdWthoutChrgItmPartner entity using key fields.

Parameters:

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

Constraints: Not nullable, Maximum length: 2

salesOrderWithoutChargeItem - Sales Order Without Charge Item

Constraints: Not nullable, Maximum length: 6

salesOrderWithoutCharge - Sales Order Without Charge

Constraints: Not nullable, Maximum length: 10

Returns:

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

updateSlsOrdWthoutChrgItmPartner

@Nonnull
SlsOrdWthoutChrgItmPartnerUpdateFluentHelper updateSlsOrdWthoutChrgItmPartner(@Nonnull
                                                                                       SlsOrdWthoutChrgItmPartner slsOrdWthoutChrgItmPartner)

Update an existing SlsOrdWthoutChrgItmPartner entity and save it to the S/4HANA system.

Parameters:

slsOrdWthoutChrgItmPartner - SlsOrdWthoutChrgItmPartner entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing SlsOrdWthoutChrgItmPartner entity. To perform execution, call the execute method on the fluent helper object.

deleteSlsOrdWthoutChrgItmPartner

@Nonnull
SlsOrdWthoutChrgItmPartnerDeleteFluentHelper deleteSlsOrdWthoutChrgItmPartner(@Nonnull
                                                                                       SlsOrdWthoutChrgItmPartner slsOrdWthoutChrgItmPartner)

Deletes an existing SlsOrdWthoutChrgItmPartner entity in the S/4HANA system.

Parameters:

slsOrdWthoutChrgItmPartner - SlsOrdWthoutChrgItmPartner entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing SlsOrdWthoutChrgItmPartner entity. To perform execution, call the execute method on the fluent helper object.

getAllSlsOrdWthoutChrgPartner

@Nonnull
SlsOrdWthoutChrgPartnerFluentHelper getAllSlsOrdWthoutChrgPartner()

Fetch multiple SlsOrdWthoutChrgPartner entities.

Returns:

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

getSlsOrdWthoutChrgPartnerByKey

@Nonnull
SlsOrdWthoutChrgPartnerByKeyFluentHelper getSlsOrdWthoutChrgPartnerByKey(String salesOrderWithoutCharge,
                                                                                  String partnerFunction)

Fetch a single SlsOrdWthoutChrgPartner entity using key fields.

Parameters:

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

Constraints: Not nullable, Maximum length: 2

salesOrderWithoutCharge - Sales Order Without Charge

Constraints: Not nullable, Maximum length: 10

Returns:

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

updateSlsOrdWthoutChrgPartner

@Nonnull
SlsOrdWthoutChrgPartnerUpdateFluentHelper updateSlsOrdWthoutChrgPartner(@Nonnull
                                                                                 SlsOrdWthoutChrgPartner slsOrdWthoutChrgPartner)

Update an existing SlsOrdWthoutChrgPartner entity and save it to the S/4HANA system.

Parameters:

slsOrdWthoutChrgPartner - SlsOrdWthoutChrgPartner entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing SlsOrdWthoutChrgPartner entity. To perform execution, call the execute method on the fluent helper object.

deleteSlsOrdWthoutChrgPartner

@Nonnull
SlsOrdWthoutChrgPartnerDeleteFluentHelper deleteSlsOrdWthoutChrgPartner(@Nonnull
                                                                                 SlsOrdWthoutChrgPartner slsOrdWthoutChrgPartner)

Deletes an existing SlsOrdWthoutChrgPartner entity in the S/4HANA system.

Parameters:

slsOrdWthoutChrgPartner - SlsOrdWthoutChrgPartner entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing SlsOrdWthoutChrgPartner entity. To perform execution, call the execute method on the fluent helper object.

getAllSlsOrdWthoutChrgSchedLine

@Nonnull
SlsOrdWthoutChrgSchedLineFluentHelper getAllSlsOrdWthoutChrgSchedLine()

Fetch multiple SlsOrdWthoutChrgSchedLine entities.

Returns:

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

getSlsOrdWthoutChrgSchedLineByKey

@Nonnull
SlsOrdWthoutChrgSchedLineByKeyFluentHelper getSlsOrdWthoutChrgSchedLineByKey(String salesOrderWithoutCharge,
                                                                                      String salesOrderWithoutChargeItem,
                                                                                      String scheduleLine)

Fetch a single SlsOrdWthoutChrgSchedLine entity using key fields.

Parameters:

salesOrderWithoutChargeItem - The number that uniquely identifies the item in the sales document.

Constraints: Not nullable, Maximum length: 6

scheduleLine - The number that uniquely identifies the schedule line in the sales document.

Constraints: Not nullable, Maximum length: 4

salesOrderWithoutCharge - The number that uniquely identifies the sales document.

Constraints: Not nullable, Maximum length: 10

Returns:

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