@Named(value="com.sap.cloud.sdk.s4hana.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 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..
Reference: SAP API Business Hub
| 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 |
ServiceWithNavigableEntities.NavigableEntity<EntityT extends VdmEntity<EntityT>>DEFAULT_SERVICE_PATH| Constructor and Description |
|---|
DefaultSettlementDocumentService()
Creates a service using
SettlementDocumentService.DEFAULT_SERVICE_PATH to send the requests. |
| 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. |
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. |
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. |
DefaultSettlementDocumentService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitforEntitypublic DefaultSettlementDocumentService()
SettlementDocumentService.DEFAULT_SERVICE_PATH to send the requests.@Nonnull public DefaultSettlementDocumentService withServicePath(@Nonnull String servicePath)
SettlementDocumentServicewithServicePath in interface SettlementDocumentServiceservicePath - Service path that will override the default.@Nonnull public BatchRequestBuilder batch()
SettlementDocumentServicebatch in interface SettlementDocumentServiceexecute method on the request builder object.@Nonnull public GetAllRequestBuilder<CustItmPricingElement> getAllCustItmPricingElement()
SettlementDocumentServiceCustItmPricingElement entities.getAllCustItmPricingElement in interface SettlementDocumentServiceCustItmPricingElement 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.@Nonnull public CountRequestBuilder<CustItmPricingElement> countCustItmPricingElement()
SettlementDocumentServiceCustItmPricingElement entity collection matching the filter and search expressions.countCustItmPricingElement in interface SettlementDocumentServiceCustItmPricingElement 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.@Nonnull public GetByKeyRequestBuilder<CustItmPricingElement> getCustItmPricingElementByKey(@Nonnull String settlmtDoc, @Nonnull String settlmtDocItem, @Nonnull String pricingProcedureStep, @Nonnull String pricingProcedureCounter)
SettlementDocumentServiceCustItmPricingElement entity using key fields.getCustItmPricingElementByKey in interface SettlementDocumentServicesettlmtDoc - 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
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.@Nonnull public CreateRequestBuilder<CustItmPricingElement> createCustItmPricingElement(@Nonnull CustItmPricingElement custItmPricingElement)
SettlementDocumentServiceCustItmPricingElement entity and save it to the S/4HANA system.createCustItmPricingElement in interface SettlementDocumentServicecustItmPricingElement - CustItmPricingElement entity object that will be created in the S/4HANA system.CustItmPricingElement entity. To perform execution, call the
execute method on the request builder object.@Nonnull public GetAllRequestBuilder<CustPricingElement> getAllCustPricingElement()
SettlementDocumentServiceCustPricingElement entities.getAllCustPricingElement in interface SettlementDocumentServiceCustPricingElement 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.@Nonnull public CountRequestBuilder<CustPricingElement> countCustPricingElement()
SettlementDocumentServiceCustPricingElement entity collection matching the filter and search expressions.countCustPricingElement in interface SettlementDocumentServiceCustPricingElement 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.@Nonnull public GetByKeyRequestBuilder<CustPricingElement> getCustPricingElementByKey(@Nonnull String settlmtDoc, @Nonnull String pricingProcedureStep, @Nonnull String pricingProcedureCounter)
SettlementDocumentServiceCustPricingElement entity using key fields.getCustPricingElementByKey in interface SettlementDocumentServicesettlmtDoc - 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
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.@Nonnull public CreateRequestBuilder<CustPricingElement> createCustPricingElement(@Nonnull CustPricingElement custPricingElement)
SettlementDocumentServiceCustPricingElement entity and save it to the S/4HANA system.createCustPricingElement in interface SettlementDocumentServicecustPricingElement - CustPricingElement entity object that will be created in the S/4HANA system.CustPricingElement entity. To perform execution, call the
execute method on the request builder object.@Nonnull public GetAllRequestBuilder<SetlDoc> getAllSetlDoc()
SettlementDocumentServiceSetlDoc
entities.getAllSetlDoc in interface SettlementDocumentServiceSetlDoc
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.@Nonnull public CountRequestBuilder<SetlDoc> countSetlDoc()
SettlementDocumentServiceSetlDoc entity
collection matching the filter and search expressions.countSetlDoc in interface SettlementDocumentServiceSetlDoc
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.@Nonnull public GetByKeyRequestBuilder<SetlDoc> getSetlDocByKey(@Nonnull String settlmtDoc)
SettlementDocumentServiceSetlDoc
entity using key fields.getSetlDocByKey in interface SettlementDocumentServicesettlmtDoc - Settlement Document Number
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public CreateRequestBuilder<SetlDoc> createSetlDoc(@Nonnull SetlDoc setlDoc)
SettlementDocumentServiceSetlDoc
entity and save it to the S/4HANA system.createSetlDoc in interface SettlementDocumentServicesetlDoc - SetlDoc
entity object that will be created in the S/4HANA system.SetlDoc entity.
To perform execution, call the
execute method on the request builder object.@Nonnull public GetAllRequestBuilder<SetlDocItm> getAllSetlDocItm()
SettlementDocumentServiceSetlDocItm entities.getAllSetlDocItm in interface SettlementDocumentServiceSetlDocItm
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.@Nonnull public CountRequestBuilder<SetlDocItm> countSetlDocItm()
SettlementDocumentServiceSetlDocItm entity
collection matching the filter and search expressions.countSetlDocItm in interface SettlementDocumentServiceSetlDocItm
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.@Nonnull public GetByKeyRequestBuilder<SetlDocItm> getSetlDocItmByKey(@Nonnull String settlmtDoc, @Nonnull String settlmtDocItem)
SettlementDocumentServiceSetlDocItm entity using key fields.getSetlDocItmByKey in interface SettlementDocumentServicesettlmtDoc - Settlement Document Number
Constraints: Not nullable, Maximum length: 10
settlmtDocItem - Document Item
Constraints: Not nullable, Maximum length: 6
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.@Nonnull public CreateRequestBuilder<SetlDocItm> createSetlDocItm(@Nonnull SetlDocItm setlDocItm)
SettlementDocumentServiceSetlDocItm entity and save it to the S/4HANA system.createSetlDocItm in interface SettlementDocumentServicesetlDocItm - SetlDocItm
entity object that will be created in the S/4HANA system.SetlDocItm
entity. To perform execution, call the
execute method on the request builder object.@Nonnull public GetAllRequestBuilder<SuplrItmPricingElement> getAllSuplrItmPricingElement()
SettlementDocumentServiceSuplrItmPricingElement entities.getAllSuplrItmPricingElement in interface SettlementDocumentServiceSuplrItmPricingElement 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.@Nonnull public CountRequestBuilder<SuplrItmPricingElement> countSuplrItmPricingElement()
SettlementDocumentServiceSuplrItmPricingElement entity collection matching the filter and search expressions.countSuplrItmPricingElement in interface SettlementDocumentServiceSuplrItmPricingElement 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.@Nonnull public GetByKeyRequestBuilder<SuplrItmPricingElement> getSuplrItmPricingElementByKey(@Nonnull String settlmtDoc, @Nonnull String settlmtDocItem, @Nonnull String pricingProcedureStep, @Nonnull String pricingProcedureCounter)
SettlementDocumentServiceSuplrItmPricingElement entity using key fields.getSuplrItmPricingElementByKey in interface SettlementDocumentServicesettlmtDoc - 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
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.@Nonnull public CreateRequestBuilder<SuplrItmPricingElement> createSuplrItmPricingElement(@Nonnull SuplrItmPricingElement suplrItmPricingElement)
SettlementDocumentServiceSuplrItmPricingElement entity and save it to the S/4HANA system.createSuplrItmPricingElement in interface SettlementDocumentServicesuplrItmPricingElement - SuplrItmPricingElement entity object that will be created in the S/4HANA system.SuplrItmPricingElement entity. To perform execution, call the
execute method on the request builder object.@Nonnull public GetAllRequestBuilder<SuplrPricingElement> getAllSuplrPricingElement()
SettlementDocumentServiceSuplrPricingElement entities.getAllSuplrPricingElement in interface SettlementDocumentServiceSuplrPricingElement 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.@Nonnull public CountRequestBuilder<SuplrPricingElement> countSuplrPricingElement()
SettlementDocumentServiceSuplrPricingElement entity collection matching the filter and search expressions.countSuplrPricingElement in interface SettlementDocumentServiceSuplrPricingElement 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.@Nonnull public GetByKeyRequestBuilder<SuplrPricingElement> getSuplrPricingElementByKey(@Nonnull String settlmtDoc, @Nonnull String pricingProcedureStep, @Nonnull String pricingProcedureCounter)
SettlementDocumentServiceSuplrPricingElement entity using key fields.getSuplrPricingElementByKey in interface SettlementDocumentServicesettlmtDoc - 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
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.@Nonnull public CreateRequestBuilder<SuplrPricingElement> createSuplrPricingElement(@Nonnull SuplrPricingElement suplrPricingElement)
SettlementDocumentServiceSuplrPricingElement entity and save it to the S/4HANA system.createSuplrPricingElement in interface SettlementDocumentServicesuplrPricingElement - SuplrPricingElement entity object that will be created in the S/4HANA system.SuplrPricingElement entity. To perform execution, call the
execute method on the request builder object.@Nonnull public String getServicePath()
ServiceWithNavigableEntitiesgetServicePath in interface ServiceWithNavigableEntitiesCopyright © 2021 SAP SE. All rights reserved.