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

Interface SettlementProcessTypeService

All Known Implementing Classes:

DefaultSettlementProcessTypeService

public interface SettlementProcessTypeService

You retrieve the following data using this OData based service: You can read the Settlement Process Types and related information. You can navigate to the Application Status Assignment for a Settlement Process Type and read the assigned Application Status Group and all the possible Application Statuses linked to it. You can navigate to the Settlement Document Type Assignment for a Settlement Process Type and read the assigned Settlement Document Types for the relevant Settlement Process Type. You can also read further information regarding the Settlement Document Types..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	SETTLMTPROCESSTYPE_0001
API Version:	1
Communication Scenario:	Logistics - Settlement Process Type Integration (SAP_COM_0710)
Scope Items:	Sales Rebate Processing (1B6), Purchasing Rebate Processing (2R7), Sales Commissions - External Sales Representative (2TT), Internal Commissions Settlement with SAP Sales Cloud (3TD)
Authentication Methods:	Basic, x509
Service Group Name:	API_SETTLMT_PROC_TYPE
Business Object:	SettlementProcessType

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
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<SettlmtApplStsGrpStsAssgmt>	countSettlmtApplStsGrpStsAssgmt() Fetch the number of entries from the SettlmtApplStsGrpStsAssgmt entity collection matching the filter and search expressions.
CountRequestBuilder<SettlmtDocProcTypeAssgmt>	countSettlmtDocProcTypeAssgmt() Fetch the number of entries from the SettlmtDocProcTypeAssgmt entity collection matching the filter and search expressions.
CountRequestBuilder<SettlmtDocType>	countSettlmtDocType() Fetch the number of entries from the SettlmtDocType entity collection matching the filter and search expressions.
CountRequestBuilder<SettlmtProcessType>	countSettlmtProcessType() Fetch the number of entries from the SettlmtProcessType entity collection matching the filter and search expressions.
GetAllRequestBuilder<SettlmtApplStsGrpStsAssgmt>	getAllSettlmtApplStsGrpStsAssgmt() Fetch multiple SettlmtApplStsGrpStsAssgmt entities.
GetAllRequestBuilder<SettlmtDocProcTypeAssgmt>	getAllSettlmtDocProcTypeAssgmt() Fetch multiple SettlmtDocProcTypeAssgmt entities.
GetAllRequestBuilder<SettlmtDocType>	getAllSettlmtDocType() Fetch multiple SettlmtDocType entities.
GetAllRequestBuilder<SettlmtProcessType>	getAllSettlmtProcessType() Fetch multiple SettlmtProcessType entities.
GetByKeyRequestBuilder<SettlmtApplStsGrpStsAssgmt>	getSettlmtApplStsGrpStsAssgmtByKey(String settlmtApplStsGrp, String settlmtApplSts) Fetch a single SettlmtApplStsGrpStsAssgmt entity using key fields.
GetByKeyRequestBuilder<SettlmtDocProcTypeAssgmt>	getSettlmtDocProcTypeAssgmtByKey(String settlmtProcessType, String settlmtDocType) Fetch a single SettlmtDocProcTypeAssgmt entity using key fields.
GetByKeyRequestBuilder<SettlmtDocType>	getSettlmtDocTypeByKey(String settlmtDocType) Fetch a single SettlmtDocType entity using key fields.
GetByKeyRequestBuilder<SettlmtProcessType>	getSettlmtProcessTypeByKey(String settlmtProcessType) Fetch a single SettlmtProcessType entity using key fields.
SettlementProcessTypeService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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

batch

@Nonnull
BatchRequestBuilder batch()

Creates a batch request builder object.

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllSettlmtApplStsGrpStsAssgmt

@Nonnull
GetAllRequestBuilder<SettlmtApplStsGrpStsAssgmt> getAllSettlmtApplStsGrpStsAssgmt()

Fetch multiple SettlmtApplStsGrpStsAssgmt entities.

Returns:

A request builder to fetch multiple SettlmtApplStsGrpStsAssgmt entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countSettlmtApplStsGrpStsAssgmt

@Nonnull
CountRequestBuilder<SettlmtApplStsGrpStsAssgmt> countSettlmtApplStsGrpStsAssgmt()

