Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductPlant" of service "API_PRODUCT_SRV". This service is part of the following communication scenarios: Product Integration (SAP_COM_0009), Distributed Manufacturing Integration (SAP_COM_0077), SAP Analytics Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_PRODUCT_SRV for more information.

Hierarchy

  • Entity
    • ProductPlant

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns ProductPlant

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional abcIndicator

abcIndicator: undefined | string

ABC Indicator. Indicator that classifies a material as an A, B, or C part according to its consumption value. This classification process is known as the ABC analysis. The three indicators have the following meanings:A - important part, high consumption valueB - less important part, medium consumption valueC - relatively unimportant part, low consumption value. Maximum length: 1.

nullable

Optional availabilityCheckType

availabilityCheckType: undefined | string

Checking Group for Availability Check. This field has two uses: Specifies whether and how the system checks availability and generates requirements for materials planning.In Flexible Planning, defines - together with the checking rule - the different MRP elements that make up this key figure. The sum of these elements gives the key figure.Use 1: Availability Checking and Materials PlanningThe value you enter for use 1 (see above) is a default value which defines:Which MRP elements (for example, purchase orders, reservations) the system includes in the availability checkWhether the system checks availability only until the end of the replenishment lead time or whether it checks availability over the entire period for which MRP elements existWhether the system generates individual requirements or summarized requirements if you enter sales orders or deliveries for the materialUse 2: Flexible PlanningIf you use this field to define the MRP elements of a key figure for Flexible Planning, you must also select Document KF in the Customizing parameters of the information structure. Maximum length: 2.

nullable

Optional commodity

commodity: undefined | string

Commodity Code. Official code number based on the Harmonized Commodity Description and Coding System (HS). The Harmonized System contains code numbers for all goods that an be transported across national or regional boundaries. Goods are coded according to this nomenclature when declaring the import or export of goods to the proper authorities. The specification of standard commodity codes in declarations enables the authority to tally the quantities of imported or exported goods of specific goods categories for statistical purposes (INTRASTAT). Maximum length: 17.

nullable

Optional consumptionTaxCtrlCode

consumptionTaxCtrlCode: undefined | string

Control code for consumption taxes in foreign trade. Maximum length: 16.

nullable

Optional countryOfOrigin

countryOfOrigin: undefined | string

Country of Origin of Material (Non-Preferential Origin). Key of the country in which the material has been produced. You are legally required to specify the country of origin both for export and import.ExportYou prove the origin of a material by presenting the certificate of origin. This is issued and controlled by the relevant authority of the issuing country.This authority confirms the origin of a material and the required information with the certificate of origin.ImportThe relevant authority of the importing country - usually the Ministry of Economic Affairs - stipulates which regulations regarding customs and foreign trade law have to be observed for the certificates of origin accompanying goods.This information is used for foreign trade processing in different areas, such as:Foreign trade lawCustoms lawExample for Europe:Article 9 of the EU origin regulation is the legal regulation for the certificate of origin.The responsible authorities in Germany include:Chamber of Commerce (Industrie- und Handelskammer)Chamber of Handicrafts (Handwerkskammer)Customs office. Maximum length: 3.

nullable

Optional fiscalMonthCurrentPeriod

fiscalMonthCurrentPeriod: undefined | string

Fiscal Month Current Period. Maximum length: 2.

nullable

Optional fiscalYearCurrentPeriod

fiscalYearCurrentPeriod: undefined | string

Fiscal Year Current Period. Maximum length: 4.

nullable

Optional fiscalYearVariant

fiscalYearVariant: undefined | string

Fiscal Year Variant. The fiscal year variant is used to define the fiscal year. You can define the following using a fiscal year variant:How many posting periods are in a fiscal yearHow many special periods you requireHow the system determines the posting periods when postingIn the definition, you allocate your posting periods to the calendar year.Allocation control requires the same number of posting periods in the company code and in the assigned controlling area.This means that the number of posting periods in the fiscal year variants must be the same in the company code and in the controlling area. The period limits for the two fiscal year variants must also coincide.You must define which fiscal year variant is to be used for each company code. To do this, you must define the appropriate fiscal year variant. It must contain no more than 16 periods.Note:The company codes delivered with the standard system are allocated to the fiscal year variant that corresponds to the calendar year and which also uses four special periods.You define fiscal year variants as well as the allocation of fiscal year variant to the company code in Financial Accounting customizing. Maximum length: 2.

