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

Interface SettlementDocumentService

All Known Implementing Classes:

DefaultSettlementDocumentService

public interface SettlementDocumentService

You retrieve the following data using this OData based service: You can read the Settlement Document related information at both on header and item level. You can release Settlement Documents on header level which were blocked to accounting and where the Application Status was not set. You can reverse Settlement Documents. .

Business Documentation

Reference: SAP API Business Hub

Details:

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

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<SetlDoc>	countSetlDoc() Fetch the number of entries from the SetlDoc entity collection matching the filter and search expressions.
CountRequestBuilder<SetlDocItm>	countSetlDocItm() Fetch the number of entries from the SetlDocItm entity collection matching the filter and search expressions.
CreateRequestBuilder<SetlDoc>	createSetlDoc(SetlDoc setlDoc) Create a new SetlDoc entity and save it to the S/4HANA system.
CreateRequestBuilder<SetlDocItm>	createSetlDocItm(SetlDocItm setlDocItm) Create a new SetlDocItm entity and save it to the S/4HANA system.
GetAllRequestBuilder<SetlDoc>	getAllSetlDoc() Fetch multiple SetlDoc entities.
GetAllRequestBuilder<SetlDocItm>	getAllSetlDocItm() Fetch multiple SetlDocItm entities.
GetByKeyRequestBuilder<SetlDoc>	getSetlDocByKey(String settlmtDoc) Fetch a single SetlDoc entity using key fields.
GetByKeyRequestBuilder<SetlDocItm>	getSetlDocItmByKey(String settlmtDoc, String settlmtDocItem) Fetch a single SetlDocItm entity using key fields.
SettlementDocumentService	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
SettlementDocumentService 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.

getAllSetlDoc

@Nonnull
GetAllRequestBuilder<SetlDoc> getAllSetlDoc()

Fetch multiple SetlDoc entities.

Returns:

A request builder to fetch multiple SetlDoc 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.

countSetlDoc

@Nonnull
CountRequestBuilder<SetlDoc> countSetlDoc()

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

Returns:

A request builder to fetch the count of SetlDoc 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.

getSetlDocByKey

@Nonnull
GetByKeyRequestBuilder<SetlDoc> getSetlDocByKey(@Nonnull
                                                         String settlmtDoc)

Fetch a single SetlDoc entity using key fields.

Parameters:

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

Returns:

A request builder to fetch a single SetlDoc 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.

createSetlDoc

@Nonnull
CreateRequestBuilder<SetlDoc> createSetlDoc(@Nonnull
                                                     SetlDoc setlDoc)

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

Parameters:

setlDoc - SetlDoc entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new SetlDoc entity. To perform execution, call the execute method on the request builder object.

getAllSetlDocItm

@Nonnull
GetAllRequestBuilder<SetlDocItm> getAllSetlDocItm()

Fetch multiple SetlDocItm entities.

Returns:

A request builder to fetch multiple SetlDocItm 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.

countSetlDocItm

@Nonnull
CountRequestBuilder<SetlDocItm> countSetlDocItm()

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

Returns:

A request builder to fetch the count of SetlDocItm 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.

getSetlDocItmByKey

@Nonnull
GetByKeyRequestBuilder<SetlDocItm> getSetlDocItmByKey(@Nonnull
                                                               String settlmtDoc,
                                                               @Nonnull
                                                               String settlmtDocItem)

Fetch a single SetlDocItm entity using key fields.

Parameters:

settlmtDocItem - Document Item

Constraints: Not nullable, Maximum length: 6

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

Returns:

A request builder to fetch a single SetlDocItm 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.

createSetlDocItm

@Nonnull
CreateRequestBuilder<SetlDocItm> createSetlDocItm(@Nonnull
                                                           SetlDocItm setlDocItm)

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

Parameters:

setlDocItm - SetlDocItm entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new SetlDocItm entity. To perform execution, call the execute method on the request builder object.