com.sap.cloud.sdk.s4hana.datamodel.odata.services.MaterialPriceService 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 java.math.BigDecimal;
import java.time.LocalDateTime;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialprice.InventoryPriceChangeFluentHelper;

/**
 * 
 * This service enables you to change the prices of your materials. If stock exists for the material, a revaluation
 * posting is generated.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_MATERIAL_VALUATION_SRV
API Version: 1
Communication Scenario: Material Price Changes and Inventory Values Integration (SAP_COM_0147)
Scope Items: Managing Material Price Changes and Inventory Values
 * (1ZT)
 * 
 */
public interface MaterialPriceService
{

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

    /**
     * 
     * Creates a fluent helper for the InventoryPriceChange OData function import.
     * 
     * 
     * @param valuationArea
     *            Constraints: Not nullable, Maximum length: 4
     *            
     *            Original parameter name from the Odata EDM: ValuationArea
     *            
     * @param material
     *            Constraints: Not nullable, Maximum length: 40
     *            
     *            Original parameter name from the Odata EDM: Material
     *            
     * @param inventoryValuationType
     *            Constraints: Not nullable, Maximum length: 10
     *            
     *            Original parameter name from the Odata EDM: InventoryValuationType
     *            
     * @param materialPriceUnitQty
     *            Constraints: Not nullable, Precision: 5, Scale: 0
     *            
     *            Original parameter name from the Odata EDM: MaterialPriceUnitQty
     *            
     * @param currency
     *            Constraints: Not nullable, Maximum length: 5
     *            
     *            Original parameter name from the Odata EDM: Currency
     *            
     * @param postingDate
     *            Constraints: Not nullable, Precision: 0
     *            
     *            Original parameter name from the Odata EDM: PostingDate
     *            
     * @param currencyRole
     *            Constraints: Not nullable, Maximum length: 2
     *            
     *            Original parameter name from the Odata EDM: CurrencyRole
     *            
     * @param inventoryPrice
     *            Constraints: Not nullable, Precision: 4, Scale: 4
     *            
     *            Original parameter name from the Odata EDM: InventoryPrice
     *            
     * @return A fluent helper object that will execute the InventoryPriceChange OData function import with the
     *         provided parameters. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialprice.InventoryPriceChangeFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    InventoryPriceChangeFluentHelper inventoryPriceChange(
        final String inventoryValuationType,
        final String valuationArea,
        final BigDecimal materialPriceUnitQty,
        final LocalDateTime postingDate,
        final BigDecimal inventoryPrice,
        final String material,
        final String currencyRole,
        final String currency );

}
OData Service:	API_MATERIAL_VALUATION_SRV
API Version:	1
Communication Scenario:	Material Price Changes and Inventory Values Integration (SAP_COM_0147)
Scope Items:	Managing Material Price Changes and Inventory Values * (1ZT)