com.sap.cloud.sdk.s4hana.datamodel.odata.services.PersonnelSettlementDocumentService 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.personnelsettlementdocument.PersCompnElmntCostAssgmtByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.personnelsettlementdocument.PersCompnElmntCostAssgmtFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.personnelsettlementdocument.PersonnelCompensationElementByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.personnelsettlementdocument.PersonnelCompensationElementFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.personnelsettlementdocument.batch.PersonnelSettlementDocumentServiceBatch;

/**
 * 
 * You can use this inbound service to integrate settlements of employee related payments such as bonuses, commissions
 * or deductions made in SAP S/4HANA Cloud with external applications. The service enables you to read the transactional
 * data of personnel settlement documents.
 * 
 * It is based on the OData protocol and it is intended for consumption in background by remote interfaces for
 * application integration scenarios.
 * 
 * In every API call, you can make use of the following operations: - You can retrieve an individual personnel
 * settlement document by document number - You can retrieve multiple documents by filtering on the available properties
 * - You can request additional information on the assignment of settled amounts to cost centers - You can retrieve
 * delta information by filtering on date and time to only get documents which have been created after that point in
 * time.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP API
 * Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_PERS_SETTLMT_DOC
API Version: 1
Communication Scenario: Logistics - Employee Central Personnel Settlement Document Integration (SAP_COM_0469)
Authentication Methods: Basic, x509
Business Object: PersonnelSettlementDocument
 * 
 */
public interface PersonnelSettlementDocumentService 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_PERS_SETTLMT_DOC";

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

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.personnelsettlementdocument.PersCompnElmntCostAssgmt
     * PersCompnElmntCostAssgmt} entity using key fields.
     * 
     * @param personnelSettlementDocument
     *            Personnel Settlement Document Number
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param costCenter
     *            Cost Center
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param controllingArea
     *            Controlling Area
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.personnelsettlementdocument.PersCompnElmntCostAssgmt
     *         PersCompnElmntCostAssgmt} 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.personnelsettlementdocument.PersCompnElmntCostAssgmtByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    PersCompnElmntCostAssgmtByKeyFluentHelper getPersCompnElmntCostAssgmtByKey(
        final String personnelSettlementDocument,
        final String controllingArea,
        final String costCenter );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.personnelsettlementdocument.PersonnelCompensationElement
     * PersonnelCompensationElement} entity using key fields.
     * 
     * @param personnelSettlementDocument
     *            Personnel Settlement Document Number
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.personnelsettlementdocument.PersonnelCompensationElement
     *         PersonnelCompensationElement} 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.personnelsettlementdocument.PersonnelCompensationElementByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    PersonnelCompensationElementByKeyFluentHelper
        getPersonnelCompensationElementByKey( final String personnelSettlementDocument );

}
OData Service:	API_PERS_SETTLMT_DOC
API Version:	1
Communication Scenario:	Logistics - Employee Central Personnel Settlement Document Integration (SAP_COM_0469)
Authentication Methods:	Basic, x509
Business Object:	PersonnelSettlementDocument