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

Class DefaultBillingDocumentService

java.lang.Object

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

All Implemented Interfaces:

BatchService<BillingDocumentServiceBatch>, BillingDocumentService

@Named("com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBillingDocumentService")
@Deprecated
public class DefaultBillingDocumentService
extends Object
implements BillingDocumentService

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 Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.BillingDocumentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor	Description
DefaultBillingDocumentService()	Deprecated. Creates a service using BillingDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method	Description
DefaultBillingDocumentServiceBatch	batch()	Deprecated.
CancelFluentHelper	cancel(String billingDocument)	Deprecated. Creates a fluent helper for the Cancel OData function import.
BillingDocumentFluentHelper	getAllBillingDocument()	Deprecated. Fetch multiple BillingDocument entities.
BillingDocumentItemFluentHelper	getAllBillingDocumentItem()	Deprecated. Fetch multiple BillingDocumentItem entities.
BillingDocumentItemPartnerFluentHelper	getAllBillingDocumentItemPartner()	Deprecated. Fetch multiple BillingDocumentItemPartner entities.
BillingDocumentItemPrcgElmntFluentHelper	getAllBillingDocumentItemPrcgElmnt()	Deprecated. Fetch multiple BillingDocumentItemPrcgElmnt entities.
BillingDocumentItemTextFluentHelper	getAllBillingDocumentItemText()	Deprecated. Fetch multiple BillingDocumentItemText entities.
BillingDocumentPartnerFluentHelper	getAllBillingDocumentPartner()	Deprecated. Fetch multiple BillingDocumentPartner entities.
BillingDocumentPrcgElmntFluentHelper	getAllBillingDocumentPrcgElmnt()	Deprecated. Fetch multiple BillingDocumentPrcgElmnt entities.
BillingDocumentTextFluentHelper	getAllBillingDocumentText()	Deprecated. Fetch multiple BillingDocumentText entities.
BillingDocumentByKeyFluentHelper	getBillingDocumentByKey(String billingDocument)	Deprecated. Fetch a single BillingDocument entity using key fields.
BillingDocumentItemByKeyFluentHelper	getBillingDocumentItemByKey(String billingDocument, String billingDocumentItem)	Deprecated. Fetch a single BillingDocumentItem entity using key fields.
BillingDocumentItemPartnerByKeyFluentHelper	getBillingDocumentItemPartnerByKey(String billingDocument, String billingDocumentItem, String partnerFunction)	Deprecated. Fetch a single BillingDocumentItemPartner entity using key fields.
BillingDocumentItemPrcgElmntByKeyFluentHelper	getBillingDocumentItemPrcgElmntByKey(String billingDocument, String billingDocumentItem, String pricingProcedureStep, String pricingProcedureCounter)	Deprecated. Fetch a single BillingDocumentItemPrcgElmnt entity using key fields.
BillingDocumentItemTextByKeyFluentHelper	getBillingDocumentItemTextByKey(String billingDocument, String billingDocumentItem, String language, String longTextID)	Deprecated. Fetch a single BillingDocumentItemText entity using key fields.
BillingDocumentPartnerByKeyFluentHelper	getBillingDocumentPartnerByKey(String billingDocument, String partnerFunction)	Deprecated. Fetch a single BillingDocumentPartner entity using key fields.
BillingDocumentPrcgElmntByKeyFluentHelper	getBillingDocumentPrcgElmntByKey(String billingDocument, String pricingProcedureStep, String pricingProcedureCounter)	Deprecated. Fetch a single BillingDocumentPrcgElmnt entity using key fields.
BillingDocumentTextByKeyFluentHelper	getBillingDocumentTextByKey(String billingDocument, String language, String longTextID)	Deprecated. Fetch a single BillingDocumentText entity using key fields.
GetPDFFluentHelper	getPDF(String billingDocument)	Deprecated. Creates a fluent helper for the GetPDF OData function import.
DefaultBillingDocumentService	withServicePath(String servicePath)	Deprecated. Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultBillingDocumentService

