com.sap.cloud.sdk.s4hana.datamodel.odata.services.PaymentAdviceService 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.paymentadvice.PaymentAdvice;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItemCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItemDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItemUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceUpdateFluentHelper;
/**
*
* This service enables you to create, read, update, and delete payment advices of any supported type, both for
* customers and suppliers.
*
* You can use this inbound synchronous service to create, read, update, and delete payment advices related to a
* customer or a supplier. It is based on the OData protocol and can be consumed in SAP Fiori apps and other user
* interfaces. The service can be used with payment advices of any supported type..
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_PAYMENT_ADVICE_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Finance - Payment Advice Integration (SAP_COM_0331)
*
*
* Scope Items:
* Accounts Receivable (J59)
*
*
* Authentication Methods:
* Basic, x509, OAuth2
*
*
* Business Object:
* PaymentAdvice
*
*
*
*/
public interface PaymentAdviceService
{
/**
* 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_PAYMENT_ADVICE_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
PaymentAdviceService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice
* PaymentAdvice} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice PaymentAdvice}
* 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.paymentadvice.PaymentAdviceFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceFluentHelper getAllPaymentAdvice();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice
* PaymentAdvice} entity using key fields.
*
* @param companyCode
* The company code is an organizational unit within financial accounting.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param paymentAdviceAccountType
* The account type identifies a payment advice together with the company code, the account number, and
* the payment advice number.
*
* Constraints: Not nullable, Maximum length: 1
*
* @param paymentAdvice
* Payment Advice Number
*
* Constraints: Not nullable, Maximum length: 16
*
* @param paymentAdviceAccount
* The account number identifies a payment advice together with the company code, the account type and
* the payment advice number.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice PaymentAdvice}
* 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.paymentadvice.PaymentAdviceByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceByKeyFluentHelper getPaymentAdviceByKey(
final String companyCode,
final String paymentAdviceAccountType,
final String paymentAdviceAccount,
final String paymentAdvice );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice
* PaymentAdvice} entity and save it to the S/4HANA system.
*
* @param paymentAdvice
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice PaymentAdvice}
* 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.paymentadvice.PaymentAdvice PaymentAdvice}
* entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceCreateFluentHelper createPaymentAdvice( @Nonnull final PaymentAdvice paymentAdvice );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice
* PaymentAdvice} entity and save it to the S/4HANA system.
*
* @param paymentAdvice
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice PaymentAdvice}
* 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.paymentadvice.PaymentAdvice PaymentAdvice}
* entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceUpdateFluentHelper updatePaymentAdvice( @Nonnull final PaymentAdvice paymentAdvice );
/**
* Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice
* PaymentAdvice} entity in the S/4HANA system.
*
* @param paymentAdvice
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdvice PaymentAdvice}
* 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.paymentadvice.PaymentAdvice PaymentAdvice}
* entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceDeleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceDeleteFluentHelper deletePaymentAdvice( @Nonnull final PaymentAdvice paymentAdvice );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} 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.paymentadvice.PaymentAdviceItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceItemFluentHelper getAllPaymentAdviceItem();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} entity using key fields.
*
* @param companyCode
* The company code is an organizational unit within financial accounting.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param paymentAdviceAccountType
* The account type identifies a payment advice together with the company code, the account number, and
* the payment advice number.
*
* Constraints: Not nullable, Maximum length: 1
*
* @param paymentAdvice
* Payment Advice Number
*
* Constraints: Not nullable, Maximum length: 16
*
* @param paymentAdviceAccount
* The account number identifies a payment advice together with the company code, the account type and
* the payment advice number.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param paymentAdviceItem
* All items within a payment advice contain a number via which they can be identified. The numbers are
* assigned consecutively by the system when entering a payment advice.
*
* Constraints: Not nullable, Maximum length: 5
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} 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.paymentadvice.PaymentAdviceItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceItemByKeyFluentHelper getPaymentAdviceItemByKey(
final String companyCode,
final String paymentAdviceAccountType,
final String paymentAdviceAccount,
final String paymentAdvice,
final String paymentAdviceItem );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} entity and save it to the S/4HANA system.
*
* @param paymentAdviceItem
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} 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.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItemCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceItemCreateFluentHelper createPaymentAdviceItem( @Nonnull final PaymentAdviceItem paymentAdviceItem );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} entity and save it to the S/4HANA system.
*
* @param paymentAdviceItem
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} 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.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItemUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceItemUpdateFluentHelper updatePaymentAdviceItem( @Nonnull final PaymentAdviceItem paymentAdviceItem );
/**
* Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} entity in the S/4HANA system.
*
* @param paymentAdviceItem
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} 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.paymentadvice.PaymentAdviceItem
* PaymentAdviceItem} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.paymentadvice.PaymentAdviceItemDeleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PaymentAdviceItemDeleteFluentHelper deletePaymentAdviceItem( @Nonnull final PaymentAdviceItem paymentAdviceItem );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy