Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PurchaseOrderItem" of service "API_PURCHASEORDER_PROCESS_SRV". This service is part of the following communication scenarios: Distributed Manufacturing Integration (SAP_COM_0077), Purchase Order Integration (SAP_COM_0053). See https://api.sap.com/api/API_PURCHASEORDER_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • PurchaseOrderItem

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns PurchaseOrderItem

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: undefined | string

Account Assignment Category. Specifies whether accounting for an item is to be effected via an auxiliary account (such as a cost center). The account assignment category determines which account assignment data (such as cost center, account number and so on) is necessary for the item. Maximum length: 1.

nullable

Optional brCfopCategory

brCfopCategory: 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 brIsProducedInHouse

brIsProducedInHouse: undefined | false | true

Produced in-house. This indicator shows whether the material was produced by the company or another one. It is used for purpose of CFOP determination.If the indicator is set the material was produced by the company. If the indicator is not set the material was produced by another company.

nullable

Optional brMaterialOrigin

brMaterialOrigin: undefined | string

Origin of the material. This indicator shows whether the products were produced inside Brazil or were imported. If the goods were imported, it also indicates whether they were imported directly by the company or not. Origin of material:0 National - except indicated for codes 3, 4,5, or 81 Foreign - imported directly2 Foreign - acquired nationally3 National - merchandise or asset with import content is over than 40%4 National - when the production is according to Decree-law 288/67, and laws 8.248/91, 8.387/91, 10.176/01 and 11.484/075 National - with import content less than or equal to 40%6 Foreign - imported directly, no similar national, listed in “Resolução CAMEX”7 Foreign - acquired nationally, no similar national, listed in “Resolução CAMEX”8 National - with import content over 70%. Maximum length: 1.

nullable

Optional brMaterialUsage

brMaterialUsage: undefined | string

Usage of the material. This indicator shows the intended usage of a particular material in inventory. Please note that each usage of a material must have a separate valuation. As soon as a material has more than one usage in a valuation area then valuation types can be used.Material Usage:0 Resale1 Industrialization2 Consumption3 Asset4 Consumption for Main Activity (only editable if TaaS switch is active). Maximum length: 1.

nullable

Optional consumptionTaxCtrlCode

consumptionTaxCtrlCode: undefined | string

Brazilian NCM Code. Specifies the NCM code. Maximum length: 16.

nullable

Optional customer

customer: undefined | string

Customer. Number of the customer to whom a material is to be delivered (or for whom a service is to be rendered). This entry is used in third-party order processing (triangular business arrangements).When you enter a customer number, the delivery address is taken from the customer (debtor) master record.If you do not enter a customer number, you must enter a delivery address. Maximum length: 10.

nullable

Optional deliveryAddressCityName

deliveryAddressCityName: undefined | string

City. City name as part of the address. The city name is saved redundantly in another database field in upper- case letters, for search help.If the Postal regional structure ('city file') is active, the city name is checked against the Cities defined in the regional structure. Maximum length: 40.

nullable

Optional deliveryAddressCountry

deliveryAddressCountry: undefined | string

Country Key. The country key contains information which the system uses to check entries such as the length of the postal code or bank account number. The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA. Maximum length: 3.

nullable

Optional deliveryAddressHouseNumber

deliveryAddressHouseNumber: undefined | string

House Number. House number as part of an address. It is printed in the Street line.Other supplementary street information can be entered in the House number supplement or one of the Street2, Street3, Street4 or Street5 fields. See Print the Street address.A house number (e.g. 117) or a house number with supplement (e.g. 117a), or a house number range (e.g. 16-20), can be maintained in this field. Maximum length: 10.

nullable

Optional deliveryAddressId

deliveryAddressId: undefined | string

Manual address number in purchasing document item. Maximum length: 10.

nullable

Optional deliveryAddressName

deliveryAddressName: undefined | string

Name 1. Address component: Name of an address. Maximum length: 40.

nullable

Optional deliveryAddressPostalCode

deliveryAddressPostalCode: undefined | string

City Postal Code. Postal code as part of the address If different postal codes are maintained for the PO Box and Street address of an address, this field contains the Street address postal code. Maximum length: 10.

nullable

Optional deliveryAddressRegion

deliveryAddressRegion: undefined | string

Region (State, Province, County). In some countries, the region forms part of the address. The meaning depends on the country. The automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain.For more information, see the examples in the documentation on the Address Layout Key.Meaning of the regional code in ...Australia -> ProvinceBrazil -> StateCanada -> ProvinceGermany -> StateGreat Britain -> CountyItaly -> ProvinceJapan -> PrefectureSwitzerland -> CantonUSA -> State. Maximum length: 3.

nullable

Optional deliveryAddressStreetName

deliveryAddressStreetName: undefined | string

Street. Street name as part of the address. The street name is saved, redundantly in upper case in another database field, for search help purposes.There are other fields for address parts which can be printed above or below the street. See Print the Street address.The house number and other supplements are usually maintained in their own fields. See Formatting the Street line. Maximum length: 60.

nullable

Optional documentCurrency

documentCurrency: undefined | string

Currency Key. Currency key for amounts in the system. Maximum length: 5.

nullable

Optional earmarkedFunds

earmarkedFunds: undefined | string

Document Number for Earmarked Funds. Number uniquely identifying a document. Maximum length: 10.

nullable

Optional earmarkedFundsDocument

earmarkedFundsDocument: undefined | string

Document Number for Earmarked Funds. Number uniquely identifying a document. Maximum length: 10.

nullable

Optional earmarkedFundsDocumentItem

earmarkedFundsDocumentItem: undefined | string

Earmarked Funds: Document Item. Maximum length: 3.

nullable

Optional earmarkedFundsItem

earmarkedFundsItem: undefined | string

Earmarked Funds: Document Item. Maximum length: 3.

nullable

Optional evaldRcptSettlmtIsAllowed

evaldRcptSettlmtIsAllowed: undefined | false | true

Evaluated Receipt Settlement (ERS). Specifies that evaluated receipt settlement (ERS) or the automatic generation of invoices according to an invoicing plan is to be possible in relation to materials supplied or services performed (respectively) with regard to this supplier or this document item. If you wish to settle up with regard to PO or scheduling agreement items involving this supplier using Evaluated Receipt Settlement (ERS), this indicator must be set.This indicator must also be set if you wish to work with purchase orders used in conjunction with invoicing plans when procuring external services.

nullable

Optional expectedOverallLimitAmount

expectedOverallLimitAmount: BigNumber

Expected Value of Overall Limit. Value that the unplanned services (or the material) covered by this item are not expected to exceed. The expected value is included in the net price of the item. If the document contains services in addition to the limit, the expected value is totalled up with the overall value of the services to arrive at the net price. If the document contains only a limit, the expected value is the net price. In this case, specification of an expected value is mandatory. This guarantees that the net price of an item, especially a purchase order item, cannot amount to "0".The expected value need not be equal to the value of the overall limit. In follow-on processes and documents, the expected value can be exceeded. In the process of cost control, though, you can use it for comparison with the overall limit.CO Controlling adopts the expected value in the commitment for the document.If you use the release (approval) procedure for purchasing documents, the expected value serves as the basis for the application of a release strategy.The expected value is included in the release order statistics for contracts.

