com.sap.cloud.sdk.s4hana.datamodel.odata.services.BillingDocumentService 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.billingdocument.BillingDocumentByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPartnerByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPartnerFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPrcgElmntByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPrcgElmntFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPartnerByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPartnerFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPrcgElmntByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPrcgElmntFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.CancelFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.GetPDFFluentHelper;
/**
*
* This inbound service enables external systems and other consumers to read billing document data and cancel billing
* documents through API calls. You can use it to let external systems retrieve billing document data from your system,
* to cancel billing documents in the system, and to request entire billing documents in PDF format.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_BILLING_DOCUMENT_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Billing Integration (SAP_COM_0120)
*
*
* Scope Items:
* External Billing (1Z6)
*
*
* Authentication Methods:
* Basic, x509
*
*
* Business Object:
* BillingDocument
*
*
*
*/
public interface BillingDocumentService
{
/**
* 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_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
BillingDocumentService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocument
* BillingDocument} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocument
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentFluentHelper getAllBillingDocument();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocument
* BillingDocument} entity using key fields.
*
* @param billingDocument
* The number that uniquely identifies the billing document (the invoice, for example).
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocument
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentByKeyFluentHelper getBillingDocumentByKey( final String billingDocument );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItem
* BillingDocumentItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItem
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentItemFluentHelper getAllBillingDocumentItem();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItem
* BillingDocumentItem} entity using key fields.
*
* @param billingDocumentItem
* The number that uniquely identifies the item in the billing document.
*
* Constraints: Not nullable, Maximum length: 6
*
* @param billingDocument
* The number that uniquely identifies the billing document (the invoice, for example).
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItem
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentItemByKeyFluentHelper
getBillingDocumentItemByKey( final String billingDocument, final String billingDocumentItem );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPartner
* BillingDocumentItemPartner} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPartner
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPartnerFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentItemPartnerFluentHelper getAllBillingDocumentItemPartner();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPartner
* BillingDocumentItemPartner} entity using key fields.
*
* @param partnerFunction
* The abbreviated form of the name that identifies the partner function.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param billingDocumentItem
* The number that uniquely identifies the item in the billing document.
*
* Constraints: Not nullable, Maximum length: 6
*
* @param billingDocument
* The number that uniquely identifies the billing document (the invoice, for example).
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPartner
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPartnerByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentItemPartnerByKeyFluentHelper getBillingDocumentItemPartnerByKey(
final String billingDocument,
final String billingDocumentItem,
final String partnerFunction );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPrcgElmnt
* BillingDocumentItemPrcgElmnt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPrcgElmnt
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPrcgElmntFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentItemPrcgElmntFluentHelper getAllBillingDocumentItemPrcgElmnt();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPrcgElmnt
* BillingDocumentItemPrcgElmnt} entity using key fields.
*
* @param billingDocumentItem
* 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 billingDocument
* The number that uniquely identifies the billing document (the invoice, for example).
*
* Constraints: Not nullable, Maximum length: 10
*
* @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.billingdocument.BillingDocumentItemPrcgElmnt
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentItemPrcgElmntByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentItemPrcgElmntByKeyFluentHelper getBillingDocumentItemPrcgElmntByKey(
final String billingDocument,
final String billingDocumentItem,
final String pricingProcedureStep,
final String pricingProcedureCounter );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPartner
* BillingDocumentPartner} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPartner
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPartnerFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentPartnerFluentHelper getAllBillingDocumentPartner();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPartner
* BillingDocumentPartner} entity using key fields.
*
* @param partnerFunction
* The abbreviated form of the name that identifies the partner function.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param billingDocument
* The number that uniquely identifies the billing document (the invoice, for example).
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPartner
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPartnerByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentPartnerByKeyFluentHelper
getBillingDocumentPartnerByKey( final String billingDocument, final String partnerFunction );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPrcgElmnt
* BillingDocumentPrcgElmnt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPrcgElmnt
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPrcgElmntFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentPrcgElmntFluentHelper getAllBillingDocumentPrcgElmnt();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPrcgElmnt
* BillingDocumentPrcgElmnt} entity using key fields.
*
* @param pricingProcedureCounter
* Access number of the conditions within a step in the pricing procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param billingDocument
* The number that uniquely identifies the billing document (the invoice, for example).
*
* Constraints: Not nullable, Maximum length: 10
*
* @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.billingdocument.BillingDocumentPrcgElmnt
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentPrcgElmntByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BillingDocumentPrcgElmntByKeyFluentHelper getBillingDocumentPrcgElmntByKey(
final String billingDocument,
final String pricingProcedureStep,
final String pricingProcedureCounter );
/**
*
* Creates a fluent helper for the Cancel OData function import.
*
*
* @param billingDocument
* Constraints: Not nullable, Maximum length: 11000
*
* Original parameter name from the Odata EDM: BillingDocument
*
* @return A fluent helper object that will execute the Cancel OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.CancelFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
CancelFluentHelper cancel( final String billingDocument );
/**
*
* Creates a fluent helper for the GetPDF OData function import.
*
*
* @param billingDocument
* Constraints: Not nullable, Maximum length: 11000
*
* Original parameter name from the Odata EDM: BillingDocument
*
* @return A fluent helper object that will execute the GetPDF OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.GetPDFFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
GetPDFFluentHelper getPDF( final String billingDocument );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy