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.
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 "*".
Account Assignment Category. Maximum length: 1.
Batch Number. Assigns a material that is manufactured in batches or production lots to a specific batch. Maximum length: 10.
Company Code Currency. Maximum length: 5.
Controlling Area. Uniquely identifies a controlling area. The controlling area is the highest organizational unit in Controlling.Whether controlling area and company code are in a 1:1 relationship or a 1:n relationship, the number of posting periods in both controlling area and company code(s) must be identical. However, special periods may vary. Maximum length: 4.
Cost Center. A key that uniquely identifies a cost center. Maximum length: 10.
Cost Object. Term identifying the cost object ID. Cost objects are the activity units of business whose costs are assigned based on the cost origins. The R/3 System distinguishes between the following types of cost objects:Cost objects represented by a cost object IDCost objects represented by objects from other components, such as production orders or sales order itemsCost objects in the following areas are represented by cost object IDs:Activity-Based Costing (CO-OM-ABC)In Activity-Based Costing, overhead is first assigned to cost centers and then to business processes. From there, the overhead is assigned to cost objects as process costs.Costs for Intangible Goods and Services (CO-PC-OBJ)In Costs for Intangible Goods and Services, costs can be analyzed on general cost objects.Product Cost by Period (CO-PC-OBJ)In Product Cost by Period you can create a cost object hierarchy to record actual costs that cannot be recorded at the material or order level. You can distribute the costs assigned to the nodes of a cost object hierarchy directly to the individual objects in the lowest cost object nodes at period-end closing (for example, product cost collectors) or you can settle the costs directly from the cost object hierarchy to a price difference account.Product Cost Controlling Information System (CO-PC)You can create further cost object IDs in the Product Cost Controlling Information System for CO product groups. You can create a cost object ID for each group, and assign materials to the cost object ID. The costs of the assigned materials appear in summarized form in the information system by product group.You can use CO product groups for product drilldown reports.The cost object type determines which functions can be used with the cost object. Functions for cost object hierarchies are performed on the assumption that the given cost object indicates the top node of the hierarchy. Maximum length: 12.
Account number of customer. Uniquely identifies a customer. This customer number is used for managing customer special stocks. Maximum length: 10.
Unit of entry. Specifies the unit of measure in which the goods movement or inventory count is entered. Enter a unit of measure here only if it differs from the default unit of measure.There are the following default units of measure:the order unit for goods receipts with reference to purchase ordersthe production unit for goods receipts with reference to production ordersthe unit of issue for other goods movementsIf the default unit of measure has not been defined in the material master record, the system will suggest the stockkeeping unit. Maximum length: 3.
Fiscal Year. Period, 12 months as a rule, for which the company is to create its inventory and balance sheet. The fiscal year can be the same as the calendar year, but does not have to be. Maximum length: 4.
Period Year. Maximum length: 7.
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.
Functional Area. Structure criterion for an enterprise or government based on functional aspects. Use for Cost-of-Sales AccountingThe functional area is required to create a profit and loss account in Financial Accounting using cost-of-sales accounting. The following are examples of structure criteria:ManufacturingAdministrationSalesResearch and developmentUse for GovernmentThe functional area is needed for Funds Management to meet legal requirements for reporting with functional aspects. You can use the functional area to represent the global targets and goals (such as public safety or city development), in particular the expenses of your organization.Use in cost-of-sales accountingSee the documentation on Filling the Functional Area Field.For comprehensive information on cost-of-sales accounting and on the functional area, see the SAP Library under Accounting -> Financial Accounting -> General Ledger -> Cost-of-Sales Accounting.Use in governmentFor more information on the functional area, see the implementation Guide for Funds Management Government in the section Activate Account Assignment Elements. Maximum length: 16.
Externally Entered Posting Amount in Local Currency. Indicates the amount of the document item in the local currency of the company code. The value of the movement is calculated automatically by the system. However, it is possible to enter an amount manually if the item is to be valuated at a different price.
G/L Account Number. The G/L account number identifies the G/L account in a chart of accounts. Maximum length: 10.
Item has been Cancelled. Indicator that shows whether a specific material document item has been cancelled.
Reason for Movement. Specifies a key you can use to call up a standard text stipulating the reason for a goods movement (for example, reason for a return delivery). Maximum length: 4.
Goods movement ref doc type. Maximum length: 1.
Goods Movement Type (Inventory Management). Specifies a key for the type of goods movement. Each goods movement (for example, purchase order to warehouse) is allocated to a movement type in the system. Maximum length: 3.
Hierarchy level of line in document. For document items with the same superior line, this is used to differentiate between a real subitem and an automatically created line of the same level (for example, for stock transfers of a full product). Documentation of data elements MB_LINE_ID and MB_PARENT_ID.WarningThis indicator is used for internal program control.Please do not change the entry in this field.Any changes made could lead to program errors or terminations. Maximum length: 2.
Special Stock Type. Maximum length: 1.
Stock Type of Goods Movement (Stock Identifier). Unique stock type that identifies the purpose of the stock. NoteThe system determines the stock on the basis of stock identifiers.The following keys are possible for this field:01: Unrestricted-Use Stock02: Stock in Quality Inspection03: Returns04: Stock Transfer (Storage Location)05: Stock Transfer (Plant)06: Stock in Transit07: Blocked Stock08: Restricted-Use Stock09: Tied Empties10: Valuated Goods Receipt Blocked Stock. Maximum length: 2.
Valuation Type. Uniquely identifies separately valuated stocks of a material. The valuation types allowed for a material are determined by the valuation category.If a material is valuated according to its origin (valuation category H), you can define the possible countries of origin as valuation types. Maximum length: 10.
Item Automatically Created Indicator. Maximum length: 1.
"Delivery Completed" Indicator. Indicates that the item is to be regarded as closed.
Transfer Batch. Maximum length: 10.
Transfer Material. Maximum length: 40.
Transfer Special Stock Type. Maximum length: 1.
Receiving/Issuing Plant. Maximum length: 4.
Transfer Stock Type. Maximum length: 2.
Receiving/issuing storage location. Indicates the receiving or the issuing storage location. The receiving storage location is the storage location that is to receive the goods.The issuing storage location is the storage location that issues the goods. Maximum length: 4.
Valuation Type of Transfer Batch. Key used in the split valuation of materials (that is, the separate valuation of different stocks of the same material) to permit stocks of a transfer batch to be differentiated according to different criteria. Maximum length: 10.
Date of Manufacture.
Order Number. Key that uniquely identifies an order within a client. Maximum length: 12.
Order Item. Maximum length: 4.
Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.
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.
Number of Material Document. Alphanumeric key uniquely identifying the document. Number of the material document with which a goods movement was posted.Together with the material document year, the document number constitutes the key via which a material document is accessed. Maximum length: 10.
Material Document Item. Maximum length: 4.
Item Text. Contains an explanatory text on the line item. Line item texts can be used internally and externally. To be able to distinguish between these, you must begin texts for external use with "*". These texts can then be printed on all correspondence, dunning notices, payment advice notes, etc. The asterisk is removed when the text is printed.This function is only available in the FI component. It cannot be used in Materials Management. Maximum length: 50.
Unique Identification of Document Line. Maximum length: 6.
Identifier of immediately superior line. Indicates the line ID of the immediately superior line in the document. Lines that do not contain an initial value in this field may be, for example:Components of a subcontracting itemAutomatic lines for a stock transferEmpties items for the full productAt present we do not plan to fill this field in the interface structure IMSEG (except if it is called up in MM-IM). Filling the field would cause an error.Documentation of the data elements MB_LINE_ID and MB_LINE_DEPTH.WarningThis indicator is used for internal program control.Please do not change the entry in this field.Any changes made could lead to program errors or terminations. Maximum length: 6.
Material Document Year. Maximum length: 4.
Plant. Key uniquely identifying a plant. Maximum length: 4.
Profit Center. Key which together with the controlling area uniquely identifies a profit center. Maximum length: 10.
Profitability Segment. Maximum length: 10.
Purchase Order Number. Alphanumeric key uniquely identifying the document. 1Number of the purchase order to which the entry of services performed relates. Maximum length: 10.
Item Number of Purchasing Document. Maximum length: 5.
Quantity. Portion of total purchase order quantity that you wish to allocate to this account assignment item. The quantity entered determines which portion of the costs you wish to distribute to this account assignment item.
Quantity in unit of entry. Specifies the quantity to be moved in the unit of entry. The quantity is automatically converted to the stockkeeping unit (base unit of measure). Enter the quantity to be moved in any unit of measure for the material.If the relevant unit of measure has not been defined in the material master record, the system uses the stockkeeping unit.If you do not enter a unit of measure, the system uses the following units of measure:order unit in goods receipts against purchase ordersproduction unit in goods receipts against production ordersunit of issue in other goods movements.
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.
Number of reservation/dependent requirements. Alphanumeric key uniquely identifying the document. Maximum length: 10.
Final Issue for Reservation.
Item Number of Reservation / Dependent Requirements. Maximum length: 4.
Reversed Material Document. Maximum length: 10.
Reversed Material Document Item. Maximum length: 4.
Reversed Material Document Year. Maximum length: 4.
Sales Order Number. Uniquely identifies a sales order. The selection of postprocessing records via the sales order number is only possible for non-valuated sales order stock. Maximum length: 10.
Sales Order Item. Maximum length: 6.
Sales Order Schedule. Maximum length: 4.
Shelf Life Expiration or Best-Before Date. The date is set upon goods receipt in one of the following ways: You enter it yourself.You enter a date of production, and the system calculates the shelf life expiration date from the date of production plus the shelf life in days (from the material master record).NoteThis date can still be changed upon receipt of the usage decision for an inspection lot.
Value at Sales Prices Including Value-Added Tax. Specifies the value at sales prices including tax.
Sales order number of valuated sales order stock. Uniquely identifies a sales order. Maximum length: 10.
Sales Order Item of Valuated Sales Order Stock. Uniquely identifies an item in a sales order. Maximum length: 6.
Work Breakdown Structure Element (WBS Element). Key identifying a WBS element. Maximum length: 24.
Storage Location. Number of the storage location in which the material is stored. A plant may contain one or more storage locations. Maximum length: 4.
Supplier's Account Number. Alphanumeric key uniquely identifying the document. With the supplier number, information from the supplier master record (such as the supplier's address and bank details) is copied into a purchasing document (such as a request for quotation or a purchase order).You can use the supplier number to keep track of requests for quotation, purchase orders and outline agreements. Maximum length: 10.
One-to-one navigation property to the MaterialDocumentHeader entity.
Unloading Point. Specifies the point at which the material is to be unloaded (for example, ramp 1). Maximum length: 25.
Work Breakdown Structure Element (WBS Element). Key identifying a WBS element. Maximum length: 24.
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.
All fields selector.
Static representation of the batch property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the companyCodeCurrency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the controllingArea property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the costCenter property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the costObject property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the entryUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the fiscalYear property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the fiscalYearPeriod property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the functionalArea property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the gdsMvtExtAmtInCoCodeCrcy property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the glAccount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the goodsMovementIsCancelled property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the goodsMovementReasonCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the goodsMovementRefDocType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the goodsMovementType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the hierarchyNodeLevel property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the inventorySpecialStockType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the inventoryStockType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the inventoryValuationType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the issgOrRcvgBatch property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the issgOrRcvgMaterial property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the issgOrRcvgSpclStockInd property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the issuingOrReceivingPlant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the issuingOrReceivingStockType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the issuingOrReceivingStorageLoc property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the issuingOrReceivingValType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the isAutomaticallyCreated property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the isCompletelyDelivered property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the manufactureDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the manufacturingOrder property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the manufacturingOrderItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the materialBaseUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialDocument property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialDocumentItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialDocumentItemText property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialDocumentLine property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialDocumentParentLine property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialDocumentYear property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the profitabilitySegment property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the purchaseOrder property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the purchaseOrderItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the quantityInBaseUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the quantityInEntryUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the reservationIsFinallyIssued property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the reservationItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the reversedMaterialDocument property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the reversedMaterialDocumentItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the reversedMaterialDocumentYear property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 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 representation of the salesOrderScheduleLine property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the shelfLifeExpirationDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the slsPrcAmtInclVatInCoCodeCrcy property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the specialStockIdfgSalesOrder property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the specialStockIdfgSalesOrderItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the specialStockIdfgWbsElement property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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 representation of the supplier property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-one navigation property toMaterialDocumentHeader for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the unloadingPointName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
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.
All fields of the MaterialDocumentItem entity.
Default url path for the according service.
Technical entity name for MaterialDocumentItem.
All key fields of the MaterialDocumentItem entity.
Mapping of all key field names to the respective static field property MaterialDocumentItem.
ETag version identifier accessor.
The ETag version identifier of the retrieved entity, returns undefined if not retrieved
Returns a map of all defined fields in entity to their current values.
Entity with all defined entity fields
Custom field value getter.
The name of the custom field
The value of the corresponding custom field
Returns a map that contains all entity custom fields.
A map of all defined custom fields in the entity
Returns all updated custom field properties compared to the last known remote state.
A map containing all updated custom properties, with their new values
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.
Entity with all properties that changed
Validates whether a custom field exists in the entity.
The name of the custom field to update
A boolean value, that indicates whether a custom field is defined in entity
Sets all retrieved custom fields in entity.
Extracted custom fields from a retrieved entity
A boolean value, that indicates the existence of the field in entity
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check
Boolean value that describes whether a field name can be defined as custom field
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.
The name of the custom field to update
The value of the field
The entity itself, to facilitate method chaining
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.
State to be set as remote state
The entity itself, to facilitate method chaining
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity
The entity itself, to facilitate method chaining
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Returns an entity builder to construct instances MaterialDocumentItem.
A builder that constructs instances of entity type MaterialDocumentItem.
Returns a selectable object that allows the selection of custom field in a get request for the entity MaterialDocumentItem.
Name of the custom field to select
A builder that constructs instances of entity type MaterialDocumentItem.
Returns a request builder to construct requests for operations on the MaterialDocumentItem entity type.
A MaterialDocumentItem request builder.
This class represents the entity "A_MaterialDocumentItem" of service "API_MATERIAL_DOCUMENT_SRV". This service is part of the following communication scenarios: Material Document Integration (SAP_COM_0108). See https://api.sap.com/api/API_MATERIAL_DOCUMENT_SRV for more information.