com.sap.cloud.sdk.s4hana.datamodel.odata.services.AccountingDocumentService Maven / Gradle / Ivy

Go to download
/*
 * 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.accountingdocument.OperationalAcctgDocItemCubeByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.accountingdocument.OperationalAcctgDocItemCubeFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.accountingdocument.batch.AccountingDocumentServiceBatch;

/**
 * 
 * This service enables you to display accounting document master data to be consumed in SAP Fiori apps and on other
 * user interfaces.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_OPLACCTGDOCITEMCUBE_SRV
API Version: 1
Communication Scenario: Finance - Accounting Analytics Integration (SAP_COM_0303)
Scope Items: Accounting and Financial Close (J58)
Authentication Methods: Basic, x509
 * 
 */
public interface AccountingDocumentService 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_OPLACCTGDOCITEMCUBE_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
    AccountingDocumentService withServicePath( @Nonnull final String servicePath );

    /**
     * Fetch multiple
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.accountingdocument.OperationalAcctgDocItemCube
     * OperationalAcctgDocItemCube} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.accountingdocument.OperationalAcctgDocItemCube
     *         OperationalAcctgDocItemCube} 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.accountingdocument.OperationalAcctgDocItemCubeFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    OperationalAcctgDocItemCubeFluentHelper getAllOperationalAcctgDocItemCube();

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.accountingdocument.OperationalAcctgDocItemCube
     * OperationalAcctgDocItemCube} entity using key fields.
     * 
     * @param companyCode
     *            Company Code
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param accountingDocumentItem
     *            Journal Entry Posting View Item
     *            
     *            Constraints: Not nullable, Maximum length: 3
     *            
     * @param accountingDocument
     *            The document number is the key the system uses to access the accounting document.
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param fiscalYear
     *            Fiscal Year
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.accountingdocument.OperationalAcctgDocItemCube
     *         OperationalAcctgDocItemCube} 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.accountingdocument.OperationalAcctgDocItemCubeByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    OperationalAcctgDocItemCubeByKeyFluentHelper getOperationalAcctgDocItemCubeByKey(
        final String companyCode,
        final String fiscalYear,
        final String accountingDocument,
        final String accountingDocumentItem );

}
OData Service:	API_OPLACCTGDOCITEMCUBE_SRV
API Version:	1
Communication Scenario:	Finance - Accounting Analytics Integration (SAP_COM_0303)
Scope Items:	Accounting and Financial Close (J58)
Authentication Methods:	Basic, x509