nullable

Optional fixedLotSizeQuantity

fixedLotSizeQuantity: BigNumber

Fixed lot size. Quantity that will be ordered or produced in the event of a shortage. If the amount of the shortage is less than the fixed lot size, it is the fixed lot size that is ordered or produced (and not the lesser quantity that is actually required).If the amount of the shortage is greater than the fixed lot size, a multiple of the fixed lot size is procured. The system creates several purchase order proposals for this purpose.

nullable

Optional goodsReceiptBlockedStockQty

goodsReceiptBlockedStockQty: BigNumber

Goods Receipt Blocked Stock Qty.

nullable

Optional goodsReceiptDuration

goodsReceiptDuration: BigNumber

Goods Receipt Processing Time in Days. Number of workdays required after receiving the material for inspection and placement into storage.

nullable

Optional hasConsignmentCtrl

hasConsignmentCtrl: undefined | string

Consignment Control. Controls whether a material is preferably procured for own stock or consignment stock at a plant. You can set the values for consignment control that you defined in Customizing for consignment control.When you set consignment control, please note the following:The system only evaluates the setting if you have activated Retail consignment processingNote that the settings for the Consignment Control and Source of Supply fields have to be coordinated:If you set procurement for own stock in consignment control, the search sequence for the supply source has to begin with "Normal".If you set procurement for consignment stock in consignment control, the search sequence for the supply source has to begin with "Consignment". Maximum length: 1.

nullable

Optional hasPostToInspectionStock

hasPostToInspectionStock: undefined | false | true

Has Post to Inspection Stock. Specifies whether the product is subject to quality inspection (without inspection lot processing) and whether a goods receipt is posted to inspection stock. The indicator is copied to purchase order items and goods receipt items as a default value. You can select this indicator, if no stock-relevant inspection type has been selected in the inspection setup, and therefore no stock-relevant inspection lots can be created.If you activate a stock-relevant inspection type, the entry in this field is deselected and can no longer be maintained. In this case, a corresponding indicator in the inspection type controls whether goods are posted to inspection stock.

nullable

Optional isBatchManagementRequired

isBatchManagementRequired: undefined | false | true

Batch Management Requirement Indicator for Plant. Specifies whether the material is managed in batches. This indicator can be set in the material master record manually or, if batches are valuated individually, it is set automatically for the plants concerned, in which case it cannot be changed.The indicator cannot be changed if stocks exist in either the current period or in the previous period. The reason for checking the previous period is because stocks can be posted to this period when goods movements are entered.

nullable

Optional isCoProduct

isCoProduct: undefined | false | true

Indicator: Material can be co-product. Indicator you can use to specify that the material can also be used as a co-product.

nullable

Optional isInternalBatchManaged

isInternalBatchManaged: undefined | false | true

Batch management indicator (internal). Indicator that specifies that the material is managed in batches.

nullable

Optional isMarkedForDeletion

isMarkedForDeletion: undefined | false | true

Flag Material for Deletion at Plant Level. If this indicator is set, the archive and delete program checks whether the material may be deleted at plant level, and deletes the data at this level and at all lower levels accordingly.

nullable

Optional isNegativeStockAllowed

isNegativeStockAllowed: undefined | false | true

Negative stocks allowed in plant. Indicates that negative stocks of the material are allowed at the plant. Negative stock balances can only result if they are allowed at the following levels:Valuation area levelStorage location levelMaterial level (plant data in the material master record)Negative stock levels are already allowed for special stocks if negative stocks have been activated in the valuation area and for the special stock in question in the plant. You do not have to activate them in each material master record.You can have negative balances in stocks of the types "unrestricted-use" and "blocked".Negative balances are possible in the following special stocks:Vendor consignment (K)Stock of material provided to vendor (O)Consignment stock at customer (W)Sales order stock (E)Project stock (Q)Returnable packaging stock at customer (V)Returnable transport packaging (M).

nullable

Optional maintenanceStatusName

maintenanceStatusName: undefined | string

Maintenance status. The maintenance status records: Which user departments may maintain a material master record of a particular material typeWhich user departments have already maintained the material master record at a particular hierarchy levelThe overall maintenance status is made up of the individual maintenance statuses. The individual maintenance statuses have the following meaning:User department Maintenance statusWork scheduling AAccounting BClassification CMRP DPurchasing EProduction resources/tools FCosting GBasic data KStorage LForecasting PQuality management QWarehouse management SSales VPlant stocks XStorage location stocks Z. Maximum length: 15.

nullable

Optional maximumLotSizeQuantity

maximumLotSizeQuantity: BigNumber

Maximum Lot Size. Quantity that is not allowed to be exceeded during procurement. The system takes this value into account during the automatic lot size calculation for planned orders and production orders. The lot size of the individual orders cannot exceed this value.

nullable

Optional minimumLotSizeQuantity

minimumLotSizeQuantity: BigNumber

Minimum Lot Size. Minimum procurement quantity.

nullable

Optional mrpResponsible

mrpResponsible: undefined | string

MRP Controller. Specifies the number of the MRP controller or group of MRP controllers responsible for material planning for the material. Maximum length: 3.

nullable

Optional mrpType

mrpType: undefined | string

MRP Type. Key that determines whether and how the material is planned. You have the following options: Manual reorder point planningAutomatic reorder point planningForecast-based planningMaterial requirements planning with forecasts for unplanned consumptionMaster production scheduling (MPS)Demand-driven replenishment. Maximum length: 2.

nullable

Optional periodType

periodType: undefined | string

Period Indicator. Indicator specifying the periods in which the material's consumption values and forecast values are managed. Maximum length: 1.

nullable

plant

plant: string

Plant. Key uniquely identifying a plant. Maximum length: 4.

Optional procurementType

procurementType: undefined | string

Procurement Type. Indicator that defines how the material is procured. The following procurements types are possible: The material is produced in-house.The material is procured externally.The material can be both produced in-house and procured externally. Maximum length: 1.

nullable

product

product: string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

Optional productCfopCategory

productCfopCategory: undefined | string

Material CFOP category. This is the CFOP category of a material. The CFOP category is used to determine the proper CFOP. Maximum length: 2.

nullable

Optional productIsConfigurable

productIsConfigurable: undefined | string

Configurable Product. Number uniquely identifying the configurable product. Maximum length: 40.

nullable

Optional productIsExciseTaxRelevant

productIsExciseTaxRelevant: undefined | false | true

Excise Tax Relevance Indicator. Indicates that the product is relevant for excise tax.

nullable

Optional productionInvtryManagedLoc

productionInvtryManagedLoc: undefined | string

Issue Storage Location. In the case of a material produced in-house, this is the key of the storage location that is copied to the planned order, production order, or run schedule quantity. If the material is a component, it is the issuing storage location to which a backflush is posted.If the material is produced, it is the receiving storage location to which the receipt of the material is posted. Maximum length: 4.

nullable

Optional profileCode

profileCode: undefined | string

Plant-Specific Material Status. Indicates whether, for a specific plant, the material may be used in the following areas: Materials management (for example, in purchasing and in inventory management)Production planning and controlPlant maintenanceWarehouse managementCosting with a quantity structureThe plant-specific material status restricts the usability of the material for the plant concerned, that is, it defines whether a warning or error message is displayed if you include the material in a particular function.The material may be a part under development or one to be discontinued. Maximum length: 2.

nullable

Optional profileValidityStartDate

profileValidityStartDate: Moment

Date from Which the Plant-Specific Material Status Is Valid. Materials planning The valid-from date of the material status is considered only if it precedes or is the same as the planning date; that is, if the valid-from date is later than the planning date, it is not considered, even if it is within the planning horizon.ExampleI<-------------Planning horizon------------->I-----I--------------------I-----------------------I-->Planning date Valid-from date TimeIn this case, the valid-from date is not considered in materials planning since it is later than the planning date.PurchasingThe valid-from date of the material status is checked against the current date.ExampleYou block the material for purchasing from May 1, xxxx. A purchase order is created for the material on April 28, xxxx with a delivery date of May 10, xxxx. In this case, the valid-from date May 1, xxxx is checked against the purchase order date April 28, xxxx and the purchase order is allowed. Had you created the purchase order on May 3, xxxx, an error message would have been issued.

nullable

Optional profitCenter

profitCenter: undefined | string

Profit Center. Key which together with the controlling area uniquely identifies a profit center. Maximum length: 10.

nullable

Optional purchasingGroup

purchasingGroup: undefined | string

Purchasing Group. Key for a buyer or a group of buyers, who is/are responsible for certain purchasing activities. Internally, the purchasing group is responsible for the procurement of a material or a class of materials.Externally, it is the medium through which contacts with the vendor are maintained. Maximum length: 3.

nullable

Optional regionOfOrigin

regionOfOrigin: undefined | string

Region of Origin of Material (Non-Preferential Origin). Describes more precisely the origin of goods. You can enter a region of the country from which the goods originate.This information is required for the declarations regarding goods dispatches/imports and goods receipts/exports which are made to the authorities. Declarations to the authorities for foreign trade are a legal requirement in many countries.INTRASTAT - Declaration in the European UnionEXTRASTAT - Declaration in the European UnionIn the materials management document, the 'region of destination' field indicates the region of the receiving plant. Maximum length: 3.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional serialNumberProfile

serialNumberProfile: undefined | string

Serial Number Profile. Freely definable four-digit key that provides unique identification for a serial number profile. Maximum length: 4.

nullable

Optional stockDeterminationGroup

stockDeterminationGroup: undefined | string

Stock determination group. Specifies the stock determination group. The stock determination group combined with the stock determination rule at plant level create a key for the stock determination strategy.You enter the stock determination group in the material master record at plant level and it controls a stock determination based on material. Maximum length: 4.

nullable

Optional stockInTransferQuantity

stockInTransferQuantity: BigNumber

Stock In Transfer Quantity.

nullable

Optional stockInTransitQuantity

stockInTransitQuantity: BigNumber

Stock In Transit Quantity.

nullable

toPlantMrpArea

toPlantMrpArea: ProductPlantMrpArea[]

One-to-many navigation property to the ProductPlantMrpArea entity.

toPlantQualityMgmt

toPlantQualityMgmt: ProductPlantQualityMgmt

One-to-one navigation property to the ProductPlantQualityMgmt entity.

toPlantSales

toPlantSales: ProductPlantSales

One-to-one navigation property to the ProductPlantSales entity.

toPlantStorage

toPlantStorage: ProductPlantStorage

One-to-one navigation property to the ProductPlantStorage entity.

toPlantText

toPlantText: ProductPlantText

One-to-one navigation property to the ProductPlantText entity.

toProdPlantInternationalTrade

toProdPlantInternationalTrade: ProductPlantIntlTrd

One-to-one navigation property to the ProductPlantIntlTrd entity.

toProductPlantCosting

toProductPlantCosting: ProductPlantCosting

One-to-one navigation property to the ProductPlantCosting entity.

toProductPlantForecast

toProductPlantForecast: ProductPlantForecasting

One-to-one navigation property to the ProductPlantForecasting entity.

toProductPlantProcurement

toProductPlantProcurement: ProductPlantProcurement

One-to-one navigation property to the ProductPlantProcurement entity.

toProductSupplyPlanning

toProductSupplyPlanning: ProductSupplyPlanning

One-to-one navigation property to the ProductSupplyPlanning entity.

toProductWorkScheduling

toProductWorkScheduling: ProductWorkScheduling

One-to-one navigation property to the ProductWorkScheduling entity.

toStorageLocation

toStorageLocation: ProductStorageLocation[]

One-to-many navigation property to the ProductStorageLocation entity.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Static ABC_INDICATOR

ABC_INDICATOR: StringField<ProductPlant> = new StringField('ABCIndicator', ProductPlant, 'Edm.String')

Static representation of the abcIndicator property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ALL_FIELDS

ALL_FIELDS: AllFields<ProductPlant> = new AllFields('*', ProductPlant)

All fields selector.

Static AVAILABILITY_CHECK_TYPE

AVAILABILITY_CHECK_TYPE: StringField<ProductPlant> = new StringField('AvailabilityCheckType', ProductPlant, 'Edm.String')

Static representation of the availabilityCheckType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static COMMODITY

COMMODITY: StringField<ProductPlant> = new StringField('Commodity', ProductPlant, 'Edm.String')

Static representation of the commodity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONSUMPTION_TAX_CTRL_CODE

CONSUMPTION_TAX_CTRL_CODE: StringField<ProductPlant> = new StringField('ConsumptionTaxCtrlCode', ProductPlant, 'Edm.String')

Static representation of the consumptionTaxCtrlCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static COUNTRY_OF_ORIGIN

COUNTRY_OF_ORIGIN: StringField<ProductPlant> = new StringField('CountryOfOrigin', ProductPlant, 'Edm.String')

Static representation of the countryOfOrigin property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static FISCAL_MONTH_CURRENT_PERIOD

FISCAL_MONTH_CURRENT_PERIOD: StringField<ProductPlant> = new StringField('FiscalMonthCurrentPeriod', ProductPlant, 'Edm.String')

Static representation of the fiscalMonthCurrentPeriod property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static FISCAL_YEAR_CURRENT_PERIOD

FISCAL_YEAR_CURRENT_PERIOD: StringField<ProductPlant> = new StringField('FiscalYearCurrentPeriod', ProductPlant, 'Edm.String')

Static representation of the fiscalYearCurrentPeriod property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static FISCAL_YEAR_VARIANT

FISCAL_YEAR_VARIANT: StringField<ProductPlant> = new StringField('FiscalYearVariant', ProductPlant, 'Edm.String')

Static representation of the fiscalYearVariant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static FIXED_LOT_SIZE_QUANTITY

FIXED_LOT_SIZE_QUANTITY: BigNumberField<ProductPlant> = new BigNumberField('FixedLotSizeQuantity', ProductPlant, 'Edm.Decimal')

Static representation of the fixedLotSizeQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static GOODS_RECEIPT_BLOCKED_STOCK_QTY

GOODS_RECEIPT_BLOCKED_STOCK_QTY: BigNumberField<ProductPlant> = new BigNumberField('GoodsReceiptBlockedStockQty', ProductPlant, 'Edm.Decimal')

Static representation of the goodsReceiptBlockedStockQty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static GOODS_RECEIPT_DURATION

GOODS_RECEIPT_DURATION: BigNumberField<ProductPlant> = new BigNumberField('GoodsReceiptDuration', ProductPlant, 'Edm.Decimal')

Static representation of the goodsReceiptDuration property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static HAS_CONSIGNMENT_CTRL

HAS_CONSIGNMENT_CTRL: StringField<ProductPlant> = new StringField('HasConsignmentCtrl', ProductPlant, 'Edm.String')

Static representation of the hasConsignmentCtrl property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static HAS_POST_TO_INSPECTION_STOCK

HAS_POST_TO_INSPECTION_STOCK: BooleanField<ProductPlant> = new BooleanField('HasPostToInspectionStock', ProductPlant, 'Edm.Boolean')

Static representation of the hasPostToInspectionStock property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static IS_BATCH_MANAGEMENT_REQUIRED

IS_BATCH_MANAGEMENT_REQUIRED: BooleanField<ProductPlant> = new BooleanField('IsBatchManagementRequired', ProductPlant, 'Edm.Boolean')

Static representation of the isBatchManagementRequired property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static IS_CO_PRODUCT

IS_CO_PRODUCT: BooleanField<ProductPlant> = new BooleanField('IsCoProduct', ProductPlant, 'Edm.Boolean')

Static representation of the isCoProduct property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static IS_INTERNAL_BATCH_MANAGED

IS_INTERNAL_BATCH_MANAGED: BooleanField<ProductPlant> = new BooleanField('IsInternalBatchManaged', ProductPlant, 'Edm.Boolean')

Static representation of the isInternalBatchManaged property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static IS_MARKED_FOR_DELETION

IS_MARKED_FOR_DELETION: BooleanField<ProductPlant> = new BooleanField('IsMarkedForDeletion', ProductPlant, 'Edm.Boolean')

Static representation of the isMarkedForDeletion property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static IS_NEGATIVE_STOCK_ALLOWED

IS_NEGATIVE_STOCK_ALLOWED: BooleanField<ProductPlant> = new BooleanField('IsNegativeStockAllowed', ProductPlant, 'Edm.Boolean')

Static representation of the isNegativeStockAllowed property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MAINTENANCE_STATUS_NAME

MAINTENANCE_STATUS_NAME: StringField<ProductPlant> = new StringField('MaintenanceStatusName', ProductPlant, 'Edm.String')

Static representation of the maintenanceStatusName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MAXIMUM_LOT_SIZE_QUANTITY

MAXIMUM_LOT_SIZE_QUANTITY: BigNumberField<ProductPlant> = new BigNumberField('MaximumLotSizeQuantity', ProductPlant, 'Edm.Decimal')

Static representation of the maximumLotSizeQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MINIMUM_LOT_SIZE_QUANTITY

