Interface SettlementProcessTypeService
- All Known Implementing Classes:
DefaultSettlementProcessTypeService
You retrieve the following data using this OData based service: You can read the Settlement Process Types and related information. You can navigate to the Application Status Assignment for a Settlement Process Type and read the assigned Application Status Group and all the possible Application Statuses linked to it. You can navigate to the Settlement Document Type Assignment for a Settlement Process Type and read the assigned Settlement Document Types for the relevant Settlement Process Type. You can also read further information regarding the Settlement Document Types..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | SETTLMTPROCESSTYPE_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Logistics - Settlement Process Type Integration(SAP_COM_0710) |
| Scope Items: | Sales Rebate Processing(1B6), Purchasing Rebate Processing(2R7), Sales Commissions - External Sales Representative(2TT), Internal Commissions Settlement with SAP Sales Cloud(3TD) |
| Authentication Methods: | x509 |
| Service Group Name: | API_SETTLMT_PROC_TYPE |
| Business Object: | Settlement Process Type |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theSettlmtApplStsGrpStsAssgmtentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theSettlmtDocProcTypeAssgmtentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theSettlmtDocTypeentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theSettlmtProcessTypeentity collection matching the filter and search expressions.Deprecated.Fetch multipleSettlmtApplStsGrpStsAssgmtentities.Deprecated.Fetch multipleSettlmtDocProcTypeAssgmtentities.Deprecated.Fetch multipleSettlmtDocTypeentities.Deprecated.Fetch multipleSettlmtProcessTypeentities.getSettlmtApplStsGrpStsAssgmtByKey(String settlmtApplStsGrp, String settlmtApplSts) Deprecated.Fetch a singleSettlmtApplStsGrpStsAssgmtentity using key fields.getSettlmtDocProcTypeAssgmtByKey(String settlmtProcessType, String settlmtDocType) Deprecated.Fetch a singleSettlmtDocProcTypeAssgmtentity using key fields.getSettlmtDocTypeByKey(String settlmtDocType) Deprecated.Fetch a singleSettlmtDocTypeentity using key fields.getSettlmtProcessTypeByKey(String settlmtProcessType) Deprecated.Fetch a singleSettlmtProcessTypeentity using key fields.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
Deprecated.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
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllSettlmtApplStsGrpStsAssgmt
Deprecated.Fetch multipleSettlmtApplStsGrpStsAssgmtentities.- Returns:
- A request builder to fetch multiple
SettlmtApplStsGrpStsAssgmtentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countSettlmtApplStsGrpStsAssgmt
Deprecated.Fetch the number of entries from theSettlmtApplStsGrpStsAssgmtentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
SettlmtApplStsGrpStsAssgmtentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getSettlmtApplStsGrpStsAssgmtByKey
@Nonnull GetByKeyRequestBuilder<SettlmtApplStsGrpStsAssgmt> getSettlmtApplStsGrpStsAssgmtByKey(String settlmtApplStsGrp, String settlmtApplSts) Deprecated.Fetch a singleSettlmtApplStsGrpStsAssgmtentity using key fields.- Parameters:
settlmtApplStsGrp- Status Group for Settlement Management DocumentsConstraints: Not nullable, Maximum length: 4
settlmtApplSts- Application Status for a Settlement Management DocumentConstraints: Not nullable, Maximum length: 4
- Returns:
- A request builder to fetch a single
SettlmtApplStsGrpStsAssgmtentity 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 theexecutemethod on the request builder object.
-
getAllSettlmtDocProcTypeAssgmt
Deprecated.Fetch multipleSettlmtDocProcTypeAssgmtentities.- Returns:
- A request builder to fetch multiple
SettlmtDocProcTypeAssgmtentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countSettlmtDocProcTypeAssgmt
Deprecated.Fetch the number of entries from theSettlmtDocProcTypeAssgmtentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
SettlmtDocProcTypeAssgmtentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getSettlmtDocProcTypeAssgmtByKey
@Nonnull GetByKeyRequestBuilder<SettlmtDocProcTypeAssgmt> getSettlmtDocProcTypeAssgmtByKey(String settlmtProcessType, String settlmtDocType) Deprecated.Fetch a singleSettlmtDocProcTypeAssgmtentity using key fields.- Parameters:
settlmtDocType- Settlement Document TypeConstraints: Not nullable, Maximum length: 4
settlmtProcessType- Settlement Process TypeConstraints: Not nullable, Maximum length: 4
- Returns:
- A request builder to fetch a single
SettlmtDocProcTypeAssgmtentity 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 theexecutemethod on the request builder object.
-
getAllSettlmtDocType
Deprecated.Fetch multipleSettlmtDocTypeentities.- Returns:
- A request builder to fetch multiple
SettlmtDocTypeentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countSettlmtDocType
Deprecated.Fetch the number of entries from theSettlmtDocTypeentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
SettlmtDocTypeentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getSettlmtDocTypeByKey
Deprecated.Fetch a singleSettlmtDocTypeentity using key fields.- Parameters:
settlmtDocType- Settlement Document TypeConstraints: Not nullable, Maximum length: 4
- Returns:
- A request builder to fetch a single
SettlmtDocTypeentity 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 theexecutemethod on the request builder object.
-
getAllSettlmtProcessType
Deprecated.Fetch multipleSettlmtProcessTypeentities.- Returns:
- A request builder to fetch multiple
SettlmtProcessTypeentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countSettlmtProcessType
Deprecated.Fetch the number of entries from theSettlmtProcessTypeentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
SettlmtProcessTypeentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getSettlmtProcessTypeByKey
@Nonnull GetByKeyRequestBuilder<SettlmtProcessType> getSettlmtProcessTypeByKey(String settlmtProcessType) Deprecated.Fetch a singleSettlmtProcessTypeentity using key fields.- Parameters:
settlmtProcessType- Settlement Process TypeConstraints: Not nullable, Maximum length: 4
- Returns:
- A request builder to fetch a single
SettlmtProcessTypeentity 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 theexecutemethod on the request builder object.
-