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

Class DefaultSettlementDocumentService

java.lang.Object

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

All Implemented Interfaces:

OperationsOnEntityCollections, ServiceWithNavigableEntities, SettlementDocumentService

@Named("com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultSettlementDocumentService")
@Deprecated
public class DefaultSettlementDocumentService
extends Object
implements ServiceWithNavigableEntities, SettlementDocumentService

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

You can use this OData-based service to do the following: Read the Settlement Documents on header and item level. Release Settlement Documents that were blocked to accounting and where the application status was not set. Reverse Settlement Documents. Read the relevant pricing elements for the Settlement Document header and item level. Complete Settlement Documents. Revoke the completion of Settlement Documents. Read the relevant partners for the Settlement Document header and item level..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service:	SETTLMTDOC_0001
API Version:	1.2.1
Minimum ERP Version:	2302
Communication Scenario:	Logistics - Settlement Document Integration(SAP_COM_0714)
Scope Items:	Sales Rebate Processing(1B6), Purchasing Rebate Processing(2R7), Sales Commissions - External Sales Representative(2TT), Royalties Settlement for Sales(55I)
Authentication Methods:	x509
Service Group Name:	API_SETTLMT_DOC
Business Object:	Settlement Document

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Deprecated. Creates a batch request builder object.
CountRequestBuilder<CustItmPricingElement>	countCustItmPricingElement()	Deprecated. Fetch the number of entries from the CustItmPricingElement entity collection matching the filter and search expressions.
CountRequestBuilder<CustPricingElement>	countCustPricingElement()	Deprecated. Fetch the number of entries from the CustPricingElement entity collection matching the filter and search expressions.
CountRequestBuilder<SetlDoc>	countSetlDoc()	Deprecated. Fetch the number of entries from the SetlDoc entity collection matching the filter and search expressions.
CountRequestBuilder<SetlDocItm>	countSetlDocItm()	Deprecated. Fetch the number of entries from the SetlDocItm entity collection matching the filter and search expressions.
CountRequestBuilder<SettlementDocumentItemPartner>	countSettlementDocumentItemPartner()	Deprecated. Fetch the number of entries from the SettlementDocumentItemPartner entity collection matching the filter and search expressions.
CountRequestBuilder<SettlementDocumentPartner>	countSettlementDocumentPartner()	Deprecated. Fetch the number of entries from the SettlementDocumentPartner entity collection matching the filter and search expressions.
CountRequestBuilder<SuplrItmPricingElement>	countSuplrItmPricingElement()	Deprecated. Fetch the number of entries from the SuplrItmPricingElement entity collection matching the filter and search expressions.
CountRequestBuilder<SuplrPricingElement>	countSuplrPricingElement()	Deprecated. Fetch the number of entries from the SuplrPricingElement entity collection matching the filter and search expressions.
CreateRequestBuilder<SetlDoc>	createSetlDoc(SetlDoc setlDoc)	Deprecated. Create a new SetlDoc entity and save it to the S/4HANA system.
GetAllRequestBuilder<CustItmPricingElement>	getAllCustItmPricingElement()	Deprecated. Fetch multiple CustItmPricingElement entities.
GetAllRequestBuilder<CustPricingElement>	getAllCustPricingElement()	Deprecated. Fetch multiple CustPricingElement entities.
GetAllRequestBuilder<SetlDoc>	getAllSetlDoc()	Deprecated. Fetch multiple SetlDoc entities.
GetAllRequestBuilder<SetlDocItm>	getAllSetlDocItm()	Deprecated. Fetch multiple SetlDocItm entities.
GetAllRequestBuilder<SettlementDocumentItemPartner>	getAllSettlementDocumentItemPartner()	Deprecated. Fetch multiple SettlementDocumentItemPartner entities.
GetAllRequestBuilder<SettlementDocumentPartner>	getAllSettlementDocumentPartner()	Deprecated. Fetch multiple SettlementDocumentPartner entities.
GetAllRequestBuilder<SuplrItmPricingElement>	getAllSuplrItmPricingElement()	Deprecated. Fetch multiple SuplrItmPricingElement entities.
GetAllRequestBuilder<SuplrPricingElement>	getAllSuplrPricingElement()	Deprecated. Fetch multiple SuplrPricingElement entities.
GetByKeyRequestBuilder<CustItmPricingElement>	getCustItmPricingElementByKey(String settlmtDoc, String settlmtDocItem, String pricingProcedureStep, String pricingProcedureCounter)	Deprecated. Fetch a single CustItmPricingElement entity using key fields.
GetByKeyRequestBuilder<CustPricingElement>	getCustPricingElementByKey(String settlmtDoc, String pricingProcedureStep, String pricingProcedureCounter)	Deprecated. Fetch a single CustPricingElement entity using key fields.
String	getServicePath()	Deprecated.
GetByKeyRequestBuilder<SetlDoc>	getSetlDocByKey(String settlmtDoc)	Deprecated. Fetch a single SetlDoc entity using key fields.
GetByKeyRequestBuilder<SetlDocItm>	getSetlDocItmByKey(String settlmtDoc, String settlmtDocItem)	Deprecated. Fetch a single SetlDocItm entity using key fields.
GetByKeyRequestBuilder<SettlementDocumentItemPartner>	getSettlementDocumentItemPartnerByKey(String settlmtDoc, String settlmtDocItem, String partnerFunction, String partnerCounter)	Deprecated. Fetch a single SettlementDocumentItemPartner entity using key fields.
GetByKeyRequestBuilder<SettlementDocumentPartner>	getSettlementDocumentPartnerByKey(String settlmtDoc, String partnerFunction, String partnerCounter)	Deprecated. Fetch a single SettlementDocumentPartner entity using key fields.
GetByKeyRequestBuilder<SuplrItmPricingElement>	getSuplrItmPricingElementByKey(String settlmtDoc, String settlmtDocItem, String pricingProcedureStep, String pricingProcedureCounter)	Deprecated. Fetch a single SuplrItmPricingElement entity using key fields.
GetByKeyRequestBuilder<SuplrPricingElement>	getSuplrPricingElementByKey(String settlmtDoc, String pricingProcedureStep, String pricingProcedureCounter)	Deprecated. Fetch a single SuplrPricingElement entity using key fields.
DefaultSettlementDocumentService	withServicePath(String servicePath)	Deprecated. 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