MINIMUM_LOT_SIZE_QUANTITY: BigNumberField<ProductPlant> = new BigNumberField('MinimumLotSizeQuantity', ProductPlant, 'Edm.Decimal')

Static representation of the minimumLotSizeQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MRP_RESPONSIBLE

MRP_RESPONSIBLE: StringField<ProductPlant> = new StringField('MRPResponsible', ProductPlant, 'Edm.String')

Static representation of the mrpResponsible property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static MRP_TYPE

MRP_TYPE: StringField<ProductPlant> = new StringField('MRPType', ProductPlant, 'Edm.String')

Static representation of the mrpType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PERIOD_TYPE

PERIOD_TYPE: StringField<ProductPlant> = new StringField('PeriodType', ProductPlant, 'Edm.String')

Static representation of the periodType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PLANT

PLANT: StringField<ProductPlant> = new StringField('Plant', ProductPlant, 'Edm.String')

Static representation of the plant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROCUREMENT_TYPE

PROCUREMENT_TYPE: StringField<ProductPlant> = new StringField('ProcurementType', ProductPlant, 'Edm.String')

Static representation of the procurementType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCT

PRODUCT: StringField<ProductPlant> = new StringField('Product', ProductPlant, 'Edm.String')

Static representation of the product property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCTION_INVTRY_MANAGED_LOC

PRODUCTION_INVTRY_MANAGED_LOC: StringField<ProductPlant> = new StringField('ProductionInvtryManagedLoc', ProductPlant, 'Edm.String')

Static representation of the productionInvtryManagedLoc property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCT_CFOP_CATEGORY

PRODUCT_CFOP_CATEGORY: StringField<ProductPlant> = new StringField('ProductCFOPCategory', ProductPlant, 'Edm.String')

Static representation of the productCfopCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCT_IS_CONFIGURABLE

PRODUCT_IS_CONFIGURABLE: StringField<ProductPlant> = new StringField('ProductIsConfigurable', ProductPlant, 'Edm.String')

Static representation of the productIsConfigurable property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCT_IS_EXCISE_TAX_RELEVANT

PRODUCT_IS_EXCISE_TAX_RELEVANT: BooleanField<ProductPlant> = new BooleanField('ProductIsExciseTaxRelevant', ProductPlant, 'Edm.Boolean')

Static representation of the productIsExciseTaxRelevant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROFILE_CODE

PROFILE_CODE: StringField<ProductPlant> = new StringField('ProfileCode', ProductPlant, 'Edm.String')

Static representation of the profileCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROFILE_VALIDITY_START_DATE

PROFILE_VALIDITY_START_DATE: DateField<ProductPlant> = new DateField('ProfileValidityStartDate', ProductPlant, 'Edm.DateTime')

Static representation of the profileValidityStartDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROFIT_CENTER

PROFIT_CENTER: StringField<ProductPlant> = new StringField('ProfitCenter', ProductPlant, 'Edm.String')

Static representation of the profitCenter property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PURCHASING_GROUP

PURCHASING_GROUP: StringField<ProductPlant> = new StringField('PurchasingGroup', ProductPlant, 'Edm.String')

Static representation of the purchasingGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static REGION_OF_ORIGIN

REGION_OF_ORIGIN: StringField<ProductPlant> = new StringField('RegionOfOrigin', ProductPlant, 'Edm.String')

Static representation of the regionOfOrigin property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SERIAL_NUMBER_PROFILE

SERIAL_NUMBER_PROFILE: StringField<ProductPlant> = new StringField('SerialNumberProfile', ProductPlant, 'Edm.String')

Static representation of the serialNumberProfile property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static STOCK_DETERMINATION_GROUP

STOCK_DETERMINATION_GROUP: StringField<ProductPlant> = new StringField('StockDeterminationGroup', ProductPlant, 'Edm.String')

Static representation of the stockDeterminationGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static STOCK_IN_TRANSFER_QUANTITY

STOCK_IN_TRANSFER_QUANTITY: BigNumberField<ProductPlant> = new BigNumberField('StockInTransferQuantity', ProductPlant, 'Edm.Decimal')

Static representation of the stockInTransferQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static STOCK_IN_TRANSIT_QUANTITY

STOCK_IN_TRANSIT_QUANTITY: BigNumberField<ProductPlant> = new BigNumberField('StockInTransitQuantity', ProductPlant, 'Edm.Decimal')

Static representation of the stockInTransitQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PLANT_MRP_AREA

TO_PLANT_MRP_AREA: Link<ProductPlant, ProductPlantMrpArea> = new Link('to_PlantMRPArea', ProductPlant, ProductPlantMrpArea)

Static representation of the one-to-many navigation property toPlantMrpArea for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PLANT_QUALITY_MGMT

TO_PLANT_QUALITY_MGMT: OneToOneLink<ProductPlant, ProductPlantQualityMgmt> = new OneToOneLink('to_PlantQualityMgmt', ProductPlant, ProductPlantQualityMgmt)

Static representation of the one-to-one navigation property toPlantQualityMgmt for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PLANT_SALES

TO_PLANT_SALES: OneToOneLink<ProductPlant, ProductPlantSales> = new OneToOneLink('to_PlantSales', ProductPlant, ProductPlantSales)

Static representation of the one-to-one navigation property toPlantSales for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PLANT_STORAGE

TO_PLANT_STORAGE: OneToOneLink<ProductPlant, ProductPlantStorage> = new OneToOneLink('to_PlantStorage', ProductPlant, ProductPlantStorage)

Static representation of the one-to-one navigation property toPlantStorage for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PLANT_TEXT

TO_PLANT_TEXT: OneToOneLink<ProductPlant, ProductPlantText> = new OneToOneLink('to_PlantText', ProductPlant, ProductPlantText)

Static representation of the one-to-one navigation property toPlantText for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PRODUCT_PLANT_COSTING

TO_PRODUCT_PLANT_COSTING: OneToOneLink<ProductPlant, ProductPlantCosting> = new OneToOneLink('to_ProductPlantCosting', ProductPlant, ProductPlantCosting)

Static representation of the one-to-one navigation property toProductPlantCosting for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PRODUCT_PLANT_FORECAST

TO_PRODUCT_PLANT_FORECAST: OneToOneLink<ProductPlant, ProductPlantForecasting> = new OneToOneLink('to_ProductPlantForecast', ProductPlant, ProductPlantForecasting)

Static representation of the one-to-one navigation property toProductPlantForecast for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PRODUCT_PLANT_PROCUREMENT

TO_PRODUCT_PLANT_PROCUREMENT: OneToOneLink<ProductPlant, ProductPlantProcurement> = new OneToOneLink('to_ProductPlantProcurement', ProductPlant, ProductPlantProcurement)

Static representation of the one-to-one navigation property toProductPlantProcurement for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PRODUCT_SUPPLY_PLANNING

TO_PRODUCT_SUPPLY_PLANNING: OneToOneLink<ProductPlant, ProductSupplyPlanning> = new OneToOneLink('to_ProductSupplyPlanning', ProductPlant, ProductSupplyPlanning)

Static representation of the one-to-one navigation property toProductSupplyPlanning for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PRODUCT_WORK_SCHEDULING

TO_PRODUCT_WORK_SCHEDULING: OneToOneLink<ProductPlant, ProductWorkScheduling> = new OneToOneLink('to_ProductWorkScheduling', ProductPlant, ProductWorkScheduling)

Static representation of the one-to-one navigation property toProductWorkScheduling for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PROD_PLANT_INTERNATIONAL_TRADE

TO_PROD_PLANT_INTERNATIONAL_TRADE: OneToOneLink<ProductPlant, ProductPlantIntlTrd> = new OneToOneLink('to_ProdPlantInternationalTrade', ProductPlant, ProductPlantIntlTrd)

Static representation of the one-to-one navigation property toProdPlantInternationalTrade for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_STORAGE_LOCATION

TO_STORAGE_LOCATION: Link<ProductPlant, ProductStorageLocation> = new Link('to_StorageLocation', ProductPlant, ProductStorageLocation)