public DefaultBillingDocumentService()

Deprecated.

Creates a service using BillingDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Details

withServicePath

@Nonnull
public DefaultBillingDocumentService withServicePath(@Nonnull
 String servicePath)

Deprecated.

Description copied from interface: BillingDocumentService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface BillingDocumentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBillingDocumentServiceBatch batch()

Deprecated.

Specified by:

batch in interface BatchService<BillingDocumentServiceBatch>

getAllBillingDocument

@Nonnull
public BillingDocumentFluentHelper getAllBillingDocument()

Deprecated.

Description copied from interface: BillingDocumentService

Fetch multiple BillingDocument entities.

Specified by:

getAllBillingDocument in interface BillingDocumentService

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
public BillingDocumentByKeyFluentHelper getBillingDocumentByKey(String billingDocument)

Deprecated.

Description copied from interface: BillingDocumentService

Fetch a single BillingDocument entity using key fields.

Specified by:

getBillingDocumentByKey in interface BillingDocumentService

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
public BillingDocumentItemFluentHelper getAllBillingDocumentItem()

Deprecated.

Description copied from interface: BillingDocumentService

Fetch multiple BillingDocumentItem entities.

Specified by:

getAllBillingDocumentItem in interface BillingDocumentService

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
public BillingDocumentItemByKeyFluentHelper getBillingDocumentItemByKey(String billingDocument,
 String billingDocumentItem)

Deprecated.

Description copied from interface: BillingDocumentService

Fetch a single BillingDocumentItem entity using key fields.

Specified by:

getBillingDocumentItemByKey in interface BillingDocumentService

Parameters:

billingDocument - Billing Document

Constraints: Not nullable, Maximum length: 10

billingDocumentItem - Billing Item

Constraints: Not nullable, Maximum length: 6

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
public BillingDocumentItemPartnerFluentHelper getAllBillingDocumentItemPartner()

Deprecated.

Description copied from interface: BillingDocumentService

Fetch multiple BillingDocumentItemPartner entities.

Specified by:

getAllBillingDocumentItemPartner in interface BillingDocumentService

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
public BillingDocumentItemPartnerByKeyFluentHelper getBillingDocumentItemPartnerByKey(String billingDocument,
 String billingDocumentItem,
 String partnerFunction)

Deprecated.

Description copied from interface: BillingDocumentService

Fetch a single BillingDocumentItemPartner entity using key fields.

Specified by:

getBillingDocumentItemPartnerByKey in interface BillingDocumentService

Parameters:

billingDocument - Billing Document

Constraints: Not nullable, Maximum length: 10

billingDocumentItem - Billing Item

Constraints: Not nullable, Maximum length: 6

partnerFunction - Partner Function

Constraints: Not nullable, Maximum length: 2

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
public BillingDocumentItemPrcgElmntFluentHelper getAllBillingDocumentItemPrcgElmnt()

Deprecated.

Description copied from interface: BillingDocumentService

Fetch multiple BillingDocumentItemPrcgElmnt entities.

Specified by:

getAllBillingDocumentItemPrcgElmnt in interface BillingDocumentService

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
public BillingDocumentItemPrcgElmntByKeyFluentHelper getBillingDocumentItemPrcgElmntByKey(String billingDocument,
 String billingDocumentItem,
 String pricingProcedureStep,
 String pricingProcedureCounter)

Deprecated.

Description copied from interface: BillingDocumentService

Fetch a single BillingDocumentItemPrcgElmnt entity using key fields.

Specified by:

getBillingDocumentItemPrcgElmntByKey in interface BillingDocumentService

Parameters:

billingDocument - Billing Document

Constraints: Not nullable, Maximum length: 10

billingDocumentItem - Billing Item

Constraints: Not nullable, Maximum length: 6

pricingProcedureStep - Step Number

Constraints: Not nullable, Maximum length: 3

