Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PlannedOrder" of service "API_PLANNED_ORDERS". This service is part of the following communication scenarios: Production Planning Integration (SAP_COM_0104). See https://api.sap.com/api/API_PLANNED_ORDERS for more information.

Hierarchy

  • Entity
    • PlannedOrder

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns PlannedOrder

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 accountAssignmentCategory

accountAssignmentCategory: string

Account Assignment Category. Maximum length: 1.

nullable

Optional baseUnit

baseUnit: string

Base Unit of Measure. Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure. You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified. Maximum length: 3.

nullable

Optional billOfOperations

billOfOperations: string

Group Counter. This key and the task list group uniquely identify a task list. In Production Planning and Control, for example, it serves to identify alternative production processes in task lists and is used to make a distinction between similar task lists.The group counter can be used to identify different lot-size ranges, for example. Maximum length: 2.

nullable

Optional billOfOperationsGroup

billOfOperationsGroup: string

Key for Task List Group. Key identifying a group. You can use groups, for instance, to identify two routings that have different production steps for one material.Enter the group to which you want to restrict the selection. Maximum length: 8.

nullable

Optional billOfOperationsType

billOfOperationsType: string

Task List Type. Key which classifies task lists according to their functionality. Routings are defined under the following task list types:RoutingsReference operation setsMaster recipeGeneral maintenance task listEquipment task listInspection planTask list for funct. location. Maximum length: 1.

nullable

Optional capacityRequirement

capacityRequirement: string

ID of the Capacity Requirements Record. Maximum length: 12.

nullable

Optional capacityRequirementOrigin

capacityRequirementOrigin: string

Capacity Requirement Origin. Maximum length: 1.

nullable

Optional customer

customer: string

Customer Number. Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system. Maximum length: 10.

nullable

Optional fixedSupplier

fixedSupplier: string

Fixed Supplier. Number of the vendor defined as the fixed source of supply for this purchase requisition. Maximum length: 10.

nullable

Optional goodsReceiptQty

goodsReceiptQty: BigNumber

Quantity of Goods Received. Indicates the quantity from a goods receipt.

nullable

Optional issuedQuantity

issuedQuantity: BigNumber

Issued Quantity. Indicates the total quantity of the item that has been issued.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

Last Change to Planned Order: Time Stamp.

nullable

Optional lastScheduledDate

lastScheduledDate: Moment

Date of the Last Scheduling.

nullable

Optional material

material: string

Planning material. Number of the material for which the planned order is valid. Maximum length: 40.

nullable

Optional materialName

materialName: string

Material Description. Text containing up to 40 characters that describes the material in more detail. You can enter one material description in each of any number of languages.In principle, you enter the material description on the data screen of the first user department for which you enter data, and in your logon language. You can overwrite the material description on the Basic Data screen. Maximum length: 40.

nullable

Optional materialProcurementCategory

materialProcurementCategory: string

Material Procurement Category. Maximum length: 1.

nullable

Optional materialProcurementType

materialProcurementType: string

Material Procurement Type. Maximum length: 1.

nullable

Optional mrpArea

mrpArea: string

MRP Area. Number of the MRP area for which material requirements planning should be carried out separately. Maximum length: 10.

nullable

Optional mrpController

mrpController: string

MRP Controller. Maximum length: 3.

nullable

Optional mrpPlant

mrpPlant: string

Planning Plant. Number which clearly identifies the plant where the forecast, MRP or long-term planning is carried out. Maximum length: 4.

nullable

plannedOrder

plannedOrder: string

Planned Order. Number that specifically identifies a planned order for a material. Maximum length: 10.

Optional plannedOrderBomIsFixed

plannedOrderBomIsFixed: boolean

Fixing Indicator for BOM Explosion. Indicates whether the necessary BOM is fixed - that means that it will not be re-exploded during another planning run. You can only enter the indicator when creating and changing the planned order if the firming indicator is set for the planned order data.

nullable

Optional plannedOrderIsConvertible

plannedOrderIsConvertible: boolean

Planned Order Conversion Indicator. This indicator specifies whether the planned order can be converted into a production order or a process order, or into a purchase requisition. If the system finds a valid BOM for the planned order and if the release of the BOM for the planned order has been activated in the BOM status, the system automatically sets the conversion indicator in the planned order. If you have not activated the release of the BOM for the planned order, the system does not set the conversion indicator.If the system cannot find a valid BOM, the coversion indicator is then also set, as production orders without BOMs, that is, without components, can also be created.You can also set the conversion indicator yourself, independent of the BOM status, in the planned order.

nullable

Optional plannedOrderIsFirm

plannedOrderIsFirm: boolean

Firming Indicator for Planned Order Data. This firming indicator specifies whether the planned order is firm, that is, the system will not change either dates or lot sizes during planning runs. For manually created planned orders:The indicator is suggested by the system when the planned order is created. However, you can remove it if desired.For planned orders created by planning runs:The indicator is set by the system as soon as you have manually changed a planned order. However, you can remove the indicator when you change the planned order again.

nullable

Optional plannedOrderOpeningDate

plannedOrderOpeningDate: Moment

Planned Opening Date in Planned Order. Date that the planned order will be opened.

nullable

Optional plannedOrderType

plannedOrderType: string

Planned Order Type. Controls for which order type (for example, standard order, stock order) the planned order is provided for. Maximum length: 4.

nullable

Optional plndOrderPlannedEndDate

plndOrderPlannedEndDate: Moment

Planned Order End Date. Date, according to the planned order, that you should expect either the completion or the delivery of the planned order quantity.

nullable

Optional plndOrderPlannedEndTime

plndOrderPlannedEndTime: Time

Planned Order End Time.

nullable

Optional plndOrderPlannedScrapQty

plndOrderPlannedScrapQty: BigNumber

Planned Scrap Quantity. Quantity of scrap which is likely to be obtained from the total planned order quantity.

nullable

Optional plndOrderPlannedStartDate

plndOrderPlannedStartDate: Moment

Planned Order Start Date. Earliest date, according to the planned order, that the production of the planned order quantity starts. The order start date is transferred from the planned order to the production order.For planned orders created by planning runs, the system automatically determines the order start date by either forward or backward scheduling.

nullable

Optional plndOrderPlannedStartTime

plndOrderPlannedStartTime: Time

Planned Order Start Time.

nullable

Optional productionEndDate

productionEndDate: Moment

End Date for Production. The production finish date is the planned finish date of an order excluding the float after production. Production dates are determined during lead time scheduling.

nullable

Optional productionPlant

productionPlant: string

Production Plant in Planned Order. Plant in which the order quantity of the internally produced material is to be produced according to the planned order. Maximum length: 4.

nullable

Optional productionStartDate

productionStartDate: Moment

Start Date for Production. The production start date is the planned start date of an order excluding the float before production. Production dates are determined during lead time scheduling.

nullable

Optional productionSupervisor

productionSupervisor: string

Production Supervisor. Maximum length: 3.

nullable

Optional productionVersion

productionVersion: string

Production Version. Key which determines the various production techniques according to which a material can be manufactured. The production version determines the following:the BOM alternative for a BOM explosionthe task list type, the task list group and the task list group counter for allocation to task listslot-size restrictions for repetitive manufacturing. Maximum length: 4.

nullable

Optional purchasingDocument

purchasingDocument: string

Purchase Schedule/Outline Agreement. Maximum length: 10.

nullable

Optional purchasingDocumentItem

purchasingDocumentItem: string

Purchase Schedule/Outline Agreement Item. Maximum length: 5.

nullable

Optional purchasingGroup

purchasingGroup: string

Purchasing Group. Key for a buyer or a group of buyers, who is/are responsible for certain purchasing activities. Frequently, purchasing documents (such as purchase orders) are monitored by the purchasing group. Urging letters (in the case of overdue deliveries) fall also within the group's scope of activities.For each purchasing group, statistical analyses can be performed. The purchasing group can be used as a sort criterion when creating purchasing-specific reports. Maximum length: 3.

nullable

Optional purchasingOrganization

purchasingOrganization: string

Purchasing Organization. Denotes the purchasing organization. Maximum length: 4.

nullable

Optional quotaArrangement

quotaArrangement: string

Quota Arrangement. Maximum length: 10.

nullable

Optional quotaArrangementItem

quotaArrangementItem: string

Quota Arrangement Item. 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 reservation

reservation: string

Number of reservation/dependent requirements. Alphanumeric key uniquely identifying the document. Maximum length: 10.

nullable

Optional salesOrder

salesOrder: string

Sales Order. Number of the sales order to which the order is to be settled. Maximum length: 10.

nullable

Optional salesOrderItem

salesOrderItem: string

Sales Order Item. Item in the sales order to which the order is to be settled. Maximum length: 6.

nullable

Optional scheduledBasicEndDate

scheduledBasicEndDate: Moment

Scheduled finish. Scheduled finish date.

nullable

Optional scheduledBasicEndTime

scheduledBasicEndTime: Time

Earliest finish of operation (time).

nullable

Optional scheduledBasicStartDate

scheduledBasicStartDate: Moment

Scheduled start.

nullable

Optional scheduledBasicStartTime

scheduledBasicStartTime: Time

Earliest scheduled start: Execution (time). Earliest time at which the execution of the operation or activity (PS) can start.

nullable

Optional schedulingType

schedulingType: string

Scheduling Type. Maximum length: 1.

nullable

Optional storageLocation

storageLocation: string

Storage Location. Maximum length: 4.

nullable

Optional supplierName

supplierName: string

Name of Supplier. Maximum length: 80.

nullable

toPlannedOrderCapacity

toPlannedOrderCapacity: PlannedOrderCapacity[]

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

toPlannedOrderComponent

toPlannedOrderComponent: PlannedOrderComponent[]

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

Optional totalQuantity

totalQuantity: BigNumber

Planned Total Order Quantity. Quantity to be produced or ordered according to the planned order.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional wbsDescription

wbsDescription: string

WBS Element Name. Maximum length: 40.

nullable

Optional wbsElement

wbsElement: string

WBS Element. Key that identifies a WBS element. Maximum length: 24.

nullable

Optional wbsElementInternalId

wbsElementInternalId: string

Work Breakdown Structure Element Internal ID. Maximum length: 24.

nullable

Static ACCOUNT_ASSIGNMENT_CATEGORY

ACCOUNT_ASSIGNMENT_CATEGORY: StringField<PlannedOrder> = new StringField('AccountAssignmentCategory', PlannedOrder, 'Edm.String')

Static representation of the accountAssignmentCategory 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<PlannedOrder> = new AllFields('*', PlannedOrder)

All fields selector.

Static BASE_UNIT

BASE_UNIT: StringField<PlannedOrder> = new StringField('BaseUnit', PlannedOrder, 'Edm.String')

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

Static BILL_OF_OPERATIONS

BILL_OF_OPERATIONS: StringField<PlannedOrder> = new StringField('BillOfOperations', PlannedOrder, 'Edm.String')

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

Static BILL_OF_OPERATIONS_GROUP

BILL_OF_OPERATIONS_GROUP: StringField<PlannedOrder> = new StringField('BillOfOperationsGroup', PlannedOrder, 'Edm.String')

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

Static BILL_OF_OPERATIONS_TYPE

BILL_OF_OPERATIONS_TYPE: StringField<PlannedOrder> = new StringField('BillOfOperationsType', PlannedOrder, 'Edm.String')

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

Static CAPACITY_REQUIREMENT

