Package com.sap.cloud.sdk.s4hana.datamodel.odata.services

Class DefaultPostLockboxService

java.lang.Object
com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPostLockboxService
All Implemented Interfaces:
BatchService<PostLockboxServiceBatch>, PostLockboxService
@Named("com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPostLockboxService") @Deprecated public class DefaultPostLockboxService extends Object implements PostLockboxService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This service creates lockbox batches, lockbox batch items and clearing information. The lockbox batch root entity and associated entities are sent in the POST request as a payload. After the lockbox batches are created, they are posted immediately and can be processed further using the Manage Lockbox Batches app..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_LOCKBOXPOST_IN
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Finance - Accounts Receivable Lockbox Integration(SAP_COM_0759)
Scope Items: Lockbox(1JT), Lockbox(OJT)
Authentication Methods: x509
Business Object: Accounts Receivable Lockbox

  • Constructor Details

  • Method Details

    • withServicePath

      @Nonnull public DefaultPostLockboxService withServicePath(@Nonnull String servicePath)
      Deprecated.
      Description copied from interface: PostLockboxService
      Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
      Specified by:
      withServicePath in interface PostLockboxService
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.

    • batch

      @Nonnull public DefaultPostLockboxServiceBatch batch()
      Deprecated.
      Specified by:
      batch in interface BatchService<PostLockboxServiceBatch>

    • getAllLockboxBatch

      @Nonnull public LockboxBatchFluentHelper getAllLockboxBatch()
      Deprecated.
      Description copied from interface: PostLockboxService
      Fetch multiple LockboxBatch entities.
      Specified by:
      getAllLockboxBatch in interface PostLockboxService
      Returns:
      A fluent helper to fetch multiple LockboxBatch entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getLockboxBatchByKey

      @Nonnull public LockboxBatchByKeyFluentHelper getLockboxBatchByKey(String lockboxBatchInternalKey, String lockboxBatch)
      Deprecated.
      Description copied from interface: PostLockboxService
      Fetch a single LockboxBatch entity using key fields.
      Specified by:
      getLockboxBatchByKey in interface PostLockboxService
      Parameters:
      lockboxBatchInternalKey - Short Key for Bank Statement (Surrogate Key)

      Constraints: Not nullable, Maximum length: 8

      lockboxBatch - Batch number (bundle number)

      Constraints: Not nullable, Maximum length: 3

      Returns:
      A fluent helper to fetch a single LockboxBatch entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • createLockboxBatch

      @Nonnull public LockboxBatchCreateFluentHelper createLockboxBatch(@Nonnull LockboxBatch lockboxBatch)
      Deprecated.
      Description copied from interface: PostLockboxService
      Create a new LockboxBatch entity and save it to the S/4HANA system.
      Specified by:
      createLockboxBatch in interface PostLockboxService
      Parameters:
      lockboxBatch - LockboxBatch entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new LockboxBatch entity. To perform execution, call the execute method on the fluent helper object.

    • getAllLockboxBatchItem

      @Nonnull public LockboxBatchItemFluentHelper getAllLockboxBatchItem()
      Deprecated.
      Description copied from interface: PostLockboxService
      Fetch multiple LockboxBatchItem entities.
      Specified by:
      getAllLockboxBatchItem in interface PostLockboxService
      Returns:
      A fluent helper to fetch multiple LockboxBatchItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getLockboxBatchItemByKey

      @Nonnull public LockboxBatchItemByKeyFluentHelper getLockboxBatchItemByKey(String lockboxBatchInternalKey, String lockboxBatchItem, String lockboxBatch)
      Deprecated.
      Description copied from interface: PostLockboxService
      Fetch a single LockboxBatchItem entity using key fields.
      Specified by:
      getLockboxBatchItemByKey in interface PostLockboxService
      Parameters:
      lockboxBatchInternalKey - Short Key for Bank Statement (Surrogate Key)

      Constraints: Not nullable, Maximum length: 8

      lockboxBatchItem - Memo Record Number (Line Item Number in Bank Statement)

      Constraints: Not nullable, Maximum length: 5

      lockboxBatch - Batch number (bundle number)

      Constraints: Not nullable, Maximum length: 3

      Returns:
      A fluent helper to fetch a single LockboxBatchItem entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • createLockboxBatchItem

      @Nonnull public LockboxBatchItemCreateFluentHelper createLockboxBatchItem(@Nonnull LockboxBatchItem lockboxBatchItem)
      Deprecated.
      Description copied from interface: PostLockboxService
      Create a new LockboxBatchItem entity and save it to the S/4HANA system.
      Specified by:
      createLockboxBatchItem in interface PostLockboxService
      Parameters:
      lockboxBatchItem - LockboxBatchItem entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new LockboxBatchItem entity. To perform execution, call the execute method on the fluent helper object.

    • getAllLockboxClearing

      @Nonnull public LockboxClearingFluentHelper getAllLockboxClearing()
      Deprecated.
      Description copied from interface: PostLockboxService
      Fetch multiple LockboxClearing entities.
      Specified by:
      getAllLockboxClearing in interface PostLockboxService
      Returns:
      A fluent helper to fetch multiple LockboxClearing entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

    • getLockboxClearingByKey

      @Nonnull public LockboxClearingByKeyFluentHelper getLockboxClearingByKey(String paymentAdvice, String paymentAdviceItem, String paymentAdviceAccount, String paymentAdviceAccountType, String companyCode)
      Deprecated.
      Description copied from interface: PostLockboxService
      Fetch a single LockboxClearing entity using key fields.
      Specified by:
      getLockboxClearingByKey in interface PostLockboxService
      Parameters:
      paymentAdvice - Payment Advice Number

      Constraints: Not nullable, Maximum length: 16

      paymentAdviceItem - Payment Advice Line Item

      Constraints: Not nullable, Maximum length: 5

      paymentAdviceAccount - Account Number

      Constraints: Not nullable, Maximum length: 10

      paymentAdviceAccountType - Payment Advice Account Type

      Constraints: Not nullable, Maximum length: 1

      companyCode - Company Code

      Constraints: Not nullable, Maximum length: 4

      Returns:
      A fluent helper to fetch a single LockboxClearing entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.