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

Class DefaultSettlementDocumentService

java.lang.Object

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

All Implemented Interfaces:

ServiceWithNavigableEntities, SettlementDocumentService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odatav4.services.DefaultSettlementDocumentService")
public class DefaultSettlementDocumentService
extends Object
implements ServiceWithNavigableEntities, 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

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

ServiceWithNavigableEntities.NavigableEntity<EntityT extends VdmEntity<EntityT>>

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odatav4.services.SettlementDocumentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultSettlementDocumentService() Creates a service using SettlementDocumentService.DEFAULT_SERVICE_PATH to send the requests.

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.
String	getServicePath() Getter for the OData service root path.
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.
DefaultSettlementDocumentService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

forEntity

Constructor Detail

DefaultSettlementDocumentService

public DefaultSettlementDocumentService()

Creates a service using SettlementDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultSettlementDocumentService withServicePath(@Nonnull
                                                                 String servicePath)

Description copied from interface: SettlementDocumentService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface SettlementDocumentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Description copied from interface: SettlementDocumentService

Creates a batch request builder object.

Specified by:

batch in interface SettlementDocumentService

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
public GetAllRequestBuilder<SetlDoc> getAllSetlDoc()

Description copied from interface: SettlementDocumentService

Fetch multiple SetlDoc entities.

Specified by:

getAllSetlDoc in interface SettlementDocumentService

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
public CountRequestBuilder<SetlDoc> countSetlDoc()

Description copied from interface: SettlementDocumentService

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

Specified by:

countSetlDoc in interface SettlementDocumentService

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
public GetByKeyRequestBuilder<SetlDoc> getSetlDocByKey(@Nonnull
                                                                String settlmtDoc)

Description copied from interface: SettlementDocumentService

Fetch a single SetlDoc entity using key fields.

Specified by:

getSetlDocByKey in interface SettlementDocumentService

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
public CreateRequestBuilder<SetlDoc> createSetlDoc(@Nonnull
                                                            SetlDoc setlDoc)

Description copied from interface: SettlementDocumentService

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

Specified by:

createSetlDoc in interface SettlementDocumentService

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
public GetAllRequestBuilder<SetlDocItm> getAllSetlDocItm()

Description copied from interface: SettlementDocumentService

Fetch multiple SetlDocItm entities.

Specified by:

getAllSetlDocItm in interface SettlementDocumentService

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
public CountRequestBuilder<SetlDocItm> countSetlDocItm()

Description copied from interface: SettlementDocumentService

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

Specified by:

countSetlDocItm in interface SettlementDocumentService

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
public GetByKeyRequestBuilder<SetlDocItm> getSetlDocItmByKey(@Nonnull
                                                                      String settlmtDoc,
                                                                      @Nonnull
                                                                      String settlmtDocItem)

Description copied from interface: SettlementDocumentService

Fetch a single SetlDocItm entity using key fields.

Specified by:

getSetlDocItmByKey in interface SettlementDocumentService

Parameters:

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

settlmtDocItem - Document Item

Constraints: Not nullable, Maximum length: 6

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
public CreateRequestBuilder<SetlDocItm> createSetlDocItm(@Nonnull
                                                                  SetlDocItm setlDocItm)

Description copied from interface: SettlementDocumentService

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

Specified by:

createSetlDocItm in interface SettlementDocumentService

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.

getServicePath

@Nonnull
public String getServicePath()

Description copied from interface: ServiceWithNavigableEntities

Getter for the OData service root path.

Specified by:

getServicePath in interface ServiceWithNavigableEntities

Returns:

the service path.