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. You can complete Settlement Documents. You can revoke the completion of Settlement Documents..
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), Royalties Settlement for Sales (55I) |
Authentication Methods: | Basic, x509 |
Service Group Name: | API_SETTLMT_DOC |
Business Object: | SettlementDocument |
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. |
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.
|
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull SettlementDocumentService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull BatchRequestBuilder batch()
execute
method on the request builder object.@Nonnull GetAllRequestBuilder<CustItmPricingElement> getAllCustItmPricingElement()
CustItmPricingElement
entities.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.@Nonnull CountRequestBuilder<CustItmPricingElement> countCustItmPricingElement()
CustItmPricingElement
entity collection matching the filter and search expressions.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.@Nonnull GetByKeyRequestBuilder<CustItmPricingElement> getCustItmPricingElementByKey(@Nonnull String settlmtDoc, @Nonnull String settlmtDocItem, @Nonnull String pricingProcedureStep, @Nonnull String pricingProcedureCounter)
CustItmPricingElement
entity using key fields.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
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 CreateRequestBuilder<CustItmPricingElement> createCustItmPricingElement(@Nonnull CustItmPricingElement custItmPricingElement)
CustItmPricingElement
entity and save it to the S/4HANA system.custItmPricingElement
- 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 GetAllRequestBuilder<CustPricingElement> getAllCustPricingElement()
CustPricingElement
entities.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.@Nonnull CountRequestBuilder<CustPricingElement> countCustPricingElement()
CustPricingElement
entity collection matching the filter and search expressions.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.@Nonnull GetByKeyRequestBuilder<CustPricingElement> getCustPricingElementByKey(@Nonnull String settlmtDoc, @Nonnull String pricingProcedureStep, @Nonnull String pricingProcedureCounter)
CustPricingElement
entity using key fields.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
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 CreateRequestBuilder<CustPricingElement> createCustPricingElement(@Nonnull CustPricingElement custPricingElement)
CustPricingElement
entity and save it to the S/4HANA system.custPricingElement
- 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 GetAllRequestBuilder<SetlDoc> getAllSetlDoc()
SetlDoc
entities.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.@Nonnull CountRequestBuilder<SetlDoc> countSetlDoc()
SetlDoc
entity
collection matching the filter and search expressions.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.@Nonnull GetByKeyRequestBuilder<SetlDoc> getSetlDocByKey(@Nonnull String settlmtDoc)
SetlDoc
entity using key fields.settlmtDoc
- 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 CreateRequestBuilder<SetlDoc> createSetlDoc(@Nonnull SetlDoc setlDoc)
SetlDoc
entity and save it to the S/4HANA system.@Nonnull GetAllRequestBuilder<SetlDocItm> getAllSetlDocItm()
SetlDocItm
entities.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.@Nonnull CountRequestBuilder<SetlDocItm> countSetlDocItm()
SetlDocItm
entity
collection matching the filter and search expressions.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.@Nonnull GetByKeyRequestBuilder<SetlDocItm> getSetlDocItmByKey(@Nonnull String settlmtDoc, @Nonnull String settlmtDocItem)
SetlDocItm
entity using key fields.settlmtDocItem
- Document Item
Constraints: Not nullable, Maximum length: 6
settlmtDoc
- Settlement Document Number
Constraints: Not nullable, Maximum length: 10
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 CreateRequestBuilder<SetlDocItm> createSetlDocItm(@Nonnull SetlDocItm setlDocItm)
SetlDocItm
entity and save it to the S/4HANA system.setlDocItm
- 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 GetAllRequestBuilder<SuplrItmPricingElement> getAllSuplrItmPricingElement()
SuplrItmPricingElement
entities.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.@Nonnull CountRequestBuilder<SuplrItmPricingElement> countSuplrItmPricingElement()
SuplrItmPricingElement
entity collection matching the filter and search expressions.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.@Nonnull GetByKeyRequestBuilder<SuplrItmPricingElement> getSuplrItmPricingElementByKey(@Nonnull String settlmtDoc, @Nonnull String settlmtDocItem, @Nonnull String pricingProcedureStep, @Nonnull String pricingProcedureCounter)
SuplrItmPricingElement
entity using key fields.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
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 CreateRequestBuilder<SuplrItmPricingElement> createSuplrItmPricingElement(@Nonnull SuplrItmPricingElement suplrItmPricingElement)
SuplrItmPricingElement
entity and save it to the S/4HANA system.suplrItmPricingElement
- 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 GetAllRequestBuilder<SuplrPricingElement> getAllSuplrPricingElement()
SuplrPricingElement
entities.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.@Nonnull CountRequestBuilder<SuplrPricingElement> countSuplrPricingElement()
SuplrPricingElement
entity collection matching the filter and search expressions.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.@Nonnull GetByKeyRequestBuilder<SuplrPricingElement> getSuplrPricingElementByKey(@Nonnull String settlmtDoc, @Nonnull String pricingProcedureStep, @Nonnull String pricingProcedureCounter)
SuplrPricingElement
entity using key fields.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
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 CreateRequestBuilder<SuplrPricingElement> createSuplrPricingElement(@Nonnull SuplrPricingElement suplrPricingElement)
SuplrPricingElement
entity and save it to the S/4HANA system.suplrPricingElement
- 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.Copyright © 2021 SAP SE. All rights reserved.