com.sap.cloud.sdk.s4hana.datamodel.odata.services.BillingDocumentRequestService Maven / Gradle / Ivy
/*
* Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
*/
package com.sap.cloud.sdk.s4hana.datamodel.odata.services;
import javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPartnerByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPartnerFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPrcgElmntByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPrcgElmntFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPartnerByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPartnerFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPrcgElmntByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPrcgElmntFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequest;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.RejectFluentHelper;
/**
*
* This inbound service enables external systems and other consumers to read, reject, and delete billing document
* requests inside your SAP S/4HANA Cloud system data through API calls. The service makes billing document request data
* available through its header, item, business partner, and pricing element entities.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_BILLING_DOCUMENT_REQUEST_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* External Billing Document Request Integration (SAP_COM_0176)
*
*
* Scope Items:
* Convergent Billing (1MC),
* Sales Order Processing - Project-Based Services (J14)
*
*
* Business Object:
* BillingDocumentRequest
*
*
*
*/
public interface BillingDocumentRequestService
{
/**
* If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path
* used to access the endpoint.
*
*/
String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/API_BILLING_DOCUMENT_REQUEST_SRV";
/**
* Overrides the default service path and returns a new service instance with the specified service path. Also
* adjusts the respective entity URLs.
*
* @param servicePath
* Service path that will override the default.
* @return A new service instance with the specified service path.
*/
@Nonnull
BillingDocumentRequestService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPartner
* BillingDocReqItemPartner} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPartner
* BillingDocReqItemPartner} entities. This fluent helper allows methods which modify the underlying query
* to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPartnerFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocReqItemPartnerFluentHelper getAllBillingDocReqItemPartner();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPartner
* BillingDocReqItemPartner} entity using key fields.
*
* @param billingDocumentRequest
* Billing Document Request
*
* Constraints: Not nullable, Maximum length: 10
*
* @param partnerFunction
* The abbreviated form of the name that identifies the partner function.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param billingDocumentRequestItem
* Billing Document Request Item
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPartner
* BillingDocReqItemPartner} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPartnerByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocReqItemPartnerByKeyFluentHelper getBillingDocReqItemPartnerByKey(
final String billingDocumentRequest,
final String billingDocumentRequestItem,
final String partnerFunction );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPrcgElmnt
* BillingDocReqItemPrcgElmnt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPrcgElmnt
* BillingDocReqItemPrcgElmnt} entities. This fluent helper allows methods which modify the underlying query
* to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPrcgElmntFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocReqItemPrcgElmntFluentHelper getAllBillingDocReqItemPrcgElmnt();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPrcgElmnt
* BillingDocReqItemPrcgElmnt} entity using key fields.
*
* @param billingDocumentRequest
* Billing Document Request
*
* Constraints: Not nullable, Maximum length: 10
*
* @param billingDocumentRequestItem
* The number that uniquely identifies the item in the billing document.
*
* Constraints: Not nullable, Maximum length: 6
*
* @param pricingProcedureCounter
* Access number of the conditions within a step in the pricing procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param pricingProcedureStep
* Number that determines the sequence of the condition within a procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPrcgElmnt
* BillingDocReqItemPrcgElmnt} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqItemPrcgElmntByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocReqItemPrcgElmntByKeyFluentHelper getBillingDocReqItemPrcgElmntByKey(
final String billingDocumentRequest,
final String billingDocumentRequestItem,
final String pricingProcedureStep,
final String pricingProcedureCounter );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPartner
* BillingDocReqPartner} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPartner
* BillingDocReqPartner} entities. This fluent helper allows methods which modify the underlying query to be
* called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPartnerFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocReqPartnerFluentHelper getAllBillingDocReqPartner();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPartner
* BillingDocReqPartner} entity using key fields.
*
* @param billingDocumentRequest
* Billing Document Request
*
* Constraints: Not nullable, Maximum length: 10
*
* @param partnerFunction
* The abbreviated form of the name that identifies the partner function.
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPartner
* BillingDocReqPartner} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPartnerByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocReqPartnerByKeyFluentHelper
getBillingDocReqPartnerByKey( final String billingDocumentRequest, final String partnerFunction );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPrcgElmnt
* BillingDocReqPrcgElmnt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPrcgElmnt
* BillingDocReqPrcgElmnt} entities. This fluent helper allows methods which modify the underlying query to
* be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPrcgElmntFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocReqPrcgElmntFluentHelper getAllBillingDocReqPrcgElmnt();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPrcgElmnt
* BillingDocReqPrcgElmnt} entity using key fields.
*
* @param billingDocumentRequest
* Billing Document Request
*
* Constraints: Not nullable, Maximum length: 10
*
* @param pricingProcedureCounter
* Access number of the conditions within a step in the pricing procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param pricingProcedureStep
* Number that determines the sequence of the condition within a procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPrcgElmnt
* BillingDocReqPrcgElmnt} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocReqPrcgElmntByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocReqPrcgElmntByKeyFluentHelper getBillingDocReqPrcgElmntByKey(
final String billingDocumentRequest,
final String pricingProcedureStep,
final String pricingProcedureCounter );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequest
* BillingDocumentRequest} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequest
* BillingDocumentRequest} entities. This fluent helper allows methods which modify the underlying query to
* be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentRequestFluentHelper getAllBillingDocumentRequest();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequest
* BillingDocumentRequest} entity using key fields.
*
* @param billingDocumentRequest
* Billing Document Request
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequest
* BillingDocumentRequest} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentRequestByKeyFluentHelper getBillingDocumentRequestByKey( final String billingDocumentRequest );
/**
* Deletes an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequest
* BillingDocumentRequest} entity in the S/4HANA system.
*
* @param billingDocumentRequest
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequest
* BillingDocumentRequest} entity object that will be deleted in the S/4HANA system.
* @return A fluent helper to delete an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequest
* BillingDocumentRequest} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestDeleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentRequestDeleteFluentHelper
deleteBillingDocumentRequest( @Nonnull final BillingDocumentRequest billingDocumentRequest );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestItem
* BillingDocumentRequestItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestItem
* BillingDocumentRequestItem} entities. This fluent helper allows methods which modify the underlying query
* to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentRequestItemFluentHelper getAllBillingDocumentRequestItem();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestItem
* BillingDocumentRequestItem} entity using key fields.
*
* @param billingDocumentRequest
* Billing Document Request
*
* Constraints: Not nullable, Maximum length: 10
*
* @param billingDocumentRequestItem
* Billing Document Request Item
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestItem
* BillingDocumentRequestItem} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.BillingDocumentRequestItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentRequestItemByKeyFluentHelper getBillingDocumentRequestItemByKey(
final String billingDocumentRequest,
final String billingDocumentRequestItem );
/**
*
* Creates a fluent helper for the Reject OData function import.
*
*
* @param billingDocumentRequest
* Constraints: Not nullable, Maximum length: 10
*
* Original parameter name from the Odata EDM: BillingDocumentRequest
*
* @return A fluent helper object that will execute the Reject OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocumentrequest.RejectFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
RejectFluentHelper reject( final String billingDocumentRequest );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy