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

Interface ConvergentInvoicingDocumentService

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

This API enables you to read invoicing documents in Convergent Invoicing. You can read entire invoicing documents or only parts of the data, using the provided filters. In addition, you can also set or remove the print lock of an invoicing document using the corresponding actions. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: CAINVOICINGDOCUMENT_0001
API Version: 1.0.0
Minimum ERP Version: 2302
Communication Scenario: Convergent Invoicing Integration(SAP_COM_0165)
Scope Items: Convergent Invoicing - Invoice Creation for Usage and Service(2BG), Convergent Invoicing - Recurring and One-Off Items(2T3), Convergent Invoicing - Management and Rating of Consumption Items(3DX), Convergent Invoicing and Contract Accounting for Utilities(3L1), Convergent Invoicing: Invoice Creation for Usage and Service(OBG), Convergent Invoicing：Recurring and One-Off Items(OT3)
Authentication Methods: x509
Service Group Name: API_CAINVOICINGDOCUMENT
Business Object: Contract Accounting Invoicing Document

  • Field Details

  • Method Details

    • withServicePath

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

    • getAllCAInvcgDocItem

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

    • countCAInvcgDocItem

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

    • getCAInvcgDocItemByKey

      @Nonnull GetByKeyRequestBuilder<CAInvcgDocItem> getCAInvcgDocItemByKey(String cAInvoicingDocument, String cAInvcgDocItem)
      Deprecated.
      Fetch a single CAInvcgDocItem entity using key fields.
      Parameters:
      cAInvoicingDocument - Number of Invoicing Document

      Constraints: Not nullable, Maximum length: 12

      cAInvcgDocItem - Sequential Number of Document Item

      Constraints: Not nullable, Maximum length: 8

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

    • getAllCAInvcgDocPosting

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

    • countCAInvcgDocPosting

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

    • getCAInvcgDocPostingByKey

      @Nonnull GetByKeyRequestBuilder<CAInvcgDocPosting> getCAInvcgDocPostingByKey(String cAInvoicingDocument, String cASequenceNumber)
      Deprecated.
      Fetch a single CAInvcgDocPosting entity using key fields.
      Parameters:
      cAInvoicingDocument - Number of Invoicing Document

      Constraints: Not nullable, Maximum length: 12

      cASequenceNumber - Sequence Number

      Constraints: Not nullable, Maximum length: 6

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

    • getAllCAInvcgDocSource

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

    • countCAInvcgDocSource

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

    • getCAInvcgDocSourceByKey

      @Nonnull GetByKeyRequestBuilder<CAInvcgDocSource> getCAInvcgDocSourceByKey(String cAInvcgSourceDocumentCat, String cAInvcgSourceDocumentNumber, String cAInvoicingDocument)
      Deprecated.
      Fetch a single CAInvcgDocSource entity using key fields.
      Parameters:
      cAInvcgSourceDocumentCat - Category of Source Document To Be Invoiced

      Constraints: Not nullable, Maximum length: 5

      cAInvcgSourceDocumentNumber - Source Document Number

      Constraints: Not nullable, Maximum length: 20

      cAInvoicingDocument - Number of Invoicing Document

      Constraints: Not nullable, Maximum length: 12

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

    • getAllCAInvcgDocument

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

    • countCAInvcgDocument

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

    • getCAInvcgDocumentByKey

      @Nonnull GetByKeyRequestBuilder<CAInvcgDocument> getCAInvcgDocumentByKey(String cAInvoicingDocument)
      Deprecated.
      Fetch a single CAInvcgDocument entity using key fields.
      Parameters:
      cAInvoicingDocument - Number of Invoicing Document

      Constraints: Not nullable, Maximum length: 12

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

    • createCAInvcgDocument

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