Interface ConvergentInvoicingBillingDocumentService

All Known Implementing Classes:
DefaultConvergentInvoicingBillingDocumentService

@Deprecated public interface ConvergentInvoicingBillingDocumentService
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 billing documents in Convergent Invoicing. You can read entire billing documents or only parts of the data, using the provided filters. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: CABILLINGDOCUMENT_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_CABILLINGDOCUMENT
Business Object: Contract Accounting Billing Document
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull ConvergentInvoicingBillingDocumentService 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.
    • getAllCABillgDocItem

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

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

      @Nonnull GetByKeyRequestBuilder<CABillgDocItem> getCABillgDocItemByKey(String cABillgDocument, String cABillgDocItem)
      Deprecated.
      Fetch a single CABillgDocItem entity using key fields.
      Parameters:
      cABillgDocItem - Sequential Number of Document Item

      Constraints: Not nullable, Maximum length: 8

      cABillgDocument - Number of Billing Document

      Constraints: Not nullable, Maximum length: 12

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

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

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

      @Nonnull GetByKeyRequestBuilder<CABillgDocSource> getCABillgDocSourceByKey(String cABillgDocument, String cABillgDocSourceItem)
      Deprecated.
      Fetch a single CABillgDocSource entity using key fields.
      Parameters:
      cABillgDocument - Number of Billing Document

      Constraints: Not nullable, Maximum length: 12

      cABillgDocSourceItem - Sequence Number of Source Item

      Constraints: Not nullable, Maximum length: 8

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

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

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

      @Nonnull GetByKeyRequestBuilder<CABillgDocument> getCABillgDocumentByKey(String cABillgDocument)
      Deprecated.
      Fetch a single CABillgDocument entity using key fields.
      Parameters:
      cABillgDocument - Number of Billing Document

      Constraints: Not nullable, Maximum length: 12

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