
com.sap.cloud.sdk.s4hana.datamodel.odata.services.ContractAccountingSEPAMandateService 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 java.time.LocalDateTime;
import javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsage;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsageByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsageCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsageFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.batch.ContractAccountingSEPAMandateServiceBatch;
/**
*
* This service enables you to create, read and update SEPA Mandates for application Contract Accounts Receivable and
* Payable. The Usage of SEPA Mandates may be read or created as well.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_O2C_FICA_SEPA_MANDATE_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Finance - Contract Accounting SEPA Mandate Integration (SAP_COM_0458)
*
*
* Scope Items:
* Contract Accounting - Master Data and Basic Functions
* (2AR)
*
*
* Authentication Methods:
* Basic, x509
*
*
*
*/
public interface ContractAccountingSEPAMandateService 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_O2C_FICA_SEPA_MANDATE_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
ContractAccountingSEPAMandateService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate SEPAMandate}
* entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate
* SEPAMandate} 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.contractaccountingsepamandate.SEPAMandateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SEPAMandateFluentHelper getAllSEPAMandate();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate SEPAMandate}
* entity using key fields.
*
* @param creditor
* Specifies a cross-country unique identification of the creditor of a SEPA direct debit.
*
* Constraints: Not nullable, Maximum length: 35
*
* @param sEPAMandate
* Identifies, together with the Creditor Identifier, the mandate uniquely.
*
* Constraints: Not nullable, Maximum length: 35
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate
* SEPAMandate} 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.contractaccountingsepamandate.SEPAMandateByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SEPAMandateByKeyFluentHelper getSEPAMandateByKey( final String creditor, final String sEPAMandate );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate
* SEPAMandate} entity and save it to the S/4HANA system.
*
* @param sEPAMandate
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate
* SEPAMandate} entity object that will be created in the S/4HANA system.
* @return A fluent helper to create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate
* SEPAMandate} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SEPAMandateCreateFluentHelper createSEPAMandate( @Nonnull final SEPAMandate sEPAMandate );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate SEPAMandate}
* entity and save it to the S/4HANA system.
*
* @param sEPAMandate
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate
* SEPAMandate} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandate
* SEPAMandate} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SEPAMandateUpdateFluentHelper updateSEPAMandate( @Nonnull final SEPAMandate sEPAMandate );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsage
* SEPAMandateUsage} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsage
* SEPAMandateUsage} 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.contractaccountingsepamandate.SEPAMandateUsageFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SEPAMandateUsageFluentHelper getAllSEPAMandateUsage();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsage
* SEPAMandateUsage} entity using key fields.
*
* @param sEPAMandateUsePaymentDoc
* Linked key for an object.
*
* Constraints: Not nullable, Maximum length: 70
*
* @param sEPAMandateUseObjectType
* Internal technical key of a business object in the Business Object Repository (BOR).
*
* Constraints: Not nullable, Maximum length: 10
*
* @param creditor
* Specifies a cross-country unique identification of the creditor of a SEPA direct debit.
*
* Constraints: Not nullable, Maximum length: 35
*
* @param sEPAMandate
* Identifies, together with the Creditor Identifier, the mandate uniquely.
*
* Constraints: Not nullable, Maximum length: 35
*
* @param sEPAMandateUseDate
* Date (YYYYMMDD)
*
* Constraints: Not nullable, Precision: 7
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsage
* SEPAMandateUsage} 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.contractaccountingsepamandate.SEPAMandateUsageByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SEPAMandateUsageByKeyFluentHelper getSEPAMandateUsageByKey(
final String creditor,
final String sEPAMandate,
final LocalDateTime sEPAMandateUseDate,
final String sEPAMandateUseObjectType,
final String sEPAMandateUsePaymentDoc );
/**
* Create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsage
* SEPAMandateUsage} entity and save it to the S/4HANA system.
*
* @param sEPAMandateUsage
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsage
* SEPAMandateUsage} entity object that will be created in the S/4HANA system.
* @return A fluent helper to create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsage
* SEPAMandateUsage} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.contractaccountingsepamandate.SEPAMandateUsageCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SEPAMandateUsageCreateFluentHelper createSEPAMandateUsage( @Nonnull final SEPAMandateUsage sEPAMandateUsage );
}