public interface SettlementDocumentTypeService
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 API Business Hub
OData Service: | SETTLMTDOCTYPE_0001 |
API Version: | 1 |
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: | Basic, x509 |
Service Group Name: | API_SETTLMT_DOC_TYPE |
Business Object: | SettlementDocumentType |
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. |
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull SettlementDocumentTypeService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull BatchRequestBuilder batch()
execute
method on the request builder object.@Nonnull GetAllRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt> getAllSetlMgmtHdrTxtObjTypeAssgmt()
SetlMgmtHdrTxtObjTypeAssgmt
entities.SetlMgmtHdrTxtObjTypeAssgmt
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<SetlMgmtHdrTxtObjTypeAssgmt> countSetlMgmtHdrTxtObjTypeAssgmt()
SetlMgmtHdrTxtObjTypeAssgmt
entity collection matching the filter and search expressions.SetlMgmtHdrTxtObjTypeAssgmt
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<SetlMgmtHdrTxtObjTypeAssgmt> getSetlMgmtHdrTxtObjTypeAssgmtByKey(@Nonnull String settlmtHdrTxtDetnProced, @Nonnull String settlmtMgmtHdrTxtObjType)
SetlMgmtHdrTxtObjTypeAssgmt
entity using key fields.settlmtMgmtHdrTxtObjType
- Specific Text ID for a Settlement Management Document Header
Constraints: Not nullable, Maximum length: 4
settlmtHdrTxtDetnProced
- Text Determination Procedure for Header
Constraints: Not nullable, Maximum length: 2
SetlMgmtHdrTxtObjTypeAssgmt
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 GetAllRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt> getAllSetlMgmtItmTxtObjTypeAssgmt()
SetlMgmtItmTxtObjTypeAssgmt
entities.SetlMgmtItmTxtObjTypeAssgmt
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<SetlMgmtItmTxtObjTypeAssgmt> countSetlMgmtItmTxtObjTypeAssgmt()
SetlMgmtItmTxtObjTypeAssgmt
entity collection matching the filter and search expressions.SetlMgmtItmTxtObjTypeAssgmt
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<SetlMgmtItmTxtObjTypeAssgmt> getSetlMgmtItmTxtObjTypeAssgmtByKey(@Nonnull String settlmtItmTxtDetnProced, @Nonnull String settlmtMgmtItmTxtObjType)
SetlMgmtItmTxtObjTypeAssgmt
entity using key fields.settlmtMgmtItmTxtObjType
- Specific Text ID for a Settlement Management Document Item
Constraints: Not nullable, Maximum length: 4
settlmtItmTxtDetnProced
- Text Determination Procedure for Item
Constraints: Not nullable, Maximum length: 2
SetlMgmtItmTxtObjTypeAssgmt
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 GetAllRequestBuilder<SettlmtDocType> getAllSettlmtDocType()
SettlmtDocType
entities.SettlmtDocType
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<SettlmtDocType> countSettlmtDocType()
SettlmtDocType
entity collection matching the filter and search expressions.SettlmtDocType
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<SettlmtDocType> getSettlmtDocTypeByKey(@Nonnull String settlmtDocType)
SettlmtDocType
entity using key fields.settlmtDocType
- Settlement Document Type
Constraints: Not nullable, Maximum length: 4
SettlmtDocType
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.Copyright © 2021 SAP SE. All rights reserved.