CAPACITY_REQUIREMENT: StringField<PlannedOrder> = new StringField('CapacityRequirement', PlannedOrder, 'Edm.String')

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

Static CAPACITY_REQUIREMENT_ORIGIN

CAPACITY_REQUIREMENT_ORIGIN: StringField<PlannedOrder> = new StringField('CapacityRequirementOrigin', PlannedOrder, 'Edm.String')

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

Static CUSTOMER

CUSTOMER: StringField<PlannedOrder> = new StringField('Customer', PlannedOrder, 'Edm.String')

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

Static FIXED_SUPPLIER

FIXED_SUPPLIER: StringField<PlannedOrder> = new StringField('FixedSupplier', PlannedOrder, 'Edm.String')

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

Static GOODS_RECEIPT_QTY

GOODS_RECEIPT_QTY: BigNumberField<PlannedOrder> = new BigNumberField('GoodsReceiptQty', PlannedOrder, 'Edm.Decimal')

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

Static ISSUED_QUANTITY

ISSUED_QUANTITY: BigNumberField<PlannedOrder> = new BigNumberField('IssuedQuantity', PlannedOrder, 'Edm.Decimal')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<PlannedOrder> = new DateField('LastChangeDateTime', PlannedOrder, 'Edm.DateTimeOffset')

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

Static LAST_SCHEDULED_DATE

LAST_SCHEDULED_DATE: DateField<PlannedOrder> = new DateField('LastScheduledDate', PlannedOrder, 'Edm.DateTime')

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

Static MATERIAL

MATERIAL: StringField<PlannedOrder> = new StringField('Material', PlannedOrder, 'Edm.String')

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

Static MATERIAL_NAME

MATERIAL_NAME: StringField<PlannedOrder> = new StringField('MaterialName', PlannedOrder, 'Edm.String')

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

Static MATERIAL_PROCUREMENT_CATEGORY

MATERIAL_PROCUREMENT_CATEGORY: StringField<PlannedOrder> = new StringField('MaterialProcurementCategory', PlannedOrder, 'Edm.String')

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

Static MATERIAL_PROCUREMENT_TYPE

MATERIAL_PROCUREMENT_TYPE: StringField<PlannedOrder> = new StringField('MaterialProcurementType', PlannedOrder, 'Edm.String')

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

Static MRP_AREA

MRP_AREA: StringField<PlannedOrder> = new StringField('MRPArea', PlannedOrder, 'Edm.String')

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

Static MRP_CONTROLLER

MRP_CONTROLLER: StringField<PlannedOrder> = new StringField('MRPController', PlannedOrder, 'Edm.String')

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

Static MRP_PLANT

MRP_PLANT: StringField<PlannedOrder> = new StringField('MRPPlant', PlannedOrder, 'Edm.String')

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

Static PLANNED_ORDER

PLANNED_ORDER: StringField<PlannedOrder> = new StringField('PlannedOrder', PlannedOrder, 'Edm.String')

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

Static PLANNED_ORDER_BOM_IS_FIXED

PLANNED_ORDER_BOM_IS_FIXED: BooleanField<PlannedOrder> = new BooleanField('PlannedOrderBOMIsFixed', PlannedOrder, 'Edm.Boolean')

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

Static PLANNED_ORDER_IS_CONVERTIBLE

PLANNED_ORDER_IS_CONVERTIBLE: BooleanField<PlannedOrder> = new BooleanField('PlannedOrderIsConvertible', PlannedOrder, 'Edm.Boolean')

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

Static PLANNED_ORDER_IS_FIRM

PLANNED_ORDER_IS_FIRM: BooleanField<PlannedOrder> = new BooleanField('PlannedOrderIsFirm', PlannedOrder, 'Edm.Boolean')

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

Static PLANNED_ORDER_OPENING_DATE

PLANNED_ORDER_OPENING_DATE: DateField<PlannedOrder> = new DateField('PlannedOrderOpeningDate', PlannedOrder, 'Edm.DateTime')

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

