Interface SettlementDocumentTypeService
- All Known Implementing Classes:
DefaultSettlementDocumentTypeService
You retrieve the following data using this OData based service: You can read the Settlement Document Types and related information. You can navigate to the Header Text Object Type Assignment for a Settlement Document Type and read the assigned Text Determination Procedure and all the possible Text Object Types linked to it on header level. You can navigate to the Item Text Object Type Assignment for a Settlement Document Type and read the assigned Text Determination Procedure and all the possible Text Object Types linked to it on item level..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | SETTLMTDOCTYPE_0001 |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Logistics - Settlement Document Type Integration(SAP_COM_0709) |
| 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_DOC_TYPE |
| Business Object: | Settlement Document 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 theSetlMgmtHdrTxtObjTypeAssgmtentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theSetlMgmtItmTxtObjTypeAssgmtentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theSettlmtDocTypeentity collection matching the filter and search expressions.Deprecated.Fetch multipleSetlMgmtHdrTxtObjTypeAssgmtentities.Deprecated.Fetch multipleSetlMgmtItmTxtObjTypeAssgmtentities.Deprecated.Fetch multipleSettlmtDocTypeentities.getSetlMgmtHdrTxtObjTypeAssgmtByKey(String settlmtHdrTxtDetnProced, String settlmtMgmtHdrTxtObjType) Deprecated.Fetch a singleSetlMgmtHdrTxtObjTypeAssgmtentity using key fields.getSetlMgmtItmTxtObjTypeAssgmtByKey(String settlmtItmTxtDetnProced, String settlmtMgmtItmTxtObjType) Deprecated.Fetch a singleSetlMgmtItmTxtObjTypeAssgmtentity using key fields.getSettlmtDocTypeByKey(String settlmtDocType) Deprecated.Fetch a singleSettlmtDocTypeentity 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.
-
getAllSetlMgmtHdrTxtObjTypeAssgmt
Deprecated.Fetch multipleSetlMgmtHdrTxtObjTypeAssgmtentities.- Returns:
- A request builder to fetch multiple
SetlMgmtHdrTxtObjTypeAssgmtentities. 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.
-
countSetlMgmtHdrTxtObjTypeAssgmt
Deprecated.Fetch the number of entries from theSetlMgmtHdrTxtObjTypeAssgmtentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
SetlMgmtHdrTxtObjTypeAssgmtentities. 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.
-
getSetlMgmtHdrTxtObjTypeAssgmtByKey
@Nonnull GetByKeyRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt> getSetlMgmtHdrTxtObjTypeAssgmtByKey(String settlmtHdrTxtDetnProced, String settlmtMgmtHdrTxtObjType) Deprecated.Fetch a singleSetlMgmtHdrTxtObjTypeAssgmtentity using key fields.- Parameters:
settlmtMgmtHdrTxtObjType- Specific Text ID for a Settlement Management Document HeaderConstraints: Not nullable, Maximum length: 4
settlmtHdrTxtDetnProced- Text Determination Procedure for HeaderConstraints: Not nullable, Maximum length: 2
- Returns:
- A request builder to fetch a single
SetlMgmtHdrTxtObjTypeAssgmtentity 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.
-
getAllSetlMgmtItmTxtObjTypeAssgmt
Deprecated.Fetch multipleSetlMgmtItmTxtObjTypeAssgmtentities.- Returns:
- A request builder to fetch multiple
SetlMgmtItmTxtObjTypeAssgmtentities. 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.
-
countSetlMgmtItmTxtObjTypeAssgmt
Deprecated.Fetch the number of entries from theSetlMgmtItmTxtObjTypeAssgmtentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
SetlMgmtItmTxtObjTypeAssgmtentities. 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.
-
getSetlMgmtItmTxtObjTypeAssgmtByKey
@Nonnull GetByKeyRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt> getSetlMgmtItmTxtObjTypeAssgmtByKey(String settlmtItmTxtDetnProced, String settlmtMgmtItmTxtObjType) Deprecated.Fetch a singleSetlMgmtItmTxtObjTypeAssgmtentity using key fields.- Parameters:
settlmtMgmtItmTxtObjType- Specific Text ID for a Settlement Management Document ItemConstraints: Not nullable, Maximum length: 4
settlmtItmTxtDetnProced- Text Determination Procedure for ItemConstraints: Not nullable, Maximum length: 2
- Returns:
- A request builder to fetch a single
SetlMgmtItmTxtObjTypeAssgmtentity 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.
-