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

Interface PostLockboxService

All Superinterfaces:
BatchService<PostLockboxServiceBatch>
All Known Implementing Classes:
DefaultPostLockboxService
@Deprecated public interface PostLockboxService extends BatchService<PostLockboxServiceBatch>
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

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull PostLockboxService withServicePath(@Nonnull String servicePath)
      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.

    • getAllLockboxBatch

      @Nonnull LockboxBatchFluentHelper getAllLockboxBatch()
      Deprecated.
      Fetch multiple LockboxBatch entities.
      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 LockboxBatchByKeyFluentHelper getLockboxBatchByKey(String lockboxBatchInternalKey, String lockboxBatch)
      Deprecated.
      Fetch a single LockboxBatch entity using key fields.
      Parameters:
      lockboxBatch - Batch number (bundle number)

      Constraints: Not nullable, Maximum length: 3

      lockboxBatchInternalKey - Short Key for Bank Statement (Surrogate Key)

      Constraints: Not nullable, Maximum length: 8

      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 LockboxBatchCreateFluentHelper createLockboxBatch(@Nonnull LockboxBatch lockboxBatch)
      Deprecated.
      Create a new LockboxBatch entity and save it to the S/4HANA system.
      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 LockboxBatchItemFluentHelper getAllLockboxBatchItem()
      Deprecated.
      Fetch multiple LockboxBatchItem entities.
      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 LockboxBatchItemByKeyFluentHelper getLockboxBatchItemByKey(String lockboxBatchInternalKey, String lockboxBatchItem, String lockboxBatch)
      Deprecated.
      Fetch a single LockboxBatchItem entity using key fields.
      Parameters:
      lockboxBatch - Batch number (bundle number)

      Constraints: Not nullable, Maximum length: 3

      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

      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 LockboxBatchItemCreateFluentHelper createLockboxBatchItem(@Nonnull LockboxBatchItem lockboxBatchItem)
      Deprecated.
      Create a new LockboxBatchItem entity and save it to the S/4HANA system.
      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 LockboxClearingFluentHelper getAllLockboxClearing()
      Deprecated.
      Fetch multiple LockboxClearing entities.
      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 LockboxClearingByKeyFluentHelper getLockboxClearingByKey(String paymentAdvice, String paymentAdviceItem, String paymentAdviceAccount, String paymentAdviceAccountType, String companyCode)
      Deprecated.
      Fetch a single LockboxClearing entity using key fields.
      Parameters:
      companyCode - Company Code

      Constraints: Not nullable, Maximum length: 4

      paymentAdviceAccountType - Payment Advice Account Type

      Constraints: Not nullable, Maximum length: 1

      paymentAdvice - Payment Advice Number

      Constraints: Not nullable, Maximum length: 16

      paymentAdviceAccount - Account Number

      Constraints: Not nullable, Maximum length: 10

      paymentAdviceItem - Payment Advice Line Item

      Constraints: Not nullable, Maximum length: 5

      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.