nullable

Optional goodsReceiptIsExpected

goodsReceiptIsExpected: undefined | false | true

Goods Receipt Indicator. Specifies whether the item involves a goods receipt. DependenciesIn the processing of production and process orders, the indicator specifies whether a goods receipt is allowed and expected for the order item.If the indicator is set, the order item is relevant to inventory management. The indicator is set during the creation of the order if the order is settled in respect of a material or a sales order item.

nullable

Optional goodsReceiptIsNonValuated

goodsReceiptIsNonValuated: undefined | false | true

Goods Receipt, Non-Valuated. Specifies that the goods receipt for this item is not to be valuated. Set the indicator if goods receipts involving this material are not to be valuated. The valuation of the purchase order item will then take place at the time of invoice verification.NoteIf the indicator has been set for an item with the material type non- valuated, the quantity recorded in Inventory Management can differ from the value in Financial Accounting during the period between goods receipt and invoice receipt, since the value is not updated until the invoice is posted in Financial Accounting.

nullable

Optional incotermsClassification

incotermsClassification: undefined | string

Incoterms (Part 1). Commonly used trading terms that comply with the standards established by the International Chamber of Commerce (ICC). Incoterms specify internationally recognized procedures that the shipper and the receiving party must follow for the shipping transaction to be completed successfully.If goods are shipped through a port of departure, the appropriate Incoterm might be: FOB ("Free On Board"). You can provide further details (for example, the name of the port) in the secondary Incoterm field: FOB Boston, for example. Maximum length: 3.

nullable

Optional incotermsLocation1

incotermsLocation1: undefined | string

Incoterms Location 1. Provides additional information for the primary Incoterm. For Incoterms 2010, this field represents:

  1. For sea and inland waterway transport - Port of Shipment2. For any mode of transport - Place of Delivery 2010Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterms Incoterms Description Location 1 EXW Ex Works Place of DeliveryFCA Free Carrier Place of DeliveryCPT Carriage Paid To Place of DestinationCIP Carriage & Insurance Paid To Place of DestinationDAF Delivered at Frontier Place of DeliveryDDP Delivered Duty Paid Place of DestinationDDU Delivered Duty Unpaid Place of DestinationGroup 2: Rules for sea and inland waterwaysIncoterms Incoterms Description Location 1 FAS Free Alongside Ship Port of ShipmentFOB Free On Board Port of ShipmentCFR Cost & Freight Port of DestinationCIF Cost Insurance & Freight Port of DestinationDEQ Delivered Eq Quay (Duty Paid) Port of DestinationDES Delivered Ex Ship Port of DestinationIf the primary incoterm is specified as FOB “Free on Board”, the second field provides details of the port from which the delivery leaves, such as FOB Boston. Maximum length: 70.
nullable

Optional incotermsLocation2

incotermsLocation2: undefined | string

Incoterms Location 2. Provides additional information for the Incoterms. This field is only available for C-Clauses (if customized appropriately). Note the following for the incoterms versions below: No Version:This field is disabledIncoterm Version 2000This field is disabled as part of standard delivery unless a customer decides to enable it by the way of Customizing for Sales and Distribution under Master Data -> Business Partners -> Customers -> Billing Document -> Incoterms -> Map Incoterms to Versions.Incoterm Version 2010For this version, the field represents:Sea and inland waterway transport - Port of DestinationAny mode of transport - Place of Destination2010 Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterms Incoterms Description Location 2CPT Carriage Paid To Place of DestinationCIP Carriage & Insurance Paid To Place of DestinationGroup 2: Rules for sea and inland waterwaysIncoterms Incoterms Description Location 2CFR Cost & Freight Port of DestinationCIF Cost Insurance & Freight Port of Destination. Maximum length: 70.

nullable

Optional incotermsTransferLocation

incotermsTransferLocation: undefined | string

Incoterms (Part 2). Additional information for the primary Incoterm. If the primary Incoterm is, for example, FOB ("Free on Board"), then the second field provides details of the port from which the delivery leaves (for example, "FOB Boston"). Maximum length: 28.

nullable

Optional internationalArticleNumber

internationalArticleNumber: undefined | string

International Article Number (EAN/UPC). Glossary definition. Maximum length: 18.

nullable

Optional invoiceIsExpected

invoiceIsExpected: undefined | false | true

Invoice receipt indicator. Specifies whether an invoice receipt is linked to the purchase order item. If the indicator is not set, the goods are to be delivered free of charge.

nullable

Optional invoiceIsGoodsReceiptBased

invoiceIsGoodsReceiptBased: undefined | false | true

Indicator: GR-Based Invoice Verification. Indicator specifying that provision has been made for goods-receipt-based invoice verification for a purchase order item or invoice item.

nullable

Optional isCompletelyDelivered

isCompletelyDelivered: undefined | false | true

"Delivery Completed" Indicator. Indicates that the item is to be regarded as closed.

nullable

Optional isFinallyInvoiced

isFinallyInvoiced: undefined | false | true

Final Invoice Indicator. Indicates that the last invoice from a supplier has been received for an item and/or that no further invoice is expected. The final invoice indicator serves as information for the applicationsCash Management and ForecastCash Budget ManagementFunds ManagementIf you set the final invoice indicator, purchase order commitments are reset.However, the final invoice indicator does not prevent further invoices from being posted. Furthermore, it does not replace GR/IR account maintenance in the event of a variance between GR quantity and invoice quantity.Purchase order: 100 pieces of material A at $10/piece-> The PO commitment is automatically set to $1000.Goods receipt: 80 piecesInvoice for 60 pieces = $600-> The purchase order commitment is automatically set to $400.Invoice for 15 pieces = $150 - final invoice indicator set.-> The purchase order commitment is automatically set to zero.Since the final invoice indicator does not have any effect on the GR/IR clearing account, you must clear the difference of 5 pieces ($50) on the GR/IR clearing account if no further invoices are posted.

nullable

Optional isReturnsItem

isReturnsItem: undefined | false | true

Returns Item. Specifies whether or not the item is a returns item. You cannot set the returns indicator for items, for which goods receipts and invoice receipts do not refer to the quantity.This is the case for the following items:Service items (item type D)Limit items (item type B)Items with invoicing plan.

nullable

Optional itemNetWeight

itemNetWeight: BigNumber

Net Weight. Net weight of item per unit of weight. The weight is expressed in terms of the unit of measure you specify in the field "unit of weight".

nullable

Optional itemVolume

itemVolume: BigNumber

