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

Class DefaultConvergentInvoicingDocumentService

java.lang.Object

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

All Implemented Interfaces:

OperationsOnEntityCollections, ServiceWithNavigableEntities, ConvergentInvoicingDocumentService

@Named("com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultConvergentInvoicingDocumentService")
@Deprecated
public class DefaultConvergentInvoicingDocumentService
extends Object
implements ServiceWithNavigableEntities, 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 Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.ConvergentInvoicingDocumentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor	Description
DefaultConvergentInvoicingDocumentService()	Deprecated. Creates a service using ConvergentInvoicingDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Deprecated. Creates a batch request builder object.
CountRequestBuilder<CAInvcgDocItem>	countCAInvcgDocItem()	Deprecated. Fetch the number of entries from the CAInvcgDocItem entity collection matching the filter and search expressions.
CountRequestBuilder<CAInvcgDocPosting>	countCAInvcgDocPosting()	Deprecated. Fetch the number of entries from the CAInvcgDocPosting entity collection matching the filter and search expressions.
CountRequestBuilder<CAInvcgDocSource>	countCAInvcgDocSource()	Deprecated. Fetch the number of entries from the CAInvcgDocSource entity collection matching the filter and search expressions.
CountRequestBuilder<CAInvcgDocument>	countCAInvcgDocument()	Deprecated. Fetch the number of entries from the CAInvcgDocument entity collection matching the filter and search expressions.
CreateRequestBuilder<CAInvcgDocument>	createCAInvcgDocument(CAInvcgDocument cAInvcgDocument)	Deprecated. Create a new CAInvcgDocument entity and save it to the S/4HANA system.
GetAllRequestBuilder<CAInvcgDocItem>	getAllCAInvcgDocItem()	Deprecated. Fetch multiple CAInvcgDocItem entities.
GetAllRequestBuilder<CAInvcgDocPosting>	getAllCAInvcgDocPosting()	Deprecated. Fetch multiple CAInvcgDocPosting entities.
GetAllRequestBuilder<CAInvcgDocSource>	getAllCAInvcgDocSource()	Deprecated. Fetch multiple CAInvcgDocSource entities.
GetAllRequestBuilder<CAInvcgDocument>	getAllCAInvcgDocument()	Deprecated. Fetch multiple CAInvcgDocument entities.
GetByKeyRequestBuilder<CAInvcgDocItem>	getCAInvcgDocItemByKey(String cAInvoicingDocument, String cAInvcgDocItem)	Deprecated. Fetch a single CAInvcgDocItem entity using key fields.
GetByKeyRequestBuilder<CAInvcgDocPosting>	getCAInvcgDocPostingByKey(String cAInvoicingDocument, String cASequenceNumber)	Deprecated. Fetch a single CAInvcgDocPosting entity using key fields.
GetByKeyRequestBuilder<CAInvcgDocSource>	getCAInvcgDocSourceByKey(String cAInvcgSourceDocumentCat, String cAInvcgSourceDocumentNumber, String cAInvoicingDocument)	Deprecated. Fetch a single CAInvcgDocSource entity using key fields.
GetByKeyRequestBuilder<CAInvcgDocument>	getCAInvcgDocumentByKey(String cAInvoicingDocument)	Deprecated. Fetch a single CAInvcgDocument entity using key fields.
String	getServicePath()	Deprecated.
DefaultConvergentInvoicingDocumentService	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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

applyAction, applyAction, applyFunction, applyFunction, forEntity, withFunction, withFunction

Constructor Details

DefaultConvergentInvoicingDocumentService

public DefaultConvergentInvoicingDocumentService()

Deprecated.

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

Method Details

withServicePath

@Nonnull
public DefaultConvergentInvoicingDocumentService withServicePath(@Nonnull
 String servicePath)

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

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 ConvergentInvoicingDocumentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Creates a batch request builder object.

Specified by:

