• Home
• com.sap.cloud.s4hana.datamodel
• odata-api
• 2.12.0
• source code
• TrialBalanceService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.sap.cloud.sdk.s4hana.datamodel.odata.services.TrialBalanceService 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.namespaces.trialbalance.CompanyCodeByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.CompanyCodeFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.GLAccountByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.GLAccountFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.LedgerByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.LedgerFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.ODataQueryAdditionalMetadataByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.ODataQueryAdditionalMetadataFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.ProjectByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.ProjectFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.TRIALBALANCEParametersByKeyFluentHelper;

/**
 * 

 * This service enables you to read trial balance data in an API call. 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:
C_TRIALBALANCE_CDS
API Version:
1
Communication Scenario:
Finance - Accounting Analytics Integration (SAP_COM_0303)
Scope Items:
Accounting and Financial Close (J58)
 * 
 */
public interface TrialBalanceService
{

    /**
     * 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/C_TRIALBALANCE_CDS";

    /**
     * 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
    TrialBalanceService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.Ledger Ledger} entity
     * using key fields.
     * 
     * @param ledger
     *            Ledger
     *            

     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.Ledger Ledger} 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.trialbalance.LedgerByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    LedgerByKeyFluentHelper getLedgerByKey( final String ledger );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.CompanyCode CompanyCode}
     * entity using key fields.
     * 
     * @param companyCode
     *            Company Code
     *            

     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.CompanyCode CompanyCode} 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.trialbalance.CompanyCodeByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CompanyCodeByKeyFluentHelper getCompanyCodeByKey( final String companyCode );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.GLAccount GLAccount}
     * entity using key fields.
     * 
     * @param gLAccount
     *            G/L Account
     *            

     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.GLAccount GLAccount} 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.trialbalance.GLAccountByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    GLAccountByKeyFluentHelper getGLAccountByKey( final String gLAccount );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.Project Project} entity
     * using key fields.
     * 
     * @param project
     *            Project Definition
     *            

     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.Project Project} 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.trialbalance.ProjectByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProjectByKeyFluentHelper getProjectByKey( final String project );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.ODataQueryAdditionalMetadata
     * ODataQueryAdditionalMetadata} entity using key fields.
     * 
     * @param oDataQueryMetadata
     * 
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.ODataQueryAdditionalMetadata
     *         ODataQueryAdditionalMetadata} 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.trialbalance.ODataQueryAdditionalMetadataByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ODataQueryAdditionalMetadataByKeyFluentHelper
        getODataQueryAdditionalMetadataByKey( final String oDataQueryMetadata );

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.TRIALBALANCEParameters
     * TRIALBALANCEParameters} entity using key fields.
     * 
     * @param p_ToPostingDate
     *            Posting Date To
     *            

     *            Constraints: Not nullable, Precision: 0
     *            
     * @param p_FromPostingDate
     *            Posting Date From
     *            

     *            Constraints: Not nullable, Precision: 0
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.TRIALBALANCEParameters
     *         TRIALBALANCEParameters} 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.trialbalance.TRIALBALANCEParametersByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    TRIALBALANCEParametersByKeyFluentHelper
        getTRIALBALANCEParametersByKey( final LocalDateTime p_FromPostingDate, final LocalDateTime p_ToPostingDate );

}