Static representation of the one-to-many navigation property toStorageLocation for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<ProductPlant> | DateField<ProductPlant> | BigNumberField<ProductPlant> | BooleanField<ProductPlant> | Link<ProductPlant, ProductPlantMrpArea> | OneToOneLink<ProductPlant, ProductPlantQualityMgmt> | OneToOneLink<ProductPlant, ProductPlantSales> | OneToOneLink<ProductPlant, ProductPlantStorage> | OneToOneLink<ProductPlant, ProductPlantText> | OneToOneLink<ProductPlant, ProductPlantIntlTrd> | OneToOneLink<ProductPlant, ProductPlantCosting> | OneToOneLink<ProductPlant, ProductPlantForecasting> | OneToOneLink<ProductPlant, ProductPlantProcurement> | OneToOneLink<ProductPlant, ProductSupplyPlanning> | OneToOneLink<ProductPlant, ProductWorkScheduling> | Link<ProductPlant, ProductStorageLocation>> = [ProductPlant.PRODUCT,ProductPlant.PLANT,ProductPlant.PURCHASING_GROUP,ProductPlant.COUNTRY_OF_ORIGIN,ProductPlant.REGION_OF_ORIGIN,ProductPlant.PRODUCTION_INVTRY_MANAGED_LOC,ProductPlant.PROFILE_CODE,ProductPlant.PROFILE_VALIDITY_START_DATE,ProductPlant.AVAILABILITY_CHECK_TYPE,ProductPlant.FISCAL_YEAR_VARIANT,ProductPlant.PERIOD_TYPE,ProductPlant.PROFIT_CENTER,ProductPlant.COMMODITY,ProductPlant.GOODS_RECEIPT_DURATION,ProductPlant.MAINTENANCE_STATUS_NAME,ProductPlant.IS_MARKED_FOR_DELETION,ProductPlant.MRP_TYPE,ProductPlant.MRP_RESPONSIBLE,ProductPlant.ABC_INDICATOR,ProductPlant.MINIMUM_LOT_SIZE_QUANTITY,ProductPlant.MAXIMUM_LOT_SIZE_QUANTITY,ProductPlant.FIXED_LOT_SIZE_QUANTITY,ProductPlant.CONSUMPTION_TAX_CTRL_CODE,ProductPlant.IS_CO_PRODUCT,ProductPlant.PRODUCT_IS_CONFIGURABLE,ProductPlant.STOCK_DETERMINATION_GROUP,ProductPlant.STOCK_IN_TRANSFER_QUANTITY,ProductPlant.STOCK_IN_TRANSIT_QUANTITY,ProductPlant.HAS_POST_TO_INSPECTION_STOCK,ProductPlant.IS_BATCH_MANAGEMENT_REQUIRED,ProductPlant.SERIAL_NUMBER_PROFILE,ProductPlant.IS_NEGATIVE_STOCK_ALLOWED,ProductPlant.GOODS_RECEIPT_BLOCKED_STOCK_QTY,ProductPlant.HAS_CONSIGNMENT_CTRL,ProductPlant.FISCAL_YEAR_CURRENT_PERIOD,ProductPlant.FISCAL_MONTH_CURRENT_PERIOD,ProductPlant.PROCUREMENT_TYPE,ProductPlant.IS_INTERNAL_BATCH_MANAGED,ProductPlant.PRODUCT_CFOP_CATEGORY,ProductPlant.PRODUCT_IS_EXCISE_TAX_RELEVANT,ProductPlant.TO_PLANT_MRP_AREA,ProductPlant.TO_PLANT_QUALITY_MGMT,ProductPlant.TO_PLANT_SALES,ProductPlant.TO_PLANT_STORAGE,ProductPlant.TO_PLANT_TEXT,ProductPlant.TO_PROD_PLANT_INTERNATIONAL_TRADE,ProductPlant.TO_PRODUCT_PLANT_COSTING,ProductPlant.TO_PRODUCT_PLANT_FORECAST,ProductPlant.TO_PRODUCT_PLANT_PROCUREMENT,ProductPlant.TO_PRODUCT_SUPPLY_PLANNING,ProductPlant.TO_PRODUCT_WORK_SCHEDULING,ProductPlant.TO_STORAGE_LOCATION]

All fields of the ProductPlant entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_PRODUCT_SRV"

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductPlant"

Technical entity name for ProductPlant.

Static _keyFields

_keyFields: Array<Selectable<ProductPlant>> = [ProductPlant.PRODUCT, ProductPlant.PLANT]

All key fields of the ProductPlant entity.

Static _keys

_keys: object = ProductPlant._keyFields.reduce((acc: { [keys: string]: Selectable<ProductPlant> }, field: Selectable<ProductPlant>) => {acc[field.fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property ProductPlant.

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCT_SRV"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for ProductPlant.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity ProductPlant.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductPlant>

    A builder that constructs instances of entity type ProductPlant.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the ProductPlant entity type.

    Returns ProductPlantRequestBuilder

    A ProductPlant request builder.