batch in interface ConvergentInvoicingDocumentService

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
public GetAllRequestBuilder<CAInvcgDocItem> getAllCAInvcgDocItem()

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch multiple CAInvcgDocItem entities.

Specified by:

getAllCAInvcgDocItem in interface ConvergentInvoicingDocumentService

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
public CountRequestBuilder<CAInvcgDocItem> countCAInvcgDocItem()

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch the number of entries from the CAInvcgDocItem entity collection matching the filter and search expressions.

Specified by:

countCAInvcgDocItem in interface ConvergentInvoicingDocumentService

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
public GetByKeyRequestBuilder<CAInvcgDocItem> getCAInvcgDocItemByKey(String cAInvoicingDocument,
 String cAInvcgDocItem)

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch a single CAInvcgDocItem entity using key fields.

Specified by:

getCAInvcgDocItemByKey in interface ConvergentInvoicingDocumentService

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
public GetAllRequestBuilder<CAInvcgDocPosting> getAllCAInvcgDocPosting()

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch multiple CAInvcgDocPosting entities.

Specified by:

getAllCAInvcgDocPosting in interface ConvergentInvoicingDocumentService

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
public CountRequestBuilder<CAInvcgDocPosting> countCAInvcgDocPosting()

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch the number of entries from the CAInvcgDocPosting entity collection matching the filter and search expressions.

Specified by:

countCAInvcgDocPosting in interface ConvergentInvoicingDocumentService

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
public GetByKeyRequestBuilder<CAInvcgDocPosting> getCAInvcgDocPostingByKey(String cAInvoicingDocument,
 String cASequenceNumber)

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch a single CAInvcgDocPosting entity using key fields.

Specified by:

getCAInvcgDocPostingByKey in interface ConvergentInvoicingDocumentService

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
public GetAllRequestBuilder<CAInvcgDocSource> getAllCAInvcgDocSource()

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch multiple CAInvcgDocSource entities.

Specified by:

getAllCAInvcgDocSource in interface ConvergentInvoicingDocumentService

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
public CountRequestBuilder<CAInvcgDocSource> countCAInvcgDocSource()

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch the number of entries from the CAInvcgDocSource entity collection matching the filter and search expressions.

Specified by:

countCAInvcgDocSource in interface ConvergentInvoicingDocumentService

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
public GetByKeyRequestBuilder<CAInvcgDocSource> getCAInvcgDocSourceByKey(String cAInvcgSourceDocumentCat,
 String cAInvcgSourceDocumentNumber,
 String cAInvoicingDocument)

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch a single CAInvcgDocSource entity using key fields.

Specified by:

getCAInvcgDocSourceByKey in interface ConvergentInvoicingDocumentService

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
public GetAllRequestBuilder<CAInvcgDocument> getAllCAInvcgDocument()

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch multiple CAInvcgDocument entities.

Specified by:

getAllCAInvcgDocument in interface ConvergentInvoicingDocumentService

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
public CountRequestBuilder<CAInvcgDocument> countCAInvcgDocument()

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch the number of entries from the CAInvcgDocument entity collection matching the filter and search expressions.

Specified by:

countCAInvcgDocument in interface ConvergentInvoicingDocumentService

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
public GetByKeyRequestBuilder<CAInvcgDocument> getCAInvcgDocumentByKey(String cAInvoicingDocument)

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Fetch a single CAInvcgDocument entity using key fields.

Specified by:

getCAInvcgDocumentByKey in interface ConvergentInvoicingDocumentService

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
public CreateRequestBuilder<CAInvcgDocument> createCAInvcgDocument(@Nonnull
 CAInvcgDocument cAInvcgDocument)

Deprecated.

Description copied from interface: ConvergentInvoicingDocumentService

Create a new CAInvcgDocument entity and save it to the S/4HANA system.

Specified by:

createCAInvcgDocument in interface ConvergentInvoicingDocumentService

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.

getServicePath

@Nonnull
public String getServicePath()

Deprecated.

Specified by:

getServicePath in interface ServiceWithNavigableEntities