com.sap.cloud.sdk.s4hana.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 Documents on header and item level. You can release Settlement Documents which were blocked to accounting and where the application status was not set. You can reverse Settlement Documents. You can read the relevant pricing elements for the Settlement Document header and item level..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	SETTLMTDOC_0001
API Version:	1
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)
Authentication Methods:	Basic, x509
Service Group Name:	API_SETTLMT_DOC
Business Object:	SettlementDocument

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<CustItmPricingElement>	countCustItmPricingElement() Fetch the number of entries from the CustItmPricingElement entity collection matching the filter and search expressions.
CountRequestBuilder<CustPricingElement>	countCustPricingElement() Fetch the number of entries from the CustPricingElement entity collection matching the filter and search expressions.
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.
CountRequestBuilder<SuplrItmPricingElement>	countSuplrItmPricingElement() Fetch the number of entries from the SuplrItmPricingElement entity collection matching the filter and search expressions.
CountRequestBuilder<SuplrPricingElement>	countSuplrPricingElement() Fetch the number of entries from the SuplrPricingElement entity collection matching the filter and search expressions.
CreateRequestBuilder<CustItmPricingElement>	createCustItmPricingElement(CustItmPricingElement custItmPricingElement) Create a new CustItmPricingElement entity and save it to the S/4HANA system.
CreateRequestBuilder<CustPricingElement>	createCustPricingElement(CustPricingElement custPricingElement) Create a new CustPricingElement entity and save it to the S/4HANA system.
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.
CreateRequestBuilder<SuplrItmPricingElement>	createSuplrItmPricingElement(SuplrItmPricingElement suplrItmPricingElement) Create a new SuplrItmPricingElement entity and save it to the S/4HANA system.
CreateRequestBuilder<SuplrPricingElement>	createSuplrPricingElement(SuplrPricingElement suplrPricingElement) Create a new SuplrPricingElement entity and save it to the S/4HANA system.
GetAllRequestBuilder<CustItmPricingElement>	getAllCustItmPricingElement() Fetch multiple CustItmPricingElement entities.
GetAllRequestBuilder<CustPricingElement>	getAllCustPricingElement() Fetch multiple CustPricingElement entities.
GetAllRequestBuilder<SetlDoc>	getAllSetlDoc() Fetch multiple SetlDoc entities.
GetAllRequestBuilder<SetlDocItm>	getAllSetlDocItm() Fetch multiple SetlDocItm entities.
GetAllRequestBuilder<SuplrItmPricingElement>	getAllSuplrItmPricingElement() Fetch multiple SuplrItmPricingElement entities.
GetAllRequestBuilder<SuplrPricingElement>	getAllSuplrPricingElement() Fetch multiple SuplrPricingElement entities.
GetByKeyRequestBuilder<CustItmPricingElement>	getCustItmPricingElementByKey(String settlmtDoc, String settlmtDocItem, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single CustItmPricingElement entity using key fields.
GetByKeyRequestBuilder<CustPricingElement>	getCustPricingElementByKey(String settlmtDoc, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single CustPricingElement entity using key fields.
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.
GetByKeyRequestBuilder<SuplrItmPricingElement>	getSuplrItmPricingElementByKey(String settlmtDoc, String settlmtDocItem, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single SuplrItmPricingElement entity using key fields.
GetByKeyRequestBuilder<SuplrPricingElement>	getSuplrPricingElementByKey(String settlmtDoc, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single SuplrPricingElement 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.

getAllCustItmPricingElement

@Nonnull
GetAllRequestBuilder<CustItmPricingElement> getAllCustItmPricingElement()

Fetch multiple CustItmPricingElement entities.

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
CountRequestBuilder<CustItmPricingElement> countCustItmPricingElement()

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

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
GetByKeyRequestBuilder<CustItmPricingElement> getCustItmPricingElementByKey(@Nonnull
                                                                                     String settlmtDoc,
                                                                                     @Nonnull
                                                                                     String settlmtDocItem,
                                                                                     @Nonnull
                                                                                     String pricingProcedureStep,
                                                                                     @Nonnull
                                                                                     String pricingProcedureCounter)

Fetch a single CustItmPricingElement entity using key fields.

Parameters:

pricingProcedureCounter - Pricing Procedure Counter

Constraints: Not nullable, Maximum length: 3

settlmtDocItem - Document Item

Constraints: Not nullable, Maximum length: 6

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Step Number

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.

createCustItmPricingElement

@Nonnull
CreateRequestBuilder<CustItmPricingElement> createCustItmPricingElement(@Nonnull
                                                                                 CustItmPricingElement custItmPricingElement)

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

Parameters:

custItmPricingElement - CustItmPricingElement entity object that will be created in the S/4HANA system.

Returns:

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

getAllCustPricingElement

@Nonnull
GetAllRequestBuilder<CustPricingElement> getAllCustPricingElement()

Fetch multiple CustPricingElement entities.

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
CountRequestBuilder<CustPricingElement> countCustPricingElement()

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

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
GetByKeyRequestBuilder<CustPricingElement> getCustPricingElementByKey(@Nonnull
                                                                               String settlmtDoc,
                                                                               @Nonnull
                                                                               String pricingProcedureStep,
                                                                               @Nonnull
                                                                               String pricingProcedureCounter)

Fetch a single CustPricingElement entity using key fields.

Parameters:

pricingProcedureCounter - Pricing Procedure Counter

Constraints: Not nullable, Maximum length: 3

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Step Number

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.

createCustPricingElement

@Nonnull
CreateRequestBuilder<CustPricingElement> createCustPricingElement(@Nonnull
                                                                           CustPricingElement custPricingElement)

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

Parameters:

custPricingElement - CustPricingElement entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new CustPricingElement entity. 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.

getAllSuplrItmPricingElement

@Nonnull
GetAllRequestBuilder<SuplrItmPricingElement> getAllSuplrItmPricingElement()

Fetch multiple SuplrItmPricingElement entities.

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
CountRequestBuilder<SuplrItmPricingElement> countSuplrItmPricingElement()

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

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
GetByKeyRequestBuilder<SuplrItmPricingElement> getSuplrItmPricingElementByKey(@Nonnull
                                                                                       String settlmtDoc,
                                                                                       @Nonnull
                                                                                       String settlmtDocItem,
                                                                                       @Nonnull
                                                                                       String pricingProcedureStep,
                                                                                       @Nonnull
                                                                                       String pricingProcedureCounter)

Fetch a single SuplrItmPricingElement entity using key fields.

Parameters:

pricingProcedureCounter - Pricing Procedure Counter

Constraints: Not nullable, Maximum length: 3

settlmtDocItem - Document Item

Constraints: Not nullable, Maximum length: 6

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Step Number

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.

createSuplrItmPricingElement

@Nonnull
CreateRequestBuilder<SuplrItmPricingElement> createSuplrItmPricingElement(@Nonnull
                                                                                   SuplrItmPricingElement suplrItmPricingElement)

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

Parameters:

suplrItmPricingElement - SuplrItmPricingElement entity object that will be created in the S/4HANA system.

Returns:

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

getAllSuplrPricingElement

@Nonnull
GetAllRequestBuilder<SuplrPricingElement> getAllSuplrPricingElement()

Fetch multiple SuplrPricingElement entities.

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
CountRequestBuilder<SuplrPricingElement> countSuplrPricingElement()

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

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
GetByKeyRequestBuilder<SuplrPricingElement> getSuplrPricingElementByKey(@Nonnull
                                                                                 String settlmtDoc,
                                                                                 @Nonnull
                                                                                 String pricingProcedureStep,
                                                                                 @Nonnull
                                                                                 String pricingProcedureCounter)

Fetch a single SuplrPricingElement entity using key fields.

Parameters:

pricingProcedureCounter - Pricing Procedure Counter

Constraints: Not nullable, Maximum length: 3

settlmtDoc - Settlement Document Number

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Step Number

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.

createSuplrPricingElement

@Nonnull
CreateRequestBuilder<SuplrPricingElement> createSuplrPricingElement(@Nonnull
                                                                             SuplrPricingElement suplrPricingElement)

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

Parameters:

suplrPricingElement - SuplrPricingElement entity object that will be created in the S/4HANA system.

Returns:

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