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

Interface BillingDocumentService

All Superinterfaces:
BatchService<BillingDocumentServiceBatch>
All Known Implementing Classes:
DefaultBillingDocumentService
@Deprecated public interface BillingDocumentService extends BatchService<BillingDocumentServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

Consumers of this inbound service can read and cancel billing documents inside your system by sending OData requests. In addition, they can request entire billing documents in PDF format. The service makes billing document data available through its header, item, business partner, and pricing element entities..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_BILLING_DOCUMENT_SRV
API Version: 1.1.0
Minimum ERP Version: 2302
Communication Scenario: Billing Integration(SAP_COM_0120), Excise Tax Integration(SAP_COM_0568)
Scope Items: External Billing(1Z6), External Billing(OZ6), Enablement of SAP Excise Tax Management(4LO)
Authentication Methods: x509
Business Object: Billing Document

  • Field Details

  • Method Details

    • withServicePath

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

    • getAllBillingDocument

      @Nonnull BillingDocumentFluentHelper getAllBillingDocument()
      Deprecated.
      Fetch multiple BillingDocument entities.
      Returns:
      A fluent helper to fetch multiple BillingDocument 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.

    • getBillingDocumentByKey

      @Nonnull BillingDocumentByKeyFluentHelper getBillingDocumentByKey(String billingDocument)
      Deprecated.
      Fetch a single BillingDocument entity using key fields.
      Parameters:
      billingDocument - Billing Document

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A fluent helper to fetch a single BillingDocument 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.

    • getAllBillingDocumentItem

      @Nonnull BillingDocumentItemFluentHelper getAllBillingDocumentItem()
      Deprecated.
      Fetch multiple BillingDocumentItem entities.
      Returns:
      A fluent helper to fetch multiple BillingDocumentItem 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.

    • getBillingDocumentItemByKey

      @Nonnull BillingDocumentItemByKeyFluentHelper getBillingDocumentItemByKey(String billingDocument, String billingDocumentItem)
      Deprecated.
      Fetch a single BillingDocumentItem entity using key fields.
      Parameters:
      billingDocumentItem - Billing Item

      Constraints: Not nullable, Maximum length: 6

      billingDocument - Billing Document

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A fluent helper to fetch a single BillingDocumentItem 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.

    • getAllBillingDocumentItemPartner

      @Nonnull BillingDocumentItemPartnerFluentHelper getAllBillingDocumentItemPartner()
      Deprecated.
      Fetch multiple BillingDocumentItemPartner entities.
      Returns:
      A fluent helper to fetch multiple BillingDocumentItemPartner 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.

    • getBillingDocumentItemPartnerByKey

      @Nonnull BillingDocumentItemPartnerByKeyFluentHelper getBillingDocumentItemPartnerByKey(String billingDocument, String billingDocumentItem, String partnerFunction)
      Deprecated.
      Fetch a single BillingDocumentItemPartner entity using key fields.
      Parameters:
      partnerFunction - Partner Function

      Constraints: Not nullable, Maximum length: 2

      billingDocumentItem - Billing Item

      Constraints: Not nullable, Maximum length: 6

      billingDocument - Billing Document

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A fluent helper to fetch a single BillingDocumentItemPartner 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.

    • getAllBillingDocumentItemPrcgElmnt

      @Nonnull BillingDocumentItemPrcgElmntFluentHelper getAllBillingDocumentItemPrcgElmnt()
      Deprecated.
      Fetch multiple BillingDocumentItemPrcgElmnt entities.
      Returns:
      A fluent helper to fetch multiple BillingDocumentItemPrcgElmnt 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.

    • getBillingDocumentItemPrcgElmntByKey

      @Nonnull BillingDocumentItemPrcgElmntByKeyFluentHelper getBillingDocumentItemPrcgElmntByKey(String billingDocument, String billingDocumentItem, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single BillingDocumentItemPrcgElmnt entity using key fields.
      Parameters:
      billingDocumentItem - Billing Item

      Constraints: Not nullable, Maximum length: 6

      pricingProcedureCounter - Condition Counter

      Constraints: Not nullable, Maximum length: 3

      billingDocument - Billing Document

      Constraints: Not nullable, Maximum length: 10

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

      Returns:
      A fluent helper to fetch a single BillingDocumentItemPrcgElmnt 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.

    • getAllBillingDocumentItemText

      @Nonnull BillingDocumentItemTextFluentHelper getAllBillingDocumentItemText()
      Deprecated.
      Fetch multiple BillingDocumentItemText entities.
      Returns:
      A fluent helper to fetch multiple BillingDocumentItemText 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.

    • getBillingDocumentItemTextByKey

      @Nonnull BillingDocumentItemTextByKeyFluentHelper getBillingDocumentItemTextByKey(String billingDocument, String billingDocumentItem, String language, String longTextID)
      Deprecated.
      Fetch a single BillingDocumentItemText entity using key fields.
      Parameters:
      billingDocumentItem - Billing Item

      Constraints: Not nullable, Maximum length: 6

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      billingDocument - Billing Document

      Constraints: Not nullable, Maximum length: 10

      longTextID - Text ID

      Constraints: Not nullable, Maximum length: 4

      Returns:
      A fluent helper to fetch a single BillingDocumentItemText 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.

    • getAllBillingDocumentPartner

      @Nonnull BillingDocumentPartnerFluentHelper getAllBillingDocumentPartner()
      Deprecated.
      Fetch multiple BillingDocumentPartner entities.
      Returns:
      A fluent helper to fetch multiple BillingDocumentPartner 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.

    • getBillingDocumentPartnerByKey

      @Nonnull BillingDocumentPartnerByKeyFluentHelper getBillingDocumentPartnerByKey(String billingDocument, String partnerFunction)
      Deprecated.
      Fetch a single BillingDocumentPartner entity using key fields.
      Parameters:
      partnerFunction - Partner Function

      Constraints: Not nullable, Maximum length: 2

      billingDocument - Billing Document

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A fluent helper to fetch a single BillingDocumentPartner 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.

    • getAllBillingDocumentPrcgElmnt

      @Nonnull BillingDocumentPrcgElmntFluentHelper getAllBillingDocumentPrcgElmnt()
      Deprecated.
      Fetch multiple BillingDocumentPrcgElmnt entities.
      Returns:
      A fluent helper to fetch multiple BillingDocumentPrcgElmnt 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.

    • getBillingDocumentPrcgElmntByKey

      @Nonnull BillingDocumentPrcgElmntByKeyFluentHelper getBillingDocumentPrcgElmntByKey(String billingDocument, String pricingProcedureStep, String pricingProcedureCounter)
      Deprecated.
      Fetch a single BillingDocumentPrcgElmnt entity using key fields.
      Parameters:
      pricingProcedureCounter - Condition Counter

      Constraints: Not nullable, Maximum length: 3

      billingDocument - Billing Document

      Constraints: Not nullable, Maximum length: 10

      pricingProcedureStep - Step Number

      Constraints: Not nullable, Maximum length: 3

      Returns:
      A fluent helper to fetch a single BillingDocumentPrcgElmnt 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.

    • getAllBillingDocumentText

      @Nonnull BillingDocumentTextFluentHelper getAllBillingDocumentText()
      Deprecated.
      Fetch multiple BillingDocumentText entities.
      Returns:
      A fluent helper to fetch multiple BillingDocumentText 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.

    • getBillingDocumentTextByKey

      @Nonnull BillingDocumentTextByKeyFluentHelper getBillingDocumentTextByKey(String billingDocument, String language, String longTextID)
      Deprecated.
      Fetch a single BillingDocumentText entity using key fields.
      Parameters:
      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      billingDocument - Billing Document

      Constraints: Not nullable, Maximum length: 10

      longTextID - Text ID

      Constraints: Not nullable, Maximum length: 4

      Returns:
      A fluent helper to fetch a single BillingDocumentText 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.

    • cancel

      @Nonnull CancelFluentHelper cancel(@Nonnull String billingDocument)
      Deprecated.

      Creates a fluent helper for the Cancel OData function import.

      Parameters:
      billingDocument - Constraints: Not nullable, Maximum length: 11000

      Original parameter name from the Odata EDM: BillingDocument

      Returns:
      A fluent helper object that will execute the Cancel OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

    • getPDF

      @Nonnull GetPDFFluentHelper getPDF(@Nonnull String billingDocument)
      Deprecated.

      Creates a fluent helper for the GetPDF OData function import.

      Parameters:
      billingDocument - Constraints: Not nullable, Maximum length: 11000

      Original parameter name from the Odata EDM: BillingDocument

      Returns:
      A fluent helper object that will execute the GetPDF OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.