Volume. Space that the material occupies per unit of volume. The volume refers to the unit specified in the "Volume unit" field. The volume and its unit always refer to the base unit of measure.

nullable

Optional itemVolumeUnit

itemVolumeUnit: undefined | string

Volume Unit. Unit referring to the volume of the material. If you specify a volume, you have to enter the corresponding volume unit here. Maximum length: 3.

nullable

Optional itemWeightUnit

itemWeightUnit: undefined | string

Unit of Weight. Unit in which the gross or net weight of this item is expressed. If you specify a gross or net weight, you must enter the relevant unit of weight here. Maximum length: 3.

nullable

Optional manufacturerMaterial

manufacturerMaterial: undefined | string

Material number. Uniquely identifies a material. This field is also used for MPN materials. Maximum length: 40.

nullable

Optional material

material: undefined | string

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

nullable

Optional materialGroup

materialGroup: undefined | string

Material Group. Key that you use to group together several materials or services with the same attributes, and to assign them to a particular material group. You can use material groups to:Restrict the scope of analysesSearch specifically for material master records via search helps. Maximum length: 9.

nullable

Optional multipleAcctAssgmtDistribution

multipleAcctAssgmtDistribution: undefined | string

Distribution Indicator for Multiple Account Assignment. Defines how the quantity and value of the purchase order item are distributed to individual account assignment items. You can distribute the purchase order quantity or the net value of a document item, or specify a percentage for each account assignment. The system calculates complementary values. For example, if you choose quantity-based distribution and enter a number of pieces for each account assignment, the system calculates the percentage and net value.If you choose quantity-based or percentage distribution, the quantities that are distributed to an account assignment are rounded to three decimal places, to ensure that the 100% of the item quantity is always distributed.If you choose percentage distribution and change the requested quantity on the item overview screen, the system adjusts the quantities in the associated account assignment items.If you choose amount-based distribution, the system distributes the item quantity to the individual account assignments exactly according to the defined distribution, including very small value amounts. The quantities of individual account assignment items are displayed as rounded, but the system uses the exact quantities. Maximum length: 1.

nullable

Optional netPriceAmount

netPriceAmount: BigNumber

Net Price in Purchasing Document (in Document Currency). Net price per price unit.

nullable

Optional netPriceQuantity

netPriceQuantity: BigNumber

Price Unit.

nullable

Optional ordPriceUnitToOrderUnitDnmntr

ordPriceUnitToOrderUnitDnmntr: BigNumber

Denominator for Conv. of Order Price Unit into Order Unit. Denominator of the quotient representing the ratio order unit: purchase order price unit.Enter the quantity in the order unit that applies for the quantity in the purchase order price unit.You want to order 200 l of a liquid. However, the supplier sells the liquid by the kilogram. 1 kg of this liquid corresponds to 4 l.As conversion factor, enter:Order quantity/order unit Order price qty./order price unit4 l --> 1 kg.

nullable

Optional orderPriceUnit

orderPriceUnit: undefined | string

Order Price Unit (Purchasing). Indicates the unit of measurement to which the purchase order price relates. Invoices are created using price units and purchase order price units which constitute the basis for value postings.They can be stored in the purchasing info record.A material or commodity (for example, oil) can be ordered by the liter, but the supplier's invoice shows a price of 2 dollars per kilogram.You enter 10 l as the order quantity and order unit, but specify 2 dollars per kg as purchase order price and purchase order price unit.In addition, you enter the conversion factor "order unit -> purchase order price unit" (for example 2 l per 1 kg) in the "details" data of the purchase order item. Maximum length: 3.

nullable

Optional orderPriceUnitToOrderUnitNmrtr

orderPriceUnitToOrderUnitNmrtr: BigNumber

Numerator for Conversion of Order Price Unit into Order Unit. Numerator of the quotient representing the ratio order unit : purchase order price unit. Enter the quantity in the PO price unit that applies for the quantity in the order unit.You want to order 200 l of a liquid. However, the supplier sells the liquid by the kilogram. 1 kg of this liquid corresponds to 4 l.As conversion factor, enter:Order quantity/order unit Order price qty./order price unit4 l --> 1 kg.

nullable

Optional orderQuantity

orderQuantity: BigNumber

Purchase Order Quantity. Quantity ordered by the buyer, to be supplied by the supplier. The purchase order quantity relates to the order unit. It is referred to by Goods Receiving and Invoice Verification for checking purposes.

nullable

Optional overallLimitAmount

overallLimitAmount: BigNumber

Overall Limit. Maximum value that the total of all unplanned services (or the value of the material) covered by this document item may not exceed. Limits can be used in service lines and the items of blanket purchase orders.When services actually performed are entered in service entry sheets (or at the time of goods receipt in the case of materials), the system checks the entered values with regard to adherence to this maximum value. If the overall limit is exceeded, it issues an appropriate message.If you have also fixed sub-limits within the overall limit for an item, each time services are entered or goods receipts are recorded the system checks whether the individual sub-limits and the overall limit have/has been adhered to.

nullable

Optional overdelivTolrtdLmtRatioInPct

overdelivTolrtdLmtRatioInPct: BigNumber

Overdelivery Tolerance. Percentage (based on the order quantity) up to which an overdelivery of this item will be accepted. If you have set the indicator in the Partial delivery/Item field to 'D' (partial delivery allowed), this takes priority. It makes no sense to define a tolerance limit for overdelivery in such case.

nullable

Optional partialInvoiceDistribution

partialInvoiceDistribution: undefined | string

Partial invoice indicator. Determines how invoice amounts in partial invoices are to be distributed among the individual account assignments in the case of an item subject to multiple account assignment. In the case of multiple account assignment, you can distribute the total amount of partial invoices among the individual accounts in two ways:On a progressive fill-up basisOn a proportional basisIf you enter a partial invoice at invoice receipt, the system calculates the distribution of the costs in Invoice Verification according to the partial invoice indicator entered and suggests the relevant values for the individual accounts. You can overwrite these values if you want to use a different distribution to that planned in the purchase order.NoteIf you work with Logistics Invoice Verification, you can only choose proportional distribution.100 pieces of a material have been ordered for various cost centers as follows: 50 pieces for for cost center A; 40 pieces for cost center B; 10 pieces for cost center C.A partial invoice is entered for this purchase order. The invoice amount is $700, covering 70 pieces. The invoice amount is distributed as follows:Ordered Cost center Proportional Progressive fill-up50 pcs A $350 $50040 pcs B $280 $20010 pcs C $70 $00------------------------------------------------------Total: 100 pcs Total: $700 Total: $700. Maximum length: 1.

nullable

Optional plant

plant: undefined | string

Plant. Specifies the key for a production facility or branch office within the company (that is, the company code). You use the plant key to determine, for instance, which plant is to receive ordered goods. Maximum length: 4.

nullable

Optional priceIsToBePrinted

priceIsToBePrinted: undefined | false | true

Price Printout. Determines whether or not the price is to be included in the purchase order printout.