Fetch the number of entries from the SettlmtApplStsGrpStsAssgmt entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of SettlmtApplStsGrpStsAssgmt entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSettlmtApplStsGrpStsAssgmtByKey

@Nonnull
GetByKeyRequestBuilder<SettlmtApplStsGrpStsAssgmt> getSettlmtApplStsGrpStsAssgmtByKey(@Nonnull
                                                                                               String settlmtApplStsGrp,
                                                                                               @Nonnull
                                                                                               String settlmtApplSts)

Fetch a single SettlmtApplStsGrpStsAssgmt entity using key fields.

Parameters:

settlmtApplStsGrp - Status Group for Settlement Management Documents

Constraints: Not nullable, Maximum length: 4

settlmtApplSts - Application Status for a Settlement Management Document

Constraints: Not nullable, Maximum length: 4

Returns:

A request builder to fetch a single SettlmtApplStsGrpStsAssgmt entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getAllSettlmtDocProcTypeAssgmt

@Nonnull
GetAllRequestBuilder<SettlmtDocProcTypeAssgmt> getAllSettlmtDocProcTypeAssgmt()

Fetch multiple SettlmtDocProcTypeAssgmt entities.

Returns:

A request builder to fetch multiple SettlmtDocProcTypeAssgmt entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countSettlmtDocProcTypeAssgmt

@Nonnull
CountRequestBuilder<SettlmtDocProcTypeAssgmt> countSettlmtDocProcTypeAssgmt()

Fetch the number of entries from the SettlmtDocProcTypeAssgmt entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of SettlmtDocProcTypeAssgmt entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSettlmtDocProcTypeAssgmtByKey

@Nonnull
GetByKeyRequestBuilder<SettlmtDocProcTypeAssgmt> getSettlmtDocProcTypeAssgmtByKey(@Nonnull
                                                                                           String settlmtProcessType,
                                                                                           @Nonnull
                                                                                           String settlmtDocType)

Fetch a single SettlmtDocProcTypeAssgmt entity using key fields.

Parameters:

settlmtDocType - Settlement Document Type

Constraints: Not nullable, Maximum length: 4

settlmtProcessType - Settlement Process Type

Constraints: Not nullable, Maximum length: 4

Returns:

A request builder to fetch a single SettlmtDocProcTypeAssgmt entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getAllSettlmtDocType

@Nonnull
GetAllRequestBuilder<SettlmtDocType> getAllSettlmtDocType()

Fetch multiple SettlmtDocType entities.

Returns:

A request builder to fetch multiple SettlmtDocType entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countSettlmtDocType

@Nonnull
CountRequestBuilder<SettlmtDocType> countSettlmtDocType()

Fetch the number of entries from the SettlmtDocType entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of SettlmtDocType entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSettlmtDocTypeByKey

@Nonnull
GetByKeyRequestBuilder<SettlmtDocType> getSettlmtDocTypeByKey(@Nonnull
                                                                       String settlmtDocType)

Fetch a single SettlmtDocType entity using key fields.

Parameters:

settlmtDocType - Settlement Document Type

Constraints: Not nullable, Maximum length: 4

Returns:

A request builder to fetch a single SettlmtDocType entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getAllSettlmtProcessType

@Nonnull
GetAllRequestBuilder<SettlmtProcessType> getAllSettlmtProcessType()

Fetch multiple SettlmtProcessType entities.

Returns:

A request builder to fetch multiple SettlmtProcessType entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countSettlmtProcessType

@Nonnull
CountRequestBuilder<SettlmtProcessType> countSettlmtProcessType()

Fetch the number of entries from the SettlmtProcessType entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of SettlmtProcessType entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSettlmtProcessTypeByKey

@Nonnull
GetByKeyRequestBuilder<SettlmtProcessType> getSettlmtProcessTypeByKey(@Nonnull
                                                                               String settlmtProcessType)

Fetch a single SettlmtProcessType entity using key fields.

Parameters:

settlmtProcessType - Settlement Process Type

Constraints: Not nullable, Maximum length: 4

Returns:

A request builder to fetch a single SettlmtProcessType entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.