Static PLANNED_ORDER_TYPE

PLANNED_ORDER_TYPE: StringField<PlannedOrder> = new StringField('PlannedOrderType', PlannedOrder, 'Edm.String')

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

Static PLND_ORDER_PLANNED_END_DATE

PLND_ORDER_PLANNED_END_DATE: DateField<PlannedOrder> = new DateField('PlndOrderPlannedEndDate', PlannedOrder, 'Edm.DateTime')

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

Static PLND_ORDER_PLANNED_END_TIME

PLND_ORDER_PLANNED_END_TIME: TimeField<PlannedOrder> = new TimeField('PlndOrderPlannedEndTime', PlannedOrder, 'Edm.Time')

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

Static PLND_ORDER_PLANNED_SCRAP_QTY

PLND_ORDER_PLANNED_SCRAP_QTY: BigNumberField<PlannedOrder> = new BigNumberField('PlndOrderPlannedScrapQty', PlannedOrder, 'Edm.Decimal')

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

Static PLND_ORDER_PLANNED_START_DATE

PLND_ORDER_PLANNED_START_DATE: DateField<PlannedOrder> = new DateField('PlndOrderPlannedStartDate', PlannedOrder, 'Edm.DateTime')

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

Static PLND_ORDER_PLANNED_START_TIME

PLND_ORDER_PLANNED_START_TIME: TimeField<PlannedOrder> = new TimeField('PlndOrderPlannedStartTime', PlannedOrder, 'Edm.Time')

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

Static PRODUCTION_END_DATE

PRODUCTION_END_DATE: DateField<PlannedOrder> = new DateField('ProductionEndDate', PlannedOrder, 'Edm.DateTime')

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

Static PRODUCTION_PLANT

PRODUCTION_PLANT: StringField<PlannedOrder> = new StringField('ProductionPlant', PlannedOrder, 'Edm.String')

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

Static PRODUCTION_START_DATE

PRODUCTION_START_DATE: DateField<PlannedOrder> = new DateField('ProductionStartDate', PlannedOrder, 'Edm.DateTime')

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

Static PRODUCTION_SUPERVISOR

PRODUCTION_SUPERVISOR: StringField<PlannedOrder> = new StringField('ProductionSupervisor', PlannedOrder, 'Edm.String')

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

Static PRODUCTION_VERSION

PRODUCTION_VERSION: StringField<PlannedOrder> = new StringField('ProductionVersion', PlannedOrder, 'Edm.String')

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

Static PURCHASING_DOCUMENT

PURCHASING_DOCUMENT: StringField<PlannedOrder> = new StringField('PurchasingDocument', PlannedOrder, 'Edm.String')

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

Static PURCHASING_DOCUMENT_ITEM

PURCHASING_DOCUMENT_ITEM: StringField<PlannedOrder> = new StringField('PurchasingDocumentItem', PlannedOrder, 'Edm.String')