nullable

Optional pricingDateControl

pricingDateControl: undefined | string

Price Determination (Pricing) Date Control. Determines which date is to be used for price determination (pricing) purposes. Enter the key for the desired date.If you choose the date of goods receipt, for example, a new price will be determined upon the arrival of the goods, causing the item to be revaluated at this time.NoteIf you have chosen the delivery date as the date for price determination and an item contains several delivery dates (i.e. has a delivery schedule), the first delivery date (the delivery date specified in the first schedule line) is taken. Maximum length: 1.

nullable

Optional productType

productType: undefined | string

Product Type Group. Superordinate term that covers products that can be procured, for example materials and services. In the product type group you choose to either procure a material (by entering blank or 1) or a service (by entering 2).The procurement process is different for materials and services. For example, you can only maintain the field Service Performer when you purchase a service.If you enter a material number in a purchase order item, the product type group is derived automatically from the material type. In this case you can no longer maintain the product type group in the purchase order manually. If you do not enter a material number, you can maintain the field manually.This functionality is available for the following item categories:- Standard- Third-Party. Maximum length: 2.

nullable

Optional purContractForOverallLimit

purContractForOverallLimit: undefined | string

Purchase Contract for Enhanced Limit. Identifies the purchase contract for the enhanced limit. The contract for the enhanced limit enables the following process:In a purchase contract, you define possible services for a service provider.In the purchase order item, you define a limit (Overall Limit and Expected Value) and you assign the purchase contract to this limit.In the service entry sheet that refers to this limit item, the service provider can only select services from the assigned contract. Maximum length: 10.

nullable

Optional purchaseContract

purchaseContract: undefined | string

Number of principal purchase agreement. Specifies the number of the outline agreement that this purchase order or purchase requisition refers to. Maximum length: 10.

nullable

Optional purchaseContractItem

purchaseContractItem: undefined | string

Item number of principal purchase agreement. Specifies the number of the outline agreement item that this purchase order or purchase requisitions refers to. Maximum length: 5.

nullable

purchaseOrder

purchaseOrder: string

Purchasing Document Number. Alphanumeric key uniquely identifying the document. Maximum length: 10.

purchaseOrderItem

purchaseOrderItem: string

Item Number of Purchase Order. Maximum length: 5.

Optional purchaseOrderItemCategory

purchaseOrderItemCategory: undefined | string

Item Category in Purchasing Document. Indicator which shows the item features. The item category controls whether the following entries and procedures are necessary or permitted for the item:material numberadditional account assignmentinventory management in the SAP Systemgoods receiptinvoice receiptIn the standard system an item in the "normal" category requires goods and invoice receipts. On the other hand for items in the "consignment" category, (that is order item for consignment material) invoice receipts are not allowed. Maximum length: 1.

nullable

Optional purchaseOrderItemText

purchaseOrderItemText: undefined | string

Short Text. Short description of the material. Maximum length: 40.

nullable

Optional purchaseOrderQuantityUnit

purchaseOrderQuantityUnit: undefined | string

Purchase Order Unit of Measure. Specifies the unit of measure in which the material is ordered. Maximum length: 3.

nullable

Optional purchaseRequisition

purchaseRequisition: undefined | string

Purchase Requisition Number. Alphanumeric key uniquely identifying the document. Maximum length: 10.

nullable

Optional purchaseRequisitionItem

purchaseRequisitionItem: undefined | string

Item number of purchase requisition. Specifies the number that uniquely identifies an item in . Maximum length: 5.

nullable

Optional purchasingDocumentDeletionCode

purchasingDocumentDeletionCode: undefined | string

Deletion indicator in purchasing document. Determines whether the item in the purchasing document is deleted or blocked. You can set the deletion indicator by choosing Edit -> Delete if:You want to cancel an itemAn item is closed and can be archivedYou can set the blocking indicator by selecting the item and then choosing Edit -> Block if you do not want to allow subsequent functions for the item. Note that you must manually remove the indicator as soon as subsequent functions are allowed again.You have entered a purchase order item by mistake. You cancel it by setting the deletion indicator.A purchase order item has been delivered, invoiced, and paid for, and can now be archived. You can set the deletion indicator. Maximum length: 1.

nullable

Optional purchasingInfoRecord

purchasingInfoRecord: undefined | string

Number of purchasing info record. Specifies the number that uniquely identifies a purchasing info record. Maximum length: 10.

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 requisitionerName

requisitionerName: undefined | string

Name of requisitioner/requester. Indicates for whom the material or external service shown in the purchase requisition is to be ordered. Maximum length: 12.

nullable

Optional servicePackage

servicePackage: undefined | string

Package number. Specifies an internal package number grouping together all services belonging to an item of a purchasing document. Via the package number, the program accesses the data in the individual service lines of a set of service specifications.ExampleA purchase requisition contains an item with the short text Pipelaying. This item comprises 250 individual service lines (the service specifications) detailing the services to be performed (work to be done) under this heading. Internally, the system groups together these 250 service lines under a package number. Maximum length: 10.

nullable

Optional servicePerformer

servicePerformer: undefined | string

Service Performer. Maximum length: 10.

nullable

Optional storageLocation

storageLocation: undefined | string

Storage Location. Maximum length: 4.

nullable

Optional supplierConfirmationControlKey

supplierConfirmationControlKey: undefined | string

Confirmation Control Key. Determines which confirmation categories are expected for a PO item (e.g. order acknowledgment, shipping notification). Maximum length: 4.

nullable

Optional supplierMaterialNumber

supplierMaterialNumber: undefined | string

Material Number Used by Supplier. Material number used by the supplier. In most cases, the supplier uses a different number for the material than the one used in this system. The supplier's material number can therefore also be quoted in a purchase order for identification purposes. Maximum length: 35.

nullable

Optional taxCode

taxCode: undefined | string

Tax on Sales/Purchases Code. The tax code represents a tax category which must be taken into consideration when making a tax return to the tax authorities. Tax codes are unique per country. The tax rate calculation rules and further features are stored in a table for each tax code.For tax-exempt or non-taxable transactions, you should use tax codes with a 0 percentage rate if the corresponding transactions are to be displayed in the tax returns.You must define new tax codes if tax rates are changed by the state. The old codes with the old tax rates must remain in the system until no more open items which use this tax code exist. Maximum length: 2.

nullable

Optional taxJurisdiction

taxJurisdiction: undefined | string

Tax Jurisdiction. The tax jurisdiction is used for determining the tax rates in the USA. It defines to which tax authorities you must pay your taxes. It is always the city to which the goods are supplied. Maximum length: 15.

nullable

toAccountAssignment

toAccountAssignment: PurOrdAccountAssignment[]

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

toPurchaseOrder

toPurchaseOrder: PurchaseOrder

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

toPurchaseOrderPricingElement

toPurchaseOrderPricingElement: PurOrdPricingElement[]

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

