All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sap.cloud.sdk.s4hana.datamodel.odata.services.SalesDocumentWithCreditBlocksService 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.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.CheckCreditBlockFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.CreditBlockedSalesDocumentByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.CreditBlockedSalesDocumentFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.RejectCreditBlockFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.ReleaseCreditBlockFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.SalesDocumentRjcnReasonByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.SalesDocumentRjcnReasonFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.batch.SalesDocumentWithCreditBlocksServiceBatch;

/**
 * 

* This synchronous inbound service enables you to retrieve sales documents that contain credit blocks, check, release * and reject the blocked sales documents with data provided in a sales document. It is based on the OData protocol and * can be consumed in Fiori apps and on other user interfaces. *

*

* Business * Documentation *

*

* Reference: SAP * API Business Hub *

*

Details:

* * * * * * * * * * * * * * * * * * * * * *
OData Service:API_SLS_DOC_WITH_CREDIT_BLOCK
API Version:1
Communication Scenario:Sales Credit Management Integration (SAP_COM_0325)
Scope Items:Basic Credit Management (BD6)
Authentication Methods:Basic, x509, OAuth2
* */ public interface SalesDocumentWithCreditBlocksService extends BatchService { /** * 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_SLS_DOC_WITH_CREDIT_BLOCK"; /** * 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 SalesDocumentWithCreditBlocksService withServicePath( @Nonnull final String servicePath ); /** * Fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.CreditBlockedSalesDocument * CreditBlockedSalesDocument} entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.CreditBlockedSalesDocument * CreditBlockedSalesDocument} 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.salesdocumentwithcreditblocks.CreditBlockedSalesDocumentFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull CreditBlockedSalesDocumentFluentHelper getAllCreditBlockedSalesDocument(); /** * Fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.CreditBlockedSalesDocument * CreditBlockedSalesDocument} entity using key fields. * * @param salesDocument * The number that uniquely identifies the sales document. *

* Constraints: Not nullable, Maximum length: 10 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.CreditBlockedSalesDocument * CreditBlockedSalesDocument} 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.salesdocumentwithcreditblocks.CreditBlockedSalesDocumentByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull CreditBlockedSalesDocumentByKeyFluentHelper getCreditBlockedSalesDocumentByKey( final String salesDocument ); /** * Fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.SalesDocumentRjcnReason * SalesDocumentRjcnReason} entities. * * @return A fluent helper to fetch multiple * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.SalesDocumentRjcnReason * SalesDocumentRjcnReason} 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.salesdocumentwithcreditblocks.SalesDocumentRjcnReasonFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull SalesDocumentRjcnReasonFluentHelper getAllSalesDocumentRjcnReason(); /** * Fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.SalesDocumentRjcnReason * SalesDocumentRjcnReason} entity using key fields. * * @param salesDocumentRjcnReason * The reason for rejecting a sales document (for example, a sales quotation or a sales order). *

* Constraints: Not nullable, Maximum length: 2 *

* @return A fluent helper to fetch a single * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.SalesDocumentRjcnReason * SalesDocumentRjcnReason} 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.salesdocumentwithcreditblocks.SalesDocumentRjcnReasonByKeyFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull SalesDocumentRjcnReasonByKeyFluentHelper getSalesDocumentRjcnReasonByKey( final String salesDocumentRjcnReason ); /** * Check *

*

*

* Creates a fluent helper for the CheckCreditBlock OData function import. *

* * @param salesDocument * Constraints: none *

* Original parameter name from the Odata EDM: SalesDocument *

* @param sDDocumentCategory * Constraints: none *

* Original parameter name from the Odata EDM: SDDocumentCategory *

* @return A fluent helper object that will execute the CheckCreditBlock OData function import with the * provided parameters. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.CheckCreditBlockFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull CheckCreditBlockFluentHelper checkCreditBlock( final String salesDocument, final String sDDocumentCategory ); /** * Reject *

*

*

* Creates a fluent helper for the RejectCreditBlock OData function import. *

* * @param salesDocument * Constraints: none *

* Original parameter name from the Odata EDM: SalesDocument *

* @param rejectionCode * Constraints: none *

* Original parameter name from the Odata EDM: RejectionCode *

* @param sDDocumentCategory * Constraints: none *

* Original parameter name from the Odata EDM: SDDocumentCategory *

* @return A fluent helper object that will execute the RejectCreditBlock OData function import with the * provided parameters. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.RejectCreditBlockFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull RejectCreditBlockFluentHelper rejectCreditBlock( final String salesDocument, final String rejectionCode, final String sDDocumentCategory ); /** * Release *

*

*

* Creates a fluent helper for the ReleaseCreditBlock OData function import. *

* * @param salesDocument * Constraints: none *

* Original parameter name from the Odata EDM: SalesDocument *

* @param sDDocumentCategory * Constraints: none *

* Original parameter name from the Odata EDM: SDDocumentCategory *

* @return A fluent helper object that will execute the ReleaseCreditBlock OData function import with the * provided parameters. To perform execution, call the * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.ReleaseCreditBlockFluentHelper#execute * execute} method on the fluent helper object. */ @Nonnull ReleaseCreditBlockFluentHelper releaseCreditBlock( final String sDDocumentCategory, final String salesDocument ); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy