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

Interface ContractAccountingDocumentManageService

All Known Implementing Classes:
DefaultContractAccountingDocumentManageService
@Deprecated public interface ContractAccountingDocumentManageService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

Retrieve a list of documents. Read data on document header, document business partner line items and document general ledger line items. Update document header and document business partner line items. Create and delete business locks on existing business partner line items..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: CADOCUMENTMANAGE_0001
API Version: 1.1.0
Minimum ERP Version: 2302
Communication Scenario: Finance - Contract Accounting Open Item Management Integration(SAP_COM_0361)
Scope Items: Contract Accounting - Open Item Management(2UJ), Contract Accounting: Open Item Management(PUJ)
Authentication Methods: x509
Service Group Name: API_CADOCUMENTMANAGE
Business Object: Contract Accounting Document

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull ContractAccountingDocumentManageService 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.

    • batch

      @Nonnull BatchRequestBuilder batch()
      Deprecated.
      Creates a batch request builder object.
      Returns:
      A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

    • getAllBPItem

      @Nonnull GetAllRequestBuilder<CADocBPItem> getAllBPItem()
      Deprecated.
      Fetch multiple CADocBPItem entities.
      Returns:
      A request builder to fetch multiple CADocBPItem 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.

    • countBPItem

      @Nonnull CountRequestBuilder<CADocBPItem> countBPItem()
      Deprecated.
      Fetch the number of entries from the CADocBPItem entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of CADocBPItem 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.

    • getBPItemByKey

      @Nonnull GetByKeyRequestBuilder<CADocBPItem> getBPItemByKey(String cADocumentNumber, String cARepetitionItemNumber, String cABPItemNumber, String cASubItemNumber)
      Deprecated.
      Fetch a single CADocBPItem entity using key fields.
      Parameters:
      cADocumentNumber - Number of a FI-CA Document

      Constraints: Not nullable, Maximum length: 12

      cABPItemNumber - Item Number in FI-CA Document

      Constraints: Not nullable, Maximum length: 4

      cARepetitionItemNumber - Repetition Item in FI-CA Document

      Constraints: Not nullable, Maximum length: 3

      cASubItemNumber - Subitem for a Partial Clearing in Document

      Constraints: Not nullable, Maximum length: 3

      Returns:
      A request builder to fetch a single CADocBPItem 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.

    • createBPItem

      @Nonnull CreateRequestBuilder<CADocBPItem> createBPItem(@Nonnull CADocBPItem cADocBPItem)
      Deprecated.
      Create a new CADocBPItem entity and save it to the S/4HANA system.
      Parameters:
      cADocBPItem - CADocBPItem entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new CADocBPItem entity. To perform execution, call the execute method on the request builder object.

    • updateBPItem

      @Nonnull UpdateRequestBuilder<CADocBPItem> updateBPItem(@Nonnull CADocBPItem cADocBPItem)
      Deprecated.
      Update an existing CADocBPItem entity and save it to the S/4HANA system.
      Parameters:
      cADocBPItem - CADocBPItem entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing CADocBPItem entity. To perform execution, call the execute method on the request builder object.

    • getAllBPItemBusLock

      @Nonnull GetAllRequestBuilder<CADocBPItemBusLock> getAllBPItemBusLock()
      Deprecated.
      Fetch multiple CADocBPItemBusLock entities.
      Returns:
      A request builder to fetch multiple CADocBPItemBusLock 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.

    • countBPItemBusLock

      @Nonnull CountRequestBuilder<CADocBPItemBusLock> countBPItemBusLock()
      Deprecated.
      Fetch the number of entries from the CADocBPItemBusLock entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of CADocBPItemBusLock 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.

    • getBPItemBusLockByKey

      @Nonnull GetByKeyRequestBuilder<CADocBPItemBusLock> getBPItemBusLockByKey(String cADocumentNumber, String cARepetitionItemNumber, String cABPItemNumber, String cASubItemNumber, String cABusinessProcess, String cABusinessLockReason, LocalDate cABusinessLockValidFrom, LocalDate cABusinessLockValidTo)
      Deprecated.
      Fetch a single CADocBPItemBusLock entity using key fields.
      Parameters:
      cABusinessLockValidTo - Lock valid to

      Constraints: Not nullable

      cADocumentNumber - Document

      Constraints: Not nullable, Maximum length: 12

      cABPItemNumber - Item Number in FI-CA Document

      Constraints: Not nullable, Maximum length: 4

      cARepetitionItemNumber - Repetition Item in FI-CA Document

      Constraints: Not nullable, Maximum length: 3

      cABusinessLockValidFrom - Lock valid from

      Constraints: Not nullable

      cABusinessLockReason - Lock Reason

      Constraints: Not nullable, Maximum length: 1

      cABusinessProcess - Process Code (Example: Dunning, Payment)

      Constraints: Not nullable, Maximum length: 2

      cASubItemNumber - Subitem for a Partial Clearing in Document

      Constraints: Not nullable, Maximum length: 3

      Returns:
      A request builder to fetch a single CADocBPItemBusLock 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.

    • deleteBPItemBusLock

      @Nonnull DeleteRequestBuilder<CADocBPItemBusLock> deleteBPItemBusLock(@Nonnull CADocBPItemBusLock cADocBPItemBusLock)
      Deprecated.
      Deletes an existing CADocBPItemBusLock entity in the S/4HANA system.
      Parameters:
      cADocBPItemBusLock - CADocBPItemBusLock entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing CADocBPItemBusLock entity. To perform execution, call the execute method on the request builder object.

    • getAllBPItemLogical

      @Nonnull GetAllRequestBuilder<CADocBPItemLogical> getAllBPItemLogical()
      Deprecated.
      Fetch multiple CADocBPItemLogical entities.
      Returns:
      A request builder to fetch multiple CADocBPItemLogical 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.

    • countBPItemLogical

      @Nonnull CountRequestBuilder<CADocBPItemLogical> countBPItemLogical()
      Deprecated.
      Fetch the number of entries from the CADocBPItemLogical entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of CADocBPItemLogical 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.

    • getBPItemLogicalByKey

      @Nonnull GetByKeyRequestBuilder<CADocBPItemLogical> getBPItemLogicalByKey(String cADocumentNumber, String cARepetitionItemNumber, String cABPItemNumber, String cASubItemNumber)
      Deprecated.
      Fetch a single CADocBPItemLogical entity using key fields.
      Parameters:
      cADocumentNumber - Number of a FI-CA Document

      Constraints: Not nullable, Maximum length: 12

      cABPItemNumber - Item Number in FI-CA Document

      Constraints: Not nullable, Maximum length: 4

      cARepetitionItemNumber - Repetition Item in FI-CA Document

      Constraints: Not nullable, Maximum length: 3

      cASubItemNumber - Subitem for a Partial Clearing in Document

      Constraints: Not nullable, Maximum length: 3

      Returns:
      A request builder to fetch a single CADocBPItemLogical 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.

    • getAllDocumentHeader

      @Nonnull GetAllRequestBuilder<CADocHeader> getAllDocumentHeader()
      Deprecated.
      Fetch multiple CADocHeader entities.
      Returns:
      A request builder to fetch multiple CADocHeader 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.

    • countDocumentHeader

      @Nonnull CountRequestBuilder<CADocHeader> countDocumentHeader()
      Deprecated.
      Fetch the number of entries from the CADocHeader entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of CADocHeader 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.

    • getDocumentHeaderByKey

      @Nonnull GetByKeyRequestBuilder<CADocHeader> getDocumentHeaderByKey(String cADocumentNumber)
      Deprecated.
      Fetch a single CADocHeader entity using key fields.
      Parameters:
      cADocumentNumber - Number of a FI-CA Document

      Constraints: Not nullable, Maximum length: 12

      Returns:
      A request builder to fetch a single CADocHeader 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.

    • updateDocumentHeader

      @Nonnull UpdateRequestBuilder<CADocHeader> updateDocumentHeader(@Nonnull CADocHeader cADocHeader)
      Deprecated.
      Update an existing CADocHeader entity and save it to the S/4HANA system.
      Parameters:
      cADocHeader - CADocHeader entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing CADocHeader entity. To perform execution, call the execute method on the request builder object.

    • getAllGLItem

      @Nonnull GetAllRequestBuilder<CADocGLItem> getAllGLItem()
      Deprecated.
      Fetch multiple CADocGLItem entities.
      Returns:
      A request builder to fetch multiple CADocGLItem 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.

    • countGLItem

      @Nonnull CountRequestBuilder<CADocGLItem> countGLItem()
      Deprecated.
      Fetch the number of entries from the CADocGLItem entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of CADocGLItem 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.

    • getGLItemByKey

      @Nonnull GetByKeyRequestBuilder<CADocGLItem> getGLItemByKey(String cADocumentNumber, String cAGLItemNumber)
      Deprecated.
      Fetch a single CADocGLItem entity using key fields.
      Parameters:
      cADocumentNumber - Number of a FI-CA Document

      Constraints: Not nullable, Maximum length: 12

      cAGLItemNumber - Item Number in FI-CA Document

      Constraints: Not nullable, Maximum length: 4

      Returns:
      A request builder to fetch a single CADocGLItem 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.