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

Class DefaultSubsequentBillingDocumentService

java.lang.Object

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

All Implemented Interfaces:

BatchService<SubsequentBillingDocumentServiceBatch>, SubsequentBillingDocumentService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultSubsequentBillingDocumentService")
public class DefaultSubsequentBillingDocumentService
extends Object
implements SubsequentBillingDocumentService

SAP Self-Billing Cockpit uses this service to retrieve details about billing documents in your system that were created with reference to existing billing documents in your system. For example, if a credit memo was created with reference to an invoice, the invoice is the preceding billing document and the credit memo is the subsequent billing document. The service makes the subsequent billing document's data available through a single service entity. This service is intended solely for the integration between SAP S/4HANA Cloud and SAP Self-Billing Cockpit and should not be used for any other purposes. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SUBSQNT_BILLG_DOC_SBI_SRV
API Version:	1
Communication Scenario:	SAP Self-Billing Cockpit Integration (SAP_COM_0564)
Scope Items:	Self-Billing (4H2)
Authentication Methods:	Basic, x509
Business Object:	BillingDocument

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultSubsequentBillingDocumentService() Creates a service using SubsequentBillingDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultSubsequentBillingDocumentServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
SubsqntBillgDocForSelfBillgFluentHelper	getAllSubsqntBillgDocForSelfBillg() Fetch multiple SubsqntBillgDocForSelfBillg entities.
SubsqntBillgDocForSelfBillgByKeyFluentHelper	getSubsqntBillgDocForSelfBillgByKey(String billingDocument, String billingDocumentItem, String subsequentDocument, String subsequentDocumentItem) Fetch a single SubsqntBillgDocForSelfBillg entity using key fields.
DefaultSubsequentBillingDocumentService	withServicePath(String servicePath) 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 Detail

DefaultSubsequentBillingDocumentService

public DefaultSubsequentBillingDocumentService()

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

Method Detail

withServicePath

@Nonnull
public DefaultSubsequentBillingDocumentService withServicePath(@Nonnull
                                                                        String servicePath)

Description copied from interface: SubsequentBillingDocumentService

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 SubsequentBillingDocumentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultSubsequentBillingDocumentServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<SubsequentBillingDocumentServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllSubsqntBillgDocForSelfBillg

@Nonnull
public SubsqntBillgDocForSelfBillgFluentHelper getAllSubsqntBillgDocForSelfBillg()

Description copied from interface: SubsequentBillingDocumentService

Fetch multiple SubsqntBillgDocForSelfBillg entities.

Specified by:

getAllSubsqntBillgDocForSelfBillg in interface SubsequentBillingDocumentService

Returns:

A fluent helper to fetch multiple SubsqntBillgDocForSelfBillg 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.

getSubsqntBillgDocForSelfBillgByKey

@Nonnull
public SubsqntBillgDocForSelfBillgByKeyFluentHelper getSubsqntBillgDocForSelfBillgByKey(String billingDocument,
                                                                                                 String billingDocumentItem,
                                                                                                 String subsequentDocument,
                                                                                                 String subsequentDocumentItem)

Description copied from interface: SubsequentBillingDocumentService

Fetch a single SubsqntBillgDocForSelfBillg entity using key fields.

Specified by:

getSubsqntBillgDocForSelfBillgByKey in interface SubsequentBillingDocumentService

Parameters:

billingDocument - The number that uniquely identifies the billing document (the invoice, for example).

Constraints: Not nullable, Maximum length: 10

billingDocumentItem - Preceding Item of an SD Document

Constraints: Not nullable, Maximum length: 6

subsequentDocument - Number that uniquely identifies the subsequent sales, delivery, or billing document (for example, the sales order that you create from a previous quotation).

Constraints: Not nullable, Maximum length: 10

subsequentDocumentItem - Number that uniquely identifies the item in the subsequent document (for example, in a sales order that you created from a quotation).

Constraints: Not nullable, Maximum length: 6

Returns:

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