pricingProcedureCounter - Condition Counter

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
public BillingDocumentItemTextFluentHelper getAllBillingDocumentItemText()

Deprecated.

Description copied from interface: BillingDocumentService

Fetch multiple BillingDocumentItemText entities.

Specified by:

getAllBillingDocumentItemText in interface BillingDocumentService

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
public BillingDocumentItemTextByKeyFluentHelper getBillingDocumentItemTextByKey(String billingDocument,
 String billingDocumentItem,
 String language,
 String longTextID)

Deprecated.

Description copied from interface: BillingDocumentService

Fetch a single BillingDocumentItemText entity using key fields.

Specified by:

getBillingDocumentItemTextByKey in interface BillingDocumentService

Parameters:

billingDocument - Billing Document

Constraints: Not nullable, Maximum length: 10

billingDocumentItem - Billing Item

Constraints: Not nullable, Maximum length: 6

language - Language Key

Constraints: Not nullable, Maximum length: 2

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
public BillingDocumentPartnerFluentHelper getAllBillingDocumentPartner()

Deprecated.

Description copied from interface: BillingDocumentService

Fetch multiple BillingDocumentPartner entities.

Specified by:

getAllBillingDocumentPartner in interface BillingDocumentService

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
public BillingDocumentPartnerByKeyFluentHelper getBillingDocumentPartnerByKey(String billingDocument,
 String partnerFunction)

Deprecated.

Description copied from interface: BillingDocumentService

Fetch a single BillingDocumentPartner entity using key fields.

Specified by:

getBillingDocumentPartnerByKey in interface BillingDocumentService

Parameters:

billingDocument - Billing Document

Constraints: Not nullable, Maximum length: 10

partnerFunction - Partner Function

Constraints: Not nullable, Maximum length: 2

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
public BillingDocumentPrcgElmntFluentHelper getAllBillingDocumentPrcgElmnt()

Deprecated.

Description copied from interface: BillingDocumentService

Fetch multiple BillingDocumentPrcgElmnt entities.

Specified by:

getAllBillingDocumentPrcgElmnt in interface BillingDocumentService

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
public BillingDocumentPrcgElmntByKeyFluentHelper getBillingDocumentPrcgElmntByKey(String billingDocument,
 String pricingProcedureStep,
 String pricingProcedureCounter)

Deprecated.

Description copied from interface: BillingDocumentService

Fetch a single BillingDocumentPrcgElmnt entity using key fields.

Specified by:

getBillingDocumentPrcgElmntByKey in interface BillingDocumentService

Parameters:

billingDocument - Billing Document

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Step Number

Constraints: Not nullable, Maximum length: 3

pricingProcedureCounter - Condition Counter

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
public BillingDocumentTextFluentHelper getAllBillingDocumentText()

Deprecated.

Description copied from interface: BillingDocumentService

Fetch multiple BillingDocumentText entities.

Specified by:

getAllBillingDocumentText in interface BillingDocumentService

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
public BillingDocumentTextByKeyFluentHelper getBillingDocumentTextByKey(String billingDocument,
 String language,
 String longTextID)

Deprecated.

Description copied from interface: BillingDocumentService

Fetch a single BillingDocumentText entity using key fields.

Specified by:

getBillingDocumentTextByKey in interface BillingDocumentService

Parameters:

billingDocument - Billing Document

Constraints: Not nullable, Maximum length: 10

language - Language Key

Constraints: Not nullable, Maximum length: 2

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
public CancelFluentHelper cancel(@Nonnull
 String billingDocument)

Deprecated.

Description copied from interface: BillingDocumentService

Creates a fluent helper for the Cancel OData function import.

Specified by:

cancel in interface BillingDocumentService

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
public GetPDFFluentHelper getPDF(@Nonnull
 String billingDocument)

Deprecated.

Description copied from interface: BillingDocumentService

Creates a fluent helper for the GetPDF OData function import.

Specified by:

getPDF in interface BillingDocumentService

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.