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

Interface SettlementDocumentTypeService

All Known Implementing Classes:

DefaultSettlementDocumentTypeService

public interface SettlementDocumentTypeService

You retrieve the following data using this OData based service: You can read the Settlement Document Types and related information. You can navigate to the Header Text Object Type Assignment for a Settlement Document Type and read the assigned Text Determination Procedure and all the possible Text Object Types linked to it on header level. You can navigate to the Item Text Object Type Assignment for a Settlement Document Type and read the assigned Text Determination Procedure and all the possible Text Object Types linked to it on item level. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_SETTLMT_DOC_TYPE_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Settlement Document Type

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<SetlMgmtHdrTxtObjTypeAssgmt>	countSetlMgmtHdrTxtObjTypeAssgmt() Fetch the number of entries from the SetlMgmtHdrTxtObjTypeAssgmt entity collection matching the filter and search expressions.
CountRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt>	countSetlMgmtItmTxtObjTypeAssgmt() Fetch the number of entries from the SetlMgmtItmTxtObjTypeAssgmt 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.
GetAllRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt>	getAllSetlMgmtHdrTxtObjTypeAssgmt() Fetch multiple SetlMgmtHdrTxtObjTypeAssgmt entities.
GetAllRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt>	getAllSetlMgmtItmTxtObjTypeAssgmt() Fetch multiple SetlMgmtItmTxtObjTypeAssgmt entities.
GetAllRequestBuilder<SettlmtDocType>	getAllSettlmtDocType() Fetch multiple SettlmtDocType entities.
GetByKeyRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt>	getSetlMgmtHdrTxtObjTypeAssgmtByKey(String settlmtHdrTxtDetnProced, String settlmtMgmtHdrTxtObjType) Fetch a single SetlMgmtHdrTxtObjTypeAssgmt entity using key fields.
GetByKeyRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt>	getSetlMgmtItmTxtObjTypeAssgmtByKey(String settlmtItmTxtDetnProced, String settlmtMgmtItmTxtObjType) Fetch a single SetlMgmtItmTxtObjTypeAssgmt entity using key fields.
GetByKeyRequestBuilder<SettlmtDocType>	getSettlmtDocTypeByKey(String settlmtDocType) Fetch a single SettlmtDocType entity using key fields.
SettlementDocumentTypeService	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
SettlementDocumentTypeService 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.

getAllSetlMgmtHdrTxtObjTypeAssgmt

@Nonnull
GetAllRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt> getAllSetlMgmtHdrTxtObjTypeAssgmt()

Fetch multiple SetlMgmtHdrTxtObjTypeAssgmt entities.

Returns:

A fluent helper to fetch multiple SetlMgmtHdrTxtObjTypeAssgmt 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 request builder object.

countSetlMgmtHdrTxtObjTypeAssgmt

@Nonnull
CountRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt> countSetlMgmtHdrTxtObjTypeAssgmt()

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

Returns:

A fluent helper to fetch the count of SetlMgmtHdrTxtObjTypeAssgmt 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 request builder object.

getSetlMgmtHdrTxtObjTypeAssgmtByKey

@Nonnull
GetByKeyRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt> getSetlMgmtHdrTxtObjTypeAssgmtByKey(@Nonnull
                                                                                                 String settlmtHdrTxtDetnProced,
                                                                                                 @Nonnull
                                                                                                 String settlmtMgmtHdrTxtObjType)

Fetch a single SetlMgmtHdrTxtObjTypeAssgmt entity using key fields.

Parameters:

settlmtMgmtHdrTxtObjType - Specific Text ID for a Settlement Management Document Header

Constraints: Not nullable, Maximum length: 4

settlmtHdrTxtDetnProced - Text Determination Procedure for Header

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single SetlMgmtHdrTxtObjTypeAssgmt 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 request builder object.

getAllSetlMgmtItmTxtObjTypeAssgmt

@Nonnull
GetAllRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt> getAllSetlMgmtItmTxtObjTypeAssgmt()

Fetch multiple SetlMgmtItmTxtObjTypeAssgmt entities.

Returns:

A fluent helper to fetch multiple SetlMgmtItmTxtObjTypeAssgmt 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 request builder object.

countSetlMgmtItmTxtObjTypeAssgmt

@Nonnull
CountRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt> countSetlMgmtItmTxtObjTypeAssgmt()

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

Returns:

A fluent helper to fetch the count of SetlMgmtItmTxtObjTypeAssgmt 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 request builder object.

getSetlMgmtItmTxtObjTypeAssgmtByKey

@Nonnull
GetByKeyRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt> getSetlMgmtItmTxtObjTypeAssgmtByKey(@Nonnull
                                                                                                 String settlmtItmTxtDetnProced,
                                                                                                 @Nonnull
                                                                                                 String settlmtMgmtItmTxtObjType)

Fetch a single SetlMgmtItmTxtObjTypeAssgmt entity using key fields.

Parameters:

settlmtMgmtItmTxtObjType - Specific Text ID for a Settlement Management Document Item

Constraints: Not nullable, Maximum length: 4

settlmtItmTxtDetnProced - Text Determination Procedure for Item

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single SetlMgmtItmTxtObjTypeAssgmt 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 request builder object.

getAllSettlmtDocType

@Nonnull
GetAllRequestBuilder<SettlmtDocType> getAllSettlmtDocType()

Fetch multiple SettlmtDocType entities.

Returns:

A fluent helper to fetch multiple SettlmtDocType 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 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 fluent helper to fetch the count of SettlmtDocType 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 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 fluent helper to fetch a single SettlmtDocType 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 request builder object.