toScheduleLine

toScheduleLine: PurchaseOrderScheduleLine[]

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

Optional underdelivTolrtdLmtRatioInPct

underdelivTolrtdLmtRatioInPct: BigNumber

Underdelivery Tolerance. Percentage (based on the order quantity) up to which an underdelivery of this item will be accepted.

nullable

Optional unlimitedOverdeliveryIsAllowed

unlimitedOverdeliveryIsAllowed: undefined | false | true

Indicator: Unlimited Overdelivery Allowed. Indicator that specifies whether unlimited overdelivery can be accepted for the item.

nullable

Optional valuationType

valuationType: undefined | string

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.

nullable

Static ACCOUNT_ASSIGNMENT_CATEGORY

ACCOUNT_ASSIGNMENT_CATEGORY: StringField<PurchaseOrderItem> = new StringField('AccountAssignmentCategory', PurchaseOrderItem, '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<PurchaseOrderItem> = new AllFields('*', PurchaseOrderItem)

All fields selector.

Static BR_CFOP_CATEGORY

BR_CFOP_CATEGORY: StringField<PurchaseOrderItem> = new StringField('BR_CFOPCategory', PurchaseOrderItem, 'Edm.String')

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

Static BR_IS_PRODUCED_IN_HOUSE

BR_IS_PRODUCED_IN_HOUSE: BooleanField<PurchaseOrderItem> = new BooleanField('BR_IsProducedInHouse', PurchaseOrderItem, 'Edm.Boolean')

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

Static BR_MATERIAL_ORIGIN

BR_MATERIAL_ORIGIN: StringField<PurchaseOrderItem> = new StringField('BR_MaterialOrigin', PurchaseOrderItem, 'Edm.String')

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

Static BR_MATERIAL_USAGE

BR_MATERIAL_USAGE: StringField<PurchaseOrderItem> = new StringField('BR_MaterialUsage', PurchaseOrderItem, 'Edm.String')

Static representation of the brMaterialUsage 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<PurchaseOrderItem> = new StringField('ConsumptionTaxCtrlCode', PurchaseOrderItem, '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 CUSTOMER

CUSTOMER: StringField<PurchaseOrderItem> = new StringField('Customer', PurchaseOrderItem, '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 DELIVERY_ADDRESS_CITY_NAME

DELIVERY_ADDRESS_CITY_NAME: StringField<PurchaseOrderItem> = new StringField('DeliveryAddressCityName', PurchaseOrderItem, 'Edm.String')

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

Static DELIVERY_ADDRESS_COUNTRY

DELIVERY_ADDRESS_COUNTRY: StringField<PurchaseOrderItem> = new StringField('DeliveryAddressCountry', PurchaseOrderItem, 'Edm.String')

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

Static DELIVERY_ADDRESS_HOUSE_NUMBER

DELIVERY_ADDRESS_HOUSE_NUMBER: StringField<PurchaseOrderItem> = new StringField('DeliveryAddressHouseNumber', PurchaseOrderItem, 'Edm.String')

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

Static DELIVERY_ADDRESS_ID

DELIVERY_ADDRESS_ID: StringField<PurchaseOrderItem> = new StringField('DeliveryAddressID', PurchaseOrderItem, 'Edm.String')

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

Static DELIVERY_ADDRESS_NAME

DELIVERY_ADDRESS_NAME: StringField<PurchaseOrderItem> = new StringField('DeliveryAddressName', PurchaseOrderItem, 'Edm.String')

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

Static DELIVERY_ADDRESS_POSTAL_CODE

DELIVERY_ADDRESS_POSTAL_CODE: StringField<PurchaseOrderItem> = new StringField('DeliveryAddressPostalCode', PurchaseOrderItem, 'Edm.String')

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

Static DELIVERY_ADDRESS_REGION

DELIVERY_ADDRESS_REGION: StringField<PurchaseOrderItem> = new StringField('DeliveryAddressRegion', PurchaseOrderItem, 'Edm.String')

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

Static DELIVERY_ADDRESS_STREET_NAME

DELIVERY_ADDRESS_STREET_NAME: StringField<PurchaseOrderItem> = new StringField('DeliveryAddressStreetName', PurchaseOrderItem, 'Edm.String')

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

Static DOCUMENT_CURRENCY

DOCUMENT_CURRENCY: StringField<PurchaseOrderItem> = new StringField('DocumentCurrency', PurchaseOrderItem, 'Edm.String')

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

Static EARMARKED_FUNDS

EARMARKED_FUNDS: StringField<PurchaseOrderItem> = new StringField('EarmarkedFunds', PurchaseOrderItem, 'Edm.String')

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

Static EARMARKED_FUNDS_DOCUMENT

EARMARKED_FUNDS_DOCUMENT: StringField<PurchaseOrderItem> = new StringField('EarmarkedFundsDocument', PurchaseOrderItem, 'Edm.String')

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

Static EARMARKED_FUNDS_DOCUMENT_ITEM

EARMARKED_FUNDS_DOCUMENT_ITEM: StringField<PurchaseOrderItem> = new StringField('EarmarkedFundsDocumentItem', PurchaseOrderItem, 'Edm.String')

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

Static EARMARKED_FUNDS_ITEM

EARMARKED_FUNDS_ITEM: StringField<PurchaseOrderItem> = new StringField('EarmarkedFundsItem', PurchaseOrderItem, 'Edm.String')

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

Static EVALD_RCPT_SETTLMT_IS_ALLOWED

EVALD_RCPT_SETTLMT_IS_ALLOWED: BooleanField<PurchaseOrderItem> = new BooleanField('EvaldRcptSettlmtIsAllowed', PurchaseOrderItem, 'Edm.Boolean')

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

Static EXPECTED_OVERALL_LIMIT_AMOUNT

EXPECTED_OVERALL_LIMIT_AMOUNT: BigNumberField<PurchaseOrderItem> = new BigNumberField('ExpectedOverallLimitAmount', PurchaseOrderItem, 'Edm.Decimal')

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

Static GOODS_RECEIPT_IS_EXPECTED

GOODS_RECEIPT_IS_EXPECTED: BooleanField<PurchaseOrderItem> = new BooleanField('GoodsReceiptIsExpected', PurchaseOrderItem, 'Edm.Boolean')

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

Static GOODS_RECEIPT_IS_NON_VALUATED

GOODS_RECEIPT_IS_NON_VALUATED: BooleanField<PurchaseOrderItem> = new BooleanField('GoodsReceiptIsNonValuated', PurchaseOrderItem, 'Edm.Boolean')

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

Static INCOTERMS_CLASSIFICATION

INCOTERMS_CLASSIFICATION: StringField<PurchaseOrderItem> = new StringField('IncotermsClassification', PurchaseOrderItem, 'Edm.String')

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

Static INCOTERMS_LOCATION_1

INCOTERMS_LOCATION_1: StringField<PurchaseOrderItem> = new StringField('IncotermsLocation1', PurchaseOrderItem, 'Edm.String')

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

Static INCOTERMS_LOCATION_2

INCOTERMS_LOCATION_2: StringField<PurchaseOrderItem> = new StringField('IncotermsLocation2', PurchaseOrderItem, 'Edm.String')

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

Static INCOTERMS_TRANSFER_LOCATION

INCOTERMS_TRANSFER_LOCATION: StringField<PurchaseOrderItem> = new StringField('IncotermsTransferLocation', PurchaseOrderItem, 'Edm.String')

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

Static INTERNATIONAL_ARTICLE_NUMBER

INTERNATIONAL_ARTICLE_NUMBER: StringField<PurchaseOrderItem> = new StringField('InternationalArticleNumber', PurchaseOrderItem, 'Edm.String')

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

Static INVOICE_IS_EXPECTED

INVOICE_IS_EXPECTED: BooleanField<PurchaseOrderItem> = new BooleanField('InvoiceIsExpected', PurchaseOrderItem, 'Edm.Boolean')

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

Static INVOICE_IS_GOODS_RECEIPT_BASED

INVOICE_IS_GOODS_RECEIPT_BASED: BooleanField<PurchaseOrderItem> = new BooleanField('InvoiceIsGoodsReceiptBased', PurchaseOrderItem, 'Edm.Boolean')

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

Static IS_COMPLETELY_DELIVERED

IS_COMPLETELY_DELIVERED: BooleanField<PurchaseOrderItem> = new BooleanField('IsCompletelyDelivered', PurchaseOrderItem, 'Edm.Boolean')

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 IS_FINALLY_INVOICED

IS_FINALLY_INVOICED: BooleanField<PurchaseOrderItem> = new BooleanField('IsFinallyInvoiced', PurchaseOrderItem, 'Edm.Boolean')

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

Static IS_RETURNS_ITEM

IS_RETURNS_ITEM: BooleanField<PurchaseOrderItem> = new BooleanField('IsReturnsItem', PurchaseOrderItem, 'Edm.Boolean')

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

Static ITEM_NET_WEIGHT

ITEM_NET_WEIGHT: BigNumberField<PurchaseOrderItem> = new BigNumberField('ItemNetWeight', PurchaseOrderItem, 'Edm.Decimal')

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

Static ITEM_VOLUME

ITEM_VOLUME: BigNumberField<PurchaseOrderItem> = new BigNumberField('ItemVolume', PurchaseOrderItem, 'Edm.Decimal')

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

Static ITEM_VOLUME_UNIT

ITEM_VOLUME_UNIT: StringField<PurchaseOrderItem> = new StringField('ItemVolumeUnit', PurchaseOrderItem, 'Edm.String')

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

Static ITEM_WEIGHT_UNIT

ITEM_WEIGHT_UNIT: StringField<PurchaseOrderItem> = new StringField('ItemWeightUnit', PurchaseOrderItem, 'Edm.String')

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

Static MANUFACTURER_MATERIAL

MANUFACTURER_MATERIAL: StringField<PurchaseOrderItem> = new StringField('ManufacturerMaterial', PurchaseOrderItem, 'Edm.String')

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

Static MATERIAL

MATERIAL: StringField<PurchaseOrderItem> = new StringField('Material', PurchaseOrderItem, '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_GROUP

MATERIAL_GROUP: StringField<PurchaseOrderItem> = new StringField('MaterialGroup', PurchaseOrderItem, 'Edm.String')

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

Static MULTIPLE_ACCT_ASSGMT_DISTRIBUTION

MULTIPLE_ACCT_ASSGMT_DISTRIBUTION: StringField<PurchaseOrderItem> = new StringField('MultipleAcctAssgmtDistribution', PurchaseOrderItem, 'Edm.String')

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

Static NET_PRICE_AMOUNT

NET_PRICE_AMOUNT: BigNumberField<PurchaseOrderItem> = new BigNumberField('NetPriceAmount', PurchaseOrderItem, 'Edm.Decimal')

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

Static NET_PRICE_QUANTITY

NET_PRICE_QUANTITY: BigNumberField<PurchaseOrderItem> = new BigNumberField('NetPriceQuantity', PurchaseOrderItem, 'Edm.Decimal')

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

Static ORDER_PRICE_UNIT

ORDER_PRICE_UNIT: StringField<PurchaseOrderItem> = new StringField('OrderPriceUnit', PurchaseOrderItem, 'Edm.String')

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

Static ORDER_PRICE_UNIT_TO_ORDER_UNIT_NMRTR

ORDER_PRICE_UNIT_TO_ORDER_UNIT_NMRTR: BigNumberField<PurchaseOrderItem> = new BigNumberField('OrderPriceUnitToOrderUnitNmrtr', PurchaseOrderItem, 'Edm.Decimal')

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

Static ORDER_QUANTITY

ORDER_QUANTITY: BigNumberField<PurchaseOrderItem> = new BigNumberField('OrderQuantity', PurchaseOrderItem, 'Edm.Decimal')

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

Static ORD_PRICE_UNIT_TO_ORDER_UNIT_DNMNTR

ORD_PRICE_UNIT_TO_ORDER_UNIT_DNMNTR: BigNumberField<PurchaseOrderItem> = new BigNumberField('OrdPriceUnitToOrderUnitDnmntr', PurchaseOrderItem, 'Edm.Decimal')

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

Static OVERALL_LIMIT_AMOUNT

OVERALL_LIMIT_AMOUNT: BigNumberField<PurchaseOrderItem> = new BigNumberField('OverallLimitAmount', PurchaseOrderItem, 'Edm.Decimal')

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

Static OVERDELIV_TOLRTD_LMT_RATIO_IN_PCT

OVERDELIV_TOLRTD_LMT_RATIO_IN_PCT: BigNumberField<PurchaseOrderItem> = new BigNumberField('OverdelivTolrtdLmtRatioInPct', PurchaseOrderItem, 'Edm.Decimal')

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

Static PARTIAL_INVOICE_DISTRIBUTION

PARTIAL_INVOICE_DISTRIBUTION: StringField<PurchaseOrderItem> = new StringField('PartialInvoiceDistribution', PurchaseOrderItem, 'Edm.String')

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

Static PLANT

PLANT: StringField<PurchaseOrderItem> = new StringField('Plant', PurchaseOrderItem, '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 PRICE_IS_TO_BE_PRINTED

PRICE_IS_TO_BE_PRINTED: BooleanField<PurchaseOrderItem> = new BooleanField('PriceIsToBePrinted', PurchaseOrderItem, 'Edm.Boolean')

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

Static PRICING_DATE_CONTROL

PRICING_DATE_CONTROL: StringField<PurchaseOrderItem> = new StringField('PricingDateControl', PurchaseOrderItem, 'Edm.String')

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

Static PRODUCT_TYPE

PRODUCT_TYPE: StringField<PurchaseOrderItem> = new StringField('ProductType', PurchaseOrderItem, 'Edm.String')

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

Static PURCHASE_CONTRACT

PURCHASE_CONTRACT: StringField<PurchaseOrderItem> = new StringField('PurchaseContract', PurchaseOrderItem, 'Edm.String')

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

Static PURCHASE_CONTRACT_ITEM

PURCHASE_CONTRACT_ITEM: StringField<PurchaseOrderItem> = new StringField('PurchaseContractItem', PurchaseOrderItem, 'Edm.String')

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

Static PURCHASE_ORDER

PURCHASE_ORDER: StringField<PurchaseOrderItem> = new StringField('PurchaseOrder', PurchaseOrderItem, 'Edm.String')

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 PURCHASE_ORDER_ITEM

PURCHASE_ORDER_ITEM: StringField<PurchaseOrderItem> = new StringField('PurchaseOrderItem', PurchaseOrderItem, 'Edm.String')

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 PURCHASE_ORDER_ITEM_CATEGORY

PURCHASE_ORDER_ITEM_CATEGORY: StringField<PurchaseOrderItem> = new StringField('PurchaseOrderItemCategory', PurchaseOrderItem, 'Edm.String')

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

Static PURCHASE_ORDER_ITEM_TEXT

PURCHASE_ORDER_ITEM_TEXT: StringField<PurchaseOrderItem> = new StringField('PurchaseOrderItemText', PurchaseOrderItem, 'Edm.String')

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

Static PURCHASE_ORDER_QUANTITY_UNIT

PURCHASE_ORDER_QUANTITY_UNIT: StringField<PurchaseOrderItem> = new StringField('PurchaseOrderQuantityUnit', PurchaseOrderItem, 'Edm.String')

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

Static PURCHASE_REQUISITION

PURCHASE_REQUISITION: StringField<PurchaseOrderItem> = new StringField('PurchaseRequisition', PurchaseOrderItem, 'Edm.String')

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

Static PURCHASE_REQUISITION_ITEM

PURCHASE_REQUISITION_ITEM: StringField<PurchaseOrderItem> = new StringField('PurchaseRequisitionItem', PurchaseOrderItem, 'Edm.String')

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

Static PURCHASING_DOCUMENT_DELETION_CODE

PURCHASING_DOCUMENT_DELETION_CODE: StringField<PurchaseOrderItem> = new StringField('PurchasingDocumentDeletionCode', PurchaseOrderItem, 'Edm.String')

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

Static PURCHASING_INFO_RECORD

PURCHASING_INFO_RECORD: StringField<PurchaseOrderItem> = new StringField('PurchasingInfoRecord', PurchaseOrderItem, 'Edm.String')

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

Static PUR_CONTRACT_FOR_OVERALL_LIMIT

PUR_CONTRACT_FOR_OVERALL_LIMIT: StringField<PurchaseOrderItem> = new StringField('PurContractForOverallLimit', PurchaseOrderItem, 'Edm.String')

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

Static REQUISITIONER_NAME

REQUISITIONER_NAME: StringField<PurchaseOrderItem> = new StringField('RequisitionerName', PurchaseOrderItem, 'Edm.String')

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

Static SERVICE_PACKAGE

SERVICE_PACKAGE: StringField<PurchaseOrderItem> = new StringField('ServicePackage', PurchaseOrderItem, 'Edm.String')

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

Static SERVICE_PERFORMER

SERVICE_PERFORMER: StringField<PurchaseOrderItem> = new StringField('ServicePerformer', PurchaseOrderItem, 'Edm.String')

Static representation of the servicePerformer 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<PurchaseOrderItem> = new StringField('StorageLocation', PurchaseOrderItem, '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_CONFIRMATION_CONTROL_KEY

SUPPLIER_CONFIRMATION_CONTROL_KEY: StringField<PurchaseOrderItem> = new StringField('SupplierConfirmationControlKey', PurchaseOrderItem, 'Edm.String')

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

Static SUPPLIER_MATERIAL_NUMBER

SUPPLIER_MATERIAL_NUMBER: StringField<PurchaseOrderItem> = new StringField('SupplierMaterialNumber', PurchaseOrderItem, 'Edm.String')

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

Static TAX_CODE

TAX_CODE: StringField<PurchaseOrderItem> = new StringField('TaxCode', PurchaseOrderItem, 'Edm.String')

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

Static TAX_JURISDICTION

TAX_JURISDICTION: StringField<PurchaseOrderItem> = new StringField('TaxJurisdiction', PurchaseOrderItem, 'Edm.String')

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

Static TO_ACCOUNT_ASSIGNMENT

TO_ACCOUNT_ASSIGNMENT: Link<PurchaseOrderItem, PurOrdAccountAssignment> = new Link('to_AccountAssignment', PurchaseOrderItem, PurOrdAccountAssignment)

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

Static TO_PURCHASE_ORDER

TO_PURCHASE_ORDER: OneToOneLink<PurchaseOrderItem, PurchaseOrder> = new OneToOneLink('to_PurchaseOrder', PurchaseOrderItem, PurchaseOrder)

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

Static TO_PURCHASE_ORDER_PRICING_ELEMENT

TO_PURCHASE_ORDER_PRICING_ELEMENT: Link<PurchaseOrderItem, PurOrdPricingElement> = new Link('to_PurchaseOrderPricingElement', PurchaseOrderItem, PurOrdPricingElement)

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

Static TO_SCHEDULE_LINE

TO_SCHEDULE_LINE: Link<PurchaseOrderItem, PurchaseOrderScheduleLine> = new Link('to_ScheduleLine', PurchaseOrderItem, PurchaseOrderScheduleLine)

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

Static UNDERDELIV_TOLRTD_LMT_RATIO_IN_PCT

UNDERDELIV_TOLRTD_LMT_RATIO_IN_PCT: BigNumberField<PurchaseOrderItem> = new BigNumberField('UnderdelivTolrtdLmtRatioInPct', PurchaseOrderItem, 'Edm.Decimal')

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

Static UNLIMITED_OVERDELIVERY_IS_ALLOWED

UNLIMITED_OVERDELIVERY_IS_ALLOWED: BooleanField<PurchaseOrderItem> = new BooleanField('UnlimitedOverdeliveryIsAllowed', PurchaseOrderItem, 'Edm.Boolean')

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

Static VALUATION_TYPE

VALUATION_TYPE: StringField<PurchaseOrderItem> = new StringField('ValuationType', PurchaseOrderItem, 'Edm.String')

Static representation of the valuationType 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<PurchaseOrderItem> | BigNumberField<PurchaseOrderItem> | BooleanField<PurchaseOrderItem> | OneToOneLink<PurchaseOrderItem, PurchaseOrder> | Link<PurchaseOrderItem, PurOrdAccountAssignment> | Link<PurchaseOrderItem, PurOrdPricingElement> | Link<PurchaseOrderItem, PurchaseOrderScheduleLine>> = [PurchaseOrderItem.PURCHASE_ORDER,PurchaseOrderItem.PURCHASE_ORDER_ITEM,PurchaseOrderItem.PURCHASING_DOCUMENT_DELETION_CODE,PurchaseOrderItem.PURCHASE_ORDER_ITEM_TEXT,PurchaseOrderItem.PLANT,PurchaseOrderItem.STORAGE_LOCATION,PurchaseOrderItem.MATERIAL_GROUP,PurchaseOrderItem.PURCHASING_INFO_RECORD,PurchaseOrderItem.SUPPLIER_MATERIAL_NUMBER,PurchaseOrderItem.ORDER_QUANTITY,PurchaseOrderItem.PURCHASE_ORDER_QUANTITY_UNIT,PurchaseOrderItem.ORDER_PRICE_UNIT,PurchaseOrderItem.ORDER_PRICE_UNIT_TO_ORDER_UNIT_NMRTR,PurchaseOrderItem.ORD_PRICE_UNIT_TO_ORDER_UNIT_DNMNTR,PurchaseOrderItem.DOCUMENT_CURRENCY,PurchaseOrderItem.NET_PRICE_AMOUNT,PurchaseOrderItem.NET_PRICE_QUANTITY,PurchaseOrderItem.TAX_CODE,PurchaseOrderItem.PRICE_IS_TO_BE_PRINTED,PurchaseOrderItem.OVERDELIV_TOLRTD_LMT_RATIO_IN_PCT,PurchaseOrderItem.UNLIMITED_OVERDELIVERY_IS_ALLOWED,PurchaseOrderItem.UNDERDELIV_TOLRTD_LMT_RATIO_IN_PCT,PurchaseOrderItem.VALUATION_TYPE,PurchaseOrderItem.IS_COMPLETELY_DELIVERED,PurchaseOrderItem.IS_FINALLY_INVOICED,PurchaseOrderItem.PURCHASE_ORDER_ITEM_CATEGORY,PurchaseOrderItem.ACCOUNT_ASSIGNMENT_CATEGORY,PurchaseOrderItem.MULTIPLE_ACCT_ASSGMT_DISTRIBUTION,PurchaseOrderItem.PARTIAL_INVOICE_DISTRIBUTION,PurchaseOrderItem.GOODS_RECEIPT_IS_EXPECTED,PurchaseOrderItem.GOODS_RECEIPT_IS_NON_VALUATED,PurchaseOrderItem.INVOICE_IS_EXPECTED,PurchaseOrderItem.INVOICE_IS_GOODS_RECEIPT_BASED,PurchaseOrderItem.PURCHASE_CONTRACT,PurchaseOrderItem.PURCHASE_CONTRACT_ITEM,PurchaseOrderItem.CUSTOMER,PurchaseOrderItem.ITEM_NET_WEIGHT,PurchaseOrderItem.ITEM_WEIGHT_UNIT,PurchaseOrderItem.TAX_JURISDICTION,PurchaseOrderItem.PRICING_DATE_CONTROL,PurchaseOrderItem.ITEM_VOLUME,PurchaseOrderItem.ITEM_VOLUME_UNIT,PurchaseOrderItem.SUPPLIER_CONFIRMATION_CONTROL_KEY,PurchaseOrderItem.INCOTERMS_CLASSIFICATION,PurchaseOrderItem.INCOTERMS_TRANSFER_LOCATION,PurchaseOrderItem.EVALD_RCPT_SETTLMT_IS_ALLOWED,PurchaseOrderItem.PURCHASE_REQUISITION,PurchaseOrderItem.PURCHASE_REQUISITION_ITEM,PurchaseOrderItem.IS_RETURNS_ITEM,PurchaseOrderItem.REQUISITIONER_NAME,PurchaseOrderItem.SERVICE_PACKAGE,PurchaseOrderItem.EARMARKED_FUNDS,PurchaseOrderItem.EARMARKED_FUNDS_DOCUMENT,PurchaseOrderItem.EARMARKED_FUNDS_ITEM,PurchaseOrderItem.EARMARKED_FUNDS_DOCUMENT_ITEM,PurchaseOrderItem.INCOTERMS_LOCATION_1,PurchaseOrderItem.INCOTERMS_LOCATION_2,PurchaseOrderItem.MATERIAL,PurchaseOrderItem.INTERNATIONAL_ARTICLE_NUMBER,PurchaseOrderItem.MANUFACTURER_MATERIAL,PurchaseOrderItem.SERVICE_PERFORMER,PurchaseOrderItem.PRODUCT_TYPE,PurchaseOrderItem.EXPECTED_OVERALL_LIMIT_AMOUNT,PurchaseOrderItem.OVERALL_LIMIT_AMOUNT,PurchaseOrderItem.PUR_CONTRACT_FOR_OVERALL_LIMIT,PurchaseOrderItem.DELIVERY_ADDRESS_ID,PurchaseOrderItem.DELIVERY_ADDRESS_NAME,PurchaseOrderItem.DELIVERY_ADDRESS_STREET_NAME,PurchaseOrderItem.DELIVERY_ADDRESS_HOUSE_NUMBER,PurchaseOrderItem.DELIVERY_ADDRESS_CITY_NAME,PurchaseOrderItem.DELIVERY_ADDRESS_POSTAL_CODE,PurchaseOrderItem.DELIVERY_ADDRESS_REGION,PurchaseOrderItem.DELIVERY_ADDRESS_COUNTRY,PurchaseOrderItem.BR_MATERIAL_USAGE,PurchaseOrderItem.BR_MATERIAL_ORIGIN,PurchaseOrderItem.BR_CFOP_CATEGORY,PurchaseOrderItem.BR_IS_PRODUCED_IN_HOUSE,PurchaseOrderItem.CONSUMPTION_TAX_CTRL_CODE,PurchaseOrderItem.TO_PURCHASE_ORDER,PurchaseOrderItem.TO_ACCOUNT_ASSIGNMENT,PurchaseOrderItem.TO_PURCHASE_ORDER_PRICING_ELEMENT,PurchaseOrderItem.TO_SCHEDULE_LINE]

All fields of the PurchaseOrderItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PurchaseOrderItem"

Technical entity name for PurchaseOrderItem.

Static _keyFields

_keyFields: Array<Selectable<PurchaseOrderItem>> = [PurchaseOrderItem.PURCHASE_ORDER, PurchaseOrderItem.PURCHASE_ORDER_ITEM]

All key fields of the PurchaseOrderItem entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PURCHASEORDER_PROCESS_SRV"
deprecated

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

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

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

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 PurchaseOrderItem.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurchaseOrderItem>

    A builder that constructs instances of entity type PurchaseOrderItem.

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 PurchaseOrderItem entity type.

    Returns PurchaseOrderItemRequestBuilder

    A PurchaseOrderItem request builder.