applyAction, applyAction, applyFunction, applyFunction, forEntity, withFunction, withFunction

Constructor Details

DefaultSettlementDocumentService

public DefaultSettlementDocumentService()

Deprecated.

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

Method Details

withServicePath

@Nonnull
public DefaultSettlementDocumentService withServicePath(@Nonnull
 String servicePath)

Deprecated.

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()

Deprecated.

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.

getAllCustItmPricingElement

@Nonnull
public GetAllRequestBuilder<CustItmPricingElement> getAllCustItmPricingElement()

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch multiple CustItmPricingElement entities.

Specified by:

getAllCustItmPricingElement in interface SettlementDocumentService

Returns:

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

countCustItmPricingElement

@Nonnull
public CountRequestBuilder<CustItmPricingElement> countCustItmPricingElement()

Deprecated.

Description copied from interface: SettlementDocumentService

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

Specified by:

countCustItmPricingElement in interface SettlementDocumentService

Returns:

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

getCustItmPricingElementByKey

@Nonnull
public GetByKeyRequestBuilder<CustItmPricingElement> getCustItmPricingElementByKey(String settlmtDoc,
 String settlmtDocItem,
 String pricingProcedureStep,
 String pricingProcedureCounter)

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch a single CustItmPricingElement entity using key fields.

Specified by:

getCustItmPricingElementByKey in interface SettlementDocumentService

Parameters:

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

settlmtDocItem - Document Item

Constraints: Not nullable, Maximum length: 6

pricingProcedureStep - Step Number

Constraints: Not nullable, Maximum length: 3

pricingProcedureCounter - Pricing Procedure Counter

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllCustPricingElement

@Nonnull
public GetAllRequestBuilder<CustPricingElement> getAllCustPricingElement()

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch multiple CustPricingElement entities.

Specified by:

getAllCustPricingElement in interface SettlementDocumentService

Returns:

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

countCustPricingElement

@Nonnull
public CountRequestBuilder<CustPricingElement> countCustPricingElement()

Deprecated.

Description copied from interface: SettlementDocumentService

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

Specified by:

countCustPricingElement in interface SettlementDocumentService

Returns:

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

getCustPricingElementByKey

@Nonnull
public GetByKeyRequestBuilder<CustPricingElement> getCustPricingElementByKey(String settlmtDoc,
 String pricingProcedureStep,
 String pricingProcedureCounter)

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch a single CustPricingElement entity using key fields.

Specified by:

getCustPricingElementByKey in interface SettlementDocumentService

Parameters:

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Step Number

Constraints: Not nullable, Maximum length: 3

pricingProcedureCounter - Pricing Procedure Counter

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllSetlDoc

@Nonnull
public GetAllRequestBuilder<SetlDoc> getAllSetlDoc()

Deprecated.

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()

Deprecated.

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(String settlmtDoc)

Deprecated.

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)

Deprecated.

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()

Deprecated.

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()

Deprecated.

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(String settlmtDoc,
 String settlmtDocItem)

Deprecated.

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.

getAllSettlementDocumentItemPartner

@Nonnull
public GetAllRequestBuilder<SettlementDocumentItemPartner> getAllSettlementDocumentItemPartner()

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch multiple SettlementDocumentItemPartner entities.

Specified by:

getAllSettlementDocumentItemPartner in interface SettlementDocumentService

