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

Interface SalesAndDistributionDocumentOrderReasonService

All Superinterfaces:

BatchService<SalesAndDistributionDocumentOrderReasonServiceBatch>

All Known Implementing Classes:

DefaultSalesAndDistributionDocumentOrderReasonService

public interface SalesAndDistributionDocumentOrderReasonService
extends BatchService<SalesAndDistributionDocumentOrderReasonServiceBatch>

The service contains four entities, from which Self- Billing Cockpit consumers can retrieve the order reason ID and description, retro- billing relevance of the order reason, as well as the related item type for self- billing processing.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SALES_DOCUMENT_REASON_SRV
API Version:	1
Communication Scenario:	SAP Self-Billing Cockpit Integration (SAP_COM_0564)
Scope Items:	Self-Billing - S/4HANA Backend Integration (4H2)
Authentication Methods:	Basic, x509
Business Object:	BillingDocument

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
RetroBillingUsageTextFluentHelper	getAllRetroBillingUsageText() Fetch multiple RetroBillingUsageText entities.
SDDocumentReasonFluentHelper	getAllSDDocumentReason() Fetch multiple SDDocumentReason entities.
SDDocumentReasonTextFluentHelper	getAllSDDocumentReasonText() Fetch multiple SDDocumentReasonText entities.
SelfBillingValueItemTextFluentHelper	getAllSelfBillingValueItemText() Fetch multiple SelfBillingValueItemText entities.
RetroBillingUsageTextByKeyFluentHelper	getRetroBillingUsageTextByKey(String retroBillingUsage, String language) Fetch a single RetroBillingUsageText entity using key fields.
SDDocumentReasonByKeyFluentHelper	getSDDocumentReasonByKey(String sDDocumentReason) Fetch a single SDDocumentReason entity using key fields.
SDDocumentReasonTextByKeyFluentHelper	getSDDocumentReasonTextByKey(String sDDocumentReason, String language) Fetch a single SDDocumentReasonText entity using key fields.
SelfBillingValueItemTextByKeyFluentHelper	getSelfBillingValueItemTextByKey(String selfBillingValueItem, String language) Fetch a single SelfBillingValueItemText entity using key fields.
SalesAndDistributionDocumentOrderReasonService	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
SalesAndDistributionDocumentOrderReasonService 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.

getAllRetroBillingUsageText

@Nonnull
RetroBillingUsageTextFluentHelper getAllRetroBillingUsageText()

Fetch multiple RetroBillingUsageText entities.

Returns:

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

getRetroBillingUsageTextByKey

@Nonnull
RetroBillingUsageTextByKeyFluentHelper getRetroBillingUsageTextByKey(String retroBillingUsage,
                                                                              String language)

Fetch a single RetroBillingUsageText entity using key fields.

Parameters:

retroBillingUsage - This indicator is only relevant if you specify the order reason in a credit/debit memo request or a credit/debit memo.

Constraints: Not nullable, Maximum length: 1

language - The language key contains the abbreviation for the language in which a text is stored. It controls the language in which texts are output on the printer or on the screen.

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllSDDocumentReason

@Nonnull
SDDocumentReasonFluentHelper getAllSDDocumentReason()

Fetch multiple SDDocumentReason entities.

Returns:

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

getSDDocumentReasonByKey

@Nonnull
SDDocumentReasonByKeyFluentHelper getSDDocumentReasonByKey(String sDDocumentReason)

Fetch a single SDDocumentReason entity using key fields.

Parameters:

sDDocumentReason - Indicates the reason for creating the sales document.

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllSDDocumentReasonText

@Nonnull
SDDocumentReasonTextFluentHelper getAllSDDocumentReasonText()

Fetch multiple SDDocumentReasonText entities.

Returns:

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

getSDDocumentReasonTextByKey

@Nonnull
SDDocumentReasonTextByKeyFluentHelper getSDDocumentReasonTextByKey(String sDDocumentReason,
                                                                            String language)

Fetch a single SDDocumentReasonText entity using key fields.

Parameters:

sDDocumentReason - Indicates the reason for creating the sales document.

Constraints: Not nullable, Maximum length: 3

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllSelfBillingValueItemText

@Nonnull
SelfBillingValueItemTextFluentHelper getAllSelfBillingValueItemText()

Fetch multiple SelfBillingValueItemText entities.

Returns:

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

getSelfBillingValueItemTextByKey

@Nonnull
SelfBillingValueItemTextByKeyFluentHelper getSelfBillingValueItemTextByKey(String selfBillingValueItem,
                                                                                    String language)

Fetch a single SelfBillingValueItemText entity using key fields.

Parameters:

language - The language key contains the abbreviation for the language in which a text is stored. It controls the language in which texts are output on the printer or on the screen.

Constraints: Not nullable, Maximum length: 2

selfBillingValueItem - Value Item for Self-Billing

Constraints: Not nullable, Maximum length: 1

Returns:

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