Interface CashSecurityDepositService
- All Known Implementing Classes:
DefaultCashSecurityDepositService
The service contains a list of security deposits. With this service you can create, read, and update cash security deposits. You can change header information, add request documents, reverse, clear, release, partially release, or reset the release of specific cash security deposits. After a request to fetch security deposits is sent, all filtered security deposits are returned. After a security deposit has been created using the Create operation, a new security deposit number and the message header are returned. After a security deposit has been revised, for example, by using the Change or Create Request operation, the number of that revised security deposit and the message header are returned..
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | CASECURITYDEPOSIT_0001 |
| API Version: | 1.0.1 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Finance - Contract Accounting Security Deposits Integration(SAP_COM_0380) |
| Scope Items: | Contract Accounting - Open Item Management(2UJ), Contract Accounting: Open Item Management(PUJ) |
| Authentication Methods: | x509 |
| Service Group Name: | API_CASECURITYDEPOSIT |
| Business Object: | Contract Accounting Security Deposit |
-
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 theCAScrtyDepDocumentFlowentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theCASecurityDepositentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theCASecurityDepositReqDetailentity collection matching the filter and search expressions.createCAScrtyDepDocumentFlow(CAScrtyDepDocumentFlow cAScrtyDepDocumentFlow) Deprecated.Create a newCAScrtyDepDocumentFlowentity and save it to the S/4HANA system.createCASecurityDeposit(CASecurityDeposit cASecurityDeposit) Deprecated.Create a newCASecurityDepositentity and save it to the S/4HANA system.Deprecated.Fetch multipleCAScrtyDepDocumentFlowentities.Deprecated.Fetch multipleCASecurityDepositentities.Deprecated.Fetch multipleCASecurityDepositReqDetailentities.getCAScrtyDepDocumentFlowByKey(String cASecurityDeposit, String cADocumentNumber, String cAScrtyDepositClearedDocument) Deprecated.Fetch a singleCAScrtyDepDocumentFlowentity using key fields.getCASecurityDepositByKey(String cASecurityDeposit) Deprecated.Fetch a singleCASecurityDepositentity using key fields.getCASecurityDepositReqDetailByKey(String cASecurityDeposit, String cADocumentNumber) Deprecated.Fetch a singleCASecurityDepositReqDetailentity 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.
-
getAllCAScrtyDepDocumentFlow
Deprecated.Fetch multipleCAScrtyDepDocumentFlowentities.- Returns:
- A request builder to fetch multiple
CAScrtyDepDocumentFlowentities. 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.
-
countCAScrtyDepDocumentFlow
Deprecated.Fetch the number of entries from theCAScrtyDepDocumentFlowentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
CAScrtyDepDocumentFlowentities. 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.
-
getCAScrtyDepDocumentFlowByKey
@Nonnull GetByKeyRequestBuilder<CAScrtyDepDocumentFlow> getCAScrtyDepDocumentFlowByKey(String cASecurityDeposit, String cADocumentNumber, String cAScrtyDepositClearedDocument) Deprecated.Fetch a singleCAScrtyDepDocumentFlowentity using key fields.- Parameters:
cASecurityDeposit- Security DepositConstraints: Not nullable, Maximum length: 12
cAScrtyDepositClearedDocument- Number of Cleared DocumentConstraints: Not nullable, Maximum length: 12
cADocumentNumber- DocumentConstraints: Not nullable, Maximum length: 12
- Returns:
- A request builder to fetch a single
CAScrtyDepDocumentFlowentity 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.
-
createCAScrtyDepDocumentFlow
@Nonnull CreateRequestBuilder<CAScrtyDepDocumentFlow> createCAScrtyDepDocumentFlow(@Nonnull CAScrtyDepDocumentFlow cAScrtyDepDocumentFlow) Deprecated.Create a newCAScrtyDepDocumentFlowentity and save it to the S/4HANA system.- Parameters:
cAScrtyDepDocumentFlow-CAScrtyDepDocumentFlowentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
CAScrtyDepDocumentFlowentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllCASecurityDeposit
Deprecated.Fetch multipleCASecurityDepositentities.- Returns:
- A request builder to fetch multiple
CASecurityDepositentities. 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.
-
countCASecurityDeposit
Deprecated.Fetch the number of entries from theCASecurityDepositentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
CASecurityDepositentities. 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.
-
getCASecurityDepositByKey
@Nonnull GetByKeyRequestBuilder<CASecurityDeposit> getCASecurityDepositByKey(String cASecurityDeposit) Deprecated.Fetch a singleCASecurityDepositentity using key fields.- Parameters:
cASecurityDeposit- Security DepositConstraints: Not nullable, Maximum length: 12
- Returns:
- A request builder to fetch a single
CASecurityDepositentity 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.
-
createCASecurityDeposit
@Nonnull CreateRequestBuilder<CASecurityDeposit> createCASecurityDeposit(@Nonnull CASecurityDeposit cASecurityDeposit) Deprecated.Create a newCASecurityDepositentity and save it to the S/4HANA system.- Parameters:
cASecurityDeposit-CASecurityDepositentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
CASecurityDepositentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllCASecurityDepositReqDetail
Deprecated.Fetch multipleCASecurityDepositReqDetailentities.- Returns:
- A request builder to fetch multiple
CASecurityDepositReqDetailentities. 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.
-
countCASecurityDepositReqDetail
Deprecated.Fetch the number of entries from theCASecurityDepositReqDetailentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
CASecurityDepositReqDetailentities. 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.
-
getCASecurityDepositReqDetailByKey
@Nonnull GetByKeyRequestBuilder<CASecurityDepositReqDetail> getCASecurityDepositReqDetailByKey(String cASecurityDeposit, String cADocumentNumber) Deprecated.Fetch a singleCASecurityDepositReqDetailentity using key fields.- Parameters:
cASecurityDeposit- Security DepositConstraints: Not nullable, Maximum length: 12
cADocumentNumber- DocumentConstraints: Not nullable, Maximum length: 12
- Returns:
- A request builder to fetch a single
CASecurityDepositReqDetailentity 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.
-