Returns:

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

countSettlementDocumentItemPartner

@Nonnull
public CountRequestBuilder<SettlementDocumentItemPartner> countSettlementDocumentItemPartner()

Deprecated.

Description copied from interface: SettlementDocumentService

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

Specified by:

countSettlementDocumentItemPartner in interface SettlementDocumentService

Returns:

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

getSettlementDocumentItemPartnerByKey

@Nonnull
public GetByKeyRequestBuilder<SettlementDocumentItemPartner> getSettlementDocumentItemPartnerByKey(String settlmtDoc,
 String settlmtDocItem,
 String partnerFunction,
 String partnerCounter)

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch a single SettlementDocumentItemPartner entity using key fields.

Specified by:

getSettlementDocumentItemPartnerByKey in interface SettlementDocumentService

Parameters:

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

settlmtDocItem - Document Item

Constraints: Not nullable, Maximum length: 6

partnerFunction - Partner Function

Constraints: Not nullable, Maximum length: 2

partnerCounter - Partner counter

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllSettlementDocumentPartner

@Nonnull
public GetAllRequestBuilder<SettlementDocumentPartner> getAllSettlementDocumentPartner()

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch multiple SettlementDocumentPartner entities.

Specified by:

getAllSettlementDocumentPartner in interface SettlementDocumentService

Returns:

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

countSettlementDocumentPartner

@Nonnull
public CountRequestBuilder<SettlementDocumentPartner> countSettlementDocumentPartner()

Deprecated.

Description copied from interface: SettlementDocumentService

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

Specified by:

countSettlementDocumentPartner in interface SettlementDocumentService

Returns:

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

getSettlementDocumentPartnerByKey

@Nonnull
public GetByKeyRequestBuilder<SettlementDocumentPartner> getSettlementDocumentPartnerByKey(String settlmtDoc,
 String partnerFunction,
 String partnerCounter)

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch a single SettlementDocumentPartner entity using key fields.

Specified by:

getSettlementDocumentPartnerByKey in interface SettlementDocumentService

Parameters:

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

partnerFunction - Partner Function

Constraints: Not nullable, Maximum length: 2

partnerCounter - Partner counter

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllSuplrItmPricingElement

@Nonnull
public GetAllRequestBuilder<SuplrItmPricingElement> getAllSuplrItmPricingElement()

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch multiple SuplrItmPricingElement entities.

Specified by:

getAllSuplrItmPricingElement in interface SettlementDocumentService

Returns:

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

countSuplrItmPricingElement

@Nonnull
public CountRequestBuilder<SuplrItmPricingElement> countSuplrItmPricingElement()

Deprecated.

Description copied from interface: SettlementDocumentService

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

Specified by:

countSuplrItmPricingElement in interface SettlementDocumentService

Returns:

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

getSuplrItmPricingElementByKey

@Nonnull
public GetByKeyRequestBuilder<SuplrItmPricingElement> getSuplrItmPricingElementByKey(String settlmtDoc,
 String settlmtDocItem,
 String pricingProcedureStep,
 String pricingProcedureCounter)

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch a single SuplrItmPricingElement entity using key fields.

Specified by:

getSuplrItmPricingElementByKey in interface SettlementDocumentService

Parameters:

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

settlmtDocItem - Document Item

Constraints: Not nullable, Maximum length: 6

pricingProcedureStep - Step Number

Constraints: Not nullable, Maximum length: 3

pricingProcedureCounter - Pricing Procedure Counter

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllSuplrPricingElement

@Nonnull
public GetAllRequestBuilder<SuplrPricingElement> getAllSuplrPricingElement()

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch multiple SuplrPricingElement entities.

Specified by:

getAllSuplrPricingElement in interface SettlementDocumentService

Returns:

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

countSuplrPricingElement

@Nonnull
public CountRequestBuilder<SuplrPricingElement> countSuplrPricingElement()

Deprecated.

Description copied from interface: SettlementDocumentService

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

Specified by:

countSuplrPricingElement in interface SettlementDocumentService

Returns:

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

getSuplrPricingElementByKey

@Nonnull
public GetByKeyRequestBuilder<SuplrPricingElement> getSuplrPricingElementByKey(String settlmtDoc,
 String pricingProcedureStep,
 String pricingProcedureCounter)

Deprecated.

Description copied from interface: SettlementDocumentService

Fetch a single SuplrPricingElement entity using key fields.

Specified by:

getSuplrPricingElementByKey in interface SettlementDocumentService

Parameters:

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Step Number

Constraints: Not nullable, Maximum length: 3

pricingProcedureCounter - Pricing Procedure Counter

Constraints: Not nullable, Maximum length: 3

Returns:

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

getServicePath

@Nonnull
public String getServicePath()

Deprecated.

Specified by:

getServicePath in interface ServiceWithNavigableEntities