Static representation of the purchasingDocumentItem 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<PlannedOrder> = new StringField('PurchasingGroup', PlannedOrder, '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 PURCHASING_ORGANIZATION

PURCHASING_ORGANIZATION: StringField<PlannedOrder> = new StringField('PurchasingOrganization', PlannedOrder, 'Edm.String')

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

Static QUOTA_ARRANGEMENT

QUOTA_ARRANGEMENT: StringField<PlannedOrder> = new StringField('QuotaArrangement', PlannedOrder, 'Edm.String')

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

Static QUOTA_ARRANGEMENT_ITEM

QUOTA_ARRANGEMENT_ITEM: StringField<PlannedOrder> = new StringField('QuotaArrangementItem', PlannedOrder, 'Edm.String')

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

Static RESERVATION

RESERVATION: StringField<PlannedOrder> = new StringField('Reservation', PlannedOrder, 'Edm.String')

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

Static SALES_ORDER

SALES_ORDER: StringField<PlannedOrder> = new StringField('SalesOrder', PlannedOrder, 'Edm.String')

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

Static SALES_ORDER_ITEM

SALES_ORDER_ITEM: StringField<PlannedOrder> = new StringField('SalesOrderItem', PlannedOrder, 'Edm.String')

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

Static SCHEDULED_BASIC_END_DATE

SCHEDULED_BASIC_END_DATE: DateField<PlannedOrder> = new DateField('ScheduledBasicEndDate', PlannedOrder, 'Edm.DateTime')

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

Static SCHEDULED_BASIC_END_TIME

SCHEDULED_BASIC_END_TIME: TimeField<PlannedOrder> = new TimeField('ScheduledBasicEndTime', PlannedOrder, 'Edm.Time')

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

Static SCHEDULED_BASIC_START_DATE

SCHEDULED_BASIC_START_DATE: DateField<PlannedOrder> = new DateField('ScheduledBasicStartDate', PlannedOrder, 'Edm.DateTime')

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

Static SCHEDULED_BASIC_START_TIME

SCHEDULED_BASIC_START_TIME: TimeField<PlannedOrder> = new TimeField('ScheduledBasicStartTime', PlannedOrder, 'Edm.Time')

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

Static SCHEDULING_TYPE

SCHEDULING_TYPE: StringField<PlannedOrder> = new StringField('SchedulingType', PlannedOrder, 'Edm.String')

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

Static STORAGE_LOCATION

STORAGE_LOCATION: StringField<PlannedOrder> = new StringField('StorageLocation', PlannedOrder, 'Edm.String')

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

Static SUPPLIER_NAME

SUPPLIER_NAME: StringField<PlannedOrder> = new StringField('SupplierName', PlannedOrder, 'Edm.String')

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

Static TOTAL_QUANTITY

TOTAL_QUANTITY: BigNumberField<PlannedOrder> = new BigNumberField('TotalQuantity', PlannedOrder, 'Edm.Decimal')

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

Static TO_PLANNED_ORDER_CAPACITY

TO_PLANNED_ORDER_CAPACITY: Link<PlannedOrder, PlannedOrderCapacity> = new Link('to_PlannedOrderCapacity', PlannedOrder, PlannedOrderCapacity)

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

Static TO_PLANNED_ORDER_COMPONENT

TO_PLANNED_ORDER_COMPONENT: Link<PlannedOrder, PlannedOrderComponent> = new Link('to_PlannedOrderComponent', PlannedOrder, PlannedOrderComponent)

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

Static WBS_DESCRIPTION

WBS_DESCRIPTION: StringField<PlannedOrder> = new StringField('WBSDescription', PlannedOrder, 'Edm.String')

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

Static WBS_ELEMENT

WBS_ELEMENT: StringField<PlannedOrder> = new StringField('WBSElement', PlannedOrder, 'Edm.String')

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

Static WBS_ELEMENT_INTERNAL_ID

WBS_ELEMENT_INTERNAL_ID: StringField<PlannedOrder> = new StringField('WBSElementInternalID', PlannedOrder, 'Edm.String')

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

Static _allFields

_allFields: Array<StringField<PlannedOrder> | BigNumberField<PlannedOrder> | DateField<PlannedOrder> | TimeField<PlannedOrder> | BooleanField<PlannedOrder> | Link<PlannedOrder, PlannedOrderCapacity> | Link<PlannedOrder, PlannedOrderComponent>> = [PlannedOrder.PLANNED_ORDER,PlannedOrder.PLANNED_ORDER_TYPE,PlannedOrder.MATERIAL,PlannedOrder.MATERIAL_NAME,PlannedOrder.PRODUCTION_PLANT,PlannedOrder.MRP_PLANT,PlannedOrder.MRP_AREA,PlannedOrder.PRODUCTION_VERSION,PlannedOrder.MATERIAL_PROCUREMENT_CATEGORY,PlannedOrder.MATERIAL_PROCUREMENT_TYPE,PlannedOrder.STORAGE_LOCATION,PlannedOrder.BASE_UNIT,PlannedOrder.TOTAL_QUANTITY,PlannedOrder.PLND_ORDER_PLANNED_SCRAP_QTY,PlannedOrder.GOODS_RECEIPT_QTY,PlannedOrder.ISSUED_QUANTITY,PlannedOrder.PLND_ORDER_PLANNED_START_DATE,PlannedOrder.PLND_ORDER_PLANNED_START_TIME,PlannedOrder.PLND_ORDER_PLANNED_END_DATE,PlannedOrder.PLND_ORDER_PLANNED_END_TIME,PlannedOrder.PLANNED_ORDER_OPENING_DATE,PlannedOrder.LAST_CHANGE_DATE_TIME,PlannedOrder.PRODUCTION_START_DATE,PlannedOrder.PRODUCTION_END_DATE,PlannedOrder.SALES_ORDER,PlannedOrder.SALES_ORDER_ITEM,PlannedOrder.CUSTOMER,PlannedOrder.WBS_ELEMENT_INTERNAL_ID,PlannedOrder.WBS_ELEMENT,PlannedOrder.WBS_DESCRIPTION,PlannedOrder.ACCOUNT_ASSIGNMENT_CATEGORY,PlannedOrder.RESERVATION,PlannedOrder.MRP_CONTROLLER,PlannedOrder.PRODUCTION_SUPERVISOR,PlannedOrder.PURCHASING_GROUP,PlannedOrder.PURCHASING_ORGANIZATION,PlannedOrder.FIXED_SUPPLIER,PlannedOrder.PURCHASING_DOCUMENT,PlannedOrder.PURCHASING_DOCUMENT_ITEM,PlannedOrder.QUOTA_ARRANGEMENT,PlannedOrder.QUOTA_ARRANGEMENT_ITEM,PlannedOrder.SUPPLIER_NAME,PlannedOrder.PLANNED_ORDER_IS_FIRM,PlannedOrder.PLANNED_ORDER_IS_CONVERTIBLE,PlannedOrder.PLANNED_ORDER_BOM_IS_FIXED,PlannedOrder.CAPACITY_REQUIREMENT,PlannedOrder.CAPACITY_REQUIREMENT_ORIGIN,PlannedOrder.BILL_OF_OPERATIONS_TYPE,PlannedOrder.BILL_OF_OPERATIONS_GROUP,PlannedOrder.BILL_OF_OPERATIONS,PlannedOrder.LAST_SCHEDULED_DATE,PlannedOrder.SCHEDULED_BASIC_END_DATE,PlannedOrder.SCHEDULED_BASIC_END_TIME,PlannedOrder.SCHEDULED_BASIC_START_DATE,PlannedOrder.SCHEDULED_BASIC_START_TIME,PlannedOrder.SCHEDULING_TYPE,PlannedOrder.TO_PLANNED_ORDER_CAPACITY,PlannedOrder.TO_PLANNED_ORDER_COMPONENT]

All fields of the PlannedOrder entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PlannedOrder"

Technical entity name for PlannedOrder.

Static _keyFields

_keyFields: Array<Selectable<PlannedOrder>> = [PlannedOrder.PLANNED_ORDER]

All key fields of the PlannedOrder entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PLANNED_ORDERS"
deprecated

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

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.

    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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      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

  • Returns an entity builder to construct instances PlannedOrder.

    Returns EntityBuilderType<PlannedOrder, PlannedOrderType>

    A builder that constructs instances of entity type PlannedOrder.

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PlannedOrder>

    A builder that constructs instances of entity type PlannedOrder.

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, JsonT>(entityConstructor: Constructable<EntityT, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns PlannedOrderRequestBuilder

    A PlannedOrder request builder.