Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • PurchaseContractItem

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns PurchaseContractItem

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 contractNetPriceAmount

contractNetPriceAmount: BigNumber

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

nullable

Optional documentCurrency

documentCurrency: undefined | string

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

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 formattedPurchaseContractItem

formattedPurchaseContractItem: undefined | string

Formatted Purchase Contract Item. Maximum length: 15.

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 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 isInfoRecordUpdated

isInfoRecordUpdated: undefined | string

Indicator: Update Info Record. Determines whether: The purchasing info record for this supplier and material is to refer to this PO item, andThe item is to be valid for the entire purchasing organization or just for the plant.The indicator determines which prices and conditions are suggested in future PO items.Prices and conditions can apply to an entire purchasing organization or to a single plant within a purchasing organization.For example, if you create a purchase order for a plant for which an info record has been defined at plant level, the purchase order is based on the conditions in the plant info record and not on the conditions that apply to the purchasing organization.Enter the relevant plant key:AUpdating of the document number is effected at plant level as long as there is a purchasing info record at plant level. Otherwise the document number is updated at purchasing organization level.BUpdating is effected at plant level if plant conditions are allowed for the plant.CUpdating is effected without plant data if plant conditions are not necessary for the plant.The level at which updating of the document number may be effected is defined for each plant. Maximum length: 1.

nullable

Optional isOrderAcknRqd

isOrderAcknRqd: undefined | false | true

Order Acknowledgment Requirement. Determines whether the purchasing document (purchase order, outline purchase agreement, etc.) is to be acknowledged by the supplier.

nullable

Optional manualDeliveryAddressId

manualDeliveryAddressId: undefined | string

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

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 materialType

materialType: undefined | string

Material Type. Key that assigns the material to a group of materials such as raw materials, operating supplies or trading goods. The material type defines certain attributes of the material and has important control functions. Maximum length: 4.

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 netPriceQuantity

netPriceQuantity: BigNumber

Price Unit.

nullable

Optional noDaysReminder1

noDaysReminder1: BigNumber

Number of Days for First Reminder/Expediter. Number of days representing the time interval at which reminders or urging letters/messages (may also be termed "chasers", "hasteners" (UK) or "expediters" (USA)) are to be issued to the supplier. A negative number of days means that a reminder is to be issued to the supplier n days prior to a certain date (for example, the delivery date or the deadline for submission of quotations).A positive number of days means that a letter or message urging delivery or submission of a quotation etc. is to be issued n days after the due date.In the case of purchasing documents, the time intervals are defaulted from the purchasing info record or, if one does not exist, from the material master record.The basis for the reminder intervals is the delivery date or deadline for submission of quotations etc.In the event of several reminder levels, the days must be set out in ascending order of time, without gaps.In the event of a delay in delivery, you can send messages urging the supplier to deliver ordered materials a total of three times, at intervals of 10 days:Reminder 1: 10 days (after delivery date)Reminder 2: 20 days ( " " " )Reminder 3: 30 days ( " " " ).

nullable

Optional noDaysReminder2

noDaysReminder2: BigNumber

Number of Days for Second Reminder/Expediter. Number of days representing the time interval at which reminders or urging letters/messages (may also be termed "chasers", "hasteners" (UK) or "expediters" (USA)) are to be issued to the supplier. A negative number of days means that a reminder is to be issued to the supplier n days prior to a certain date (for example, the delivery date or the deadline for submission of quotations).A positive number of days means that a letter or message urging delivery or submission of a quotation etc. is to be issued n days after the due date.In the case of purchasing documents, the time intervals are defaulted from the purchasing info record or, if one does not exist, from the material master record.The basis for the reminder intervals is the delivery date or deadline for submission of quotations etc.In the event of several reminder levels, the days must be set out in ascending order of time, without gaps.In the event of a delay in delivery, you can send messages urging the supplier to deliver ordered materials a total of three times, at intervals of 10 days:Reminder 1: 10 days (after delivery date)Reminder 2: 20 days ( " " " )Reminder 3: 30 days ( " " " ).

nullable

Optional noDaysReminder3

noDaysReminder3: BigNumber

Number of Days for Third Reminder/Expediter. Number of days representing the time interval at which reminders or urging letters/messages (may also be termed "chasers", "hasteners" (UK) or "expediters" (USA)) are to be issued to the supplier. A negative number of days means that a reminder is to be issued to the supplier n days prior to a certain date (for example, the delivery date or the deadline for submission of quotations).A positive number of days means that a letter or message urging delivery or submission of a quotation etc. is to be issued n days after the due date.In the case of purchasing documents, the time intervals are defaulted from the purchasing info record or, if one does not exist, from the material master record.The basis for the reminder intervals is the delivery date or deadline for submission of quotations etc.In the event of several reminder levels, the days must be set out in ascending order of time, without gaps.In the event of a delay in delivery, you can send messages urging the supplier to deliver ordered materials a total of three times, at intervals of 10 days:Reminder 1: 10 days (after delivery date)Reminder 2: 20 days ( " " " )Reminder 3: 30 days ( " " " ).

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.

nullable

Optional orderQuantityUnit

orderQuantityUnit: undefined | string

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

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

purchaseContract

purchaseContract: string

Purchasing Contract Header. Maximum length: 10.

purchaseContractItem

purchaseContractItem: string

Item Number of Purchasing Contract. Maximum length: 5.

Optional purchaseContractItemText

purchaseContractItemText: undefined | string

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

nullable

Optional purchasingContractDeletionCode

purchasingContractDeletionCode: 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 purchasingDocumentItemCategory

purchasingDocumentItemCategory: 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 purgDocEstimatedPrice

purgDocEstimatedPrice: undefined | false | true

Indicator: Estimated Price. Indicates that this net price is merely an estimated price. If you do not know the exact net price of a material, you can indicate that the price is an estimated price. In consequence, a greater price variance is tolerated during invoice verification than would be the case in the event of an exact net price.

nullable

Optional purgDocOrderAcknNumber

purgDocOrderAcknNumber: undefined | string

Order Acknowledgment Number. Number of the supplier's order acknowledgment. If you work exclusively with order acknowledgments and the supplier sends you one, enter an identifier defined within your firm (e.g. number assigned to incoming mail or date of receipt).NoteIf you work with several confirmation categories and a confirmation control key, you enter the confirmation data in the confirmation overview. This field is then for information only. Maximum length: 20.

nullable

Optional purgDocReleaseOrderQuantity

purgDocReleaseOrderQuantity: BigNumber

Standard release order quantity. Total quantity normally released against the contract in the purchase order. This is the quantity that is taken as a basis in the process of price determination.

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 requirementTracking

requirementTracking: undefined | string

Requirement Tracking Number. Number that facilitates the monitoring of the procurement of required materials or services. This number can relate to a requisition note (or requirement notice/slip) that was not generated in the system. The requirement tracking number from the purchase requisition is copied to the purchasing documents (for example: RFQ or purchase order) created with reference to a purchase requisition.The requirement tracking number thus enables you to group together the purchasing documents that exist for a certain material requirement. Maximum length: 10.

nullable

Optional servicePerformer

servicePerformer: undefined | string

Service Performer. Maximum length: 10.

nullable

Optional shippingInstruction

shippingInstruction: undefined | string

Shipping Instructions. Specifies the packaging and shipping instructions issued to the supplier. Enter the key for the relevant shipping instructions. Maximum length: 2.

nullable

Optional stockType

stockType: undefined | string

Stock Type. Specifies the stock to which the material is posted upon goods receipt (or from which it is posted upon goods issue). If the material is subject to quality inspection, a goods receipt is posted to stock in quality inspection. Maximum length: 1.

nullable

Optional storageLocation

storageLocation: undefined | string

Storage Location. Maximum length: 4.

nullable

Optional subcontractor

subcontractor: undefined | string

Supplier to be Supplied/Who is to Receive Delivery. Maximum length: 10.

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 targetQuantity

targetQuantity: BigNumber

Target Quantity. Total quantity, agreed with the supplier, that can be released or scheduled against the relevant agreement (contract or scheduling agreement).

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

toPurContrItemCondition

toPurContrItemCondition: PurContrItemCondition[]

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

toPurCtrAccount

toPurCtrAccount: PurCtrAccount[]

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

toPurCtrAddress

toPurCtrAddress: PurCtrAddress[]

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

toPurchaseContract

toPurchaseContract: PurchaseContract

One-to-one navigation property to the PurchaseContract 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 volumeUnit

volumeUnit: 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

Static ACCOUNT_ASSIGNMENT_CATEGORY

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

All fields selector.

Static CONTRACT_NET_PRICE_AMOUNT

CONTRACT_NET_PRICE_AMOUNT: BigNumberField<PurchaseContractItem> = new BigNumberField('ContractNetPriceAmount', PurchaseContractItem, 'Edm.Decimal')

Static representation of the contractNetPriceAmount 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<PurchaseContractItem> = new StringField('DocumentCurrency', PurchaseContractItem, '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 EVALD_RCPT_SETTLMT_IS_ALLOWED

EVALD_RCPT_SETTLMT_IS_ALLOWED: BooleanField<PurchaseContractItem> = new BooleanField('EvaldRcptSettlmtIsAllowed', PurchaseContractItem, '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 FORMATTED_PURCHASE_CONTRACT_ITEM

FORMATTED_PURCHASE_CONTRACT_ITEM: StringField<PurchaseContractItem> = new StringField('FormattedPurchaseContractItem', PurchaseContractItem, 'Edm.String')

Static representation of the formattedPurchaseContractItem 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<PurchaseContractItem> = new BooleanField('GoodsReceiptIsExpected', PurchaseContractItem, '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<PurchaseContractItem> = new BooleanField('GoodsReceiptIsNonValuated', PurchaseContractItem, '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 INVOICE_IS_EXPECTED

INVOICE_IS_EXPECTED: BooleanField<PurchaseContractItem> = new BooleanField('InvoiceIsExpected', PurchaseContractItem, '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<PurchaseContractItem> = new BooleanField('InvoiceIsGoodsReceiptBased', PurchaseContractItem, '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_INFO_RECORD_UPDATED

IS_INFO_RECORD_UPDATED: StringField<PurchaseContractItem> = new StringField('IsInfoRecordUpdated', PurchaseContractItem, 'Edm.String')

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

Static IS_ORDER_ACKN_RQD

IS_ORDER_ACKN_RQD: BooleanField<PurchaseContractItem> = new BooleanField('IsOrderAcknRqd', PurchaseContractItem, 'Edm.Boolean')

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

Static MANUAL_DELIVERY_ADDRESS_ID

MANUAL_DELIVERY_ADDRESS_ID: StringField<PurchaseContractItem> = new StringField('ManualDeliveryAddressID', PurchaseContractItem, 'Edm.String')

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

Static MATERIAL

MATERIAL: StringField<PurchaseContractItem> = new StringField('Material', PurchaseContractItem, '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<PurchaseContractItem> = new StringField('MaterialGroup', PurchaseContractItem, '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 MATERIAL_TYPE

MATERIAL_TYPE: StringField<PurchaseContractItem> = new StringField('MaterialType', PurchaseContractItem, 'Edm.String')

Static representation of the materialType 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<PurchaseContractItem> = new StringField('MultipleAcctAssgmtDistribution', PurchaseContractItem, '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_QUANTITY

NET_PRICE_QUANTITY: BigNumberField<PurchaseContractItem> = new BigNumberField('NetPriceQuantity', PurchaseContractItem, '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 NO_DAYS_REMINDER_1

NO_DAYS_REMINDER_1: BigNumberField<PurchaseContractItem> = new BigNumberField('NoDaysReminder1', PurchaseContractItem, 'Edm.Decimal')

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

Static NO_DAYS_REMINDER_2

NO_DAYS_REMINDER_2: BigNumberField<PurchaseContractItem> = new BigNumberField('NoDaysReminder2', PurchaseContractItem, 'Edm.Decimal')

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

Static NO_DAYS_REMINDER_3

NO_DAYS_REMINDER_3: BigNumberField<PurchaseContractItem> = new BigNumberField('NoDaysReminder3', PurchaseContractItem, 'Edm.Decimal')

Static representation of the noDaysReminder3 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<PurchaseContractItem> = new StringField('OrderPriceUnit', PurchaseContractItem, '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<PurchaseContractItem> = new BigNumberField('OrderPriceUnitToOrderUnitNmrtr', PurchaseContractItem, '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_UNIT

ORDER_QUANTITY_UNIT: StringField<PurchaseContractItem> = new StringField('OrderQuantityUnit', PurchaseContractItem, 'Edm.String')

Static representation of the orderQuantityUnit 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<PurchaseContractItem> = new BigNumberField('OrdPriceUnitToOrderUnitDnmntr', PurchaseContractItem, '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 OVERDELIV_TOLRTD_LMT_RATIO_IN_PCT

OVERDELIV_TOLRTD_LMT_RATIO_IN_PCT: BigNumberField<PurchaseContractItem> = new BigNumberField('OverdelivTolrtdLmtRatioInPct', PurchaseContractItem, '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 PLANT

PLANT: StringField<PurchaseContractItem> = new StringField('Plant', PurchaseContractItem, '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<PurchaseContractItem> = new BooleanField('PriceIsToBePrinted', PurchaseContractItem, '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 PRODUCT_TYPE

PRODUCT_TYPE: StringField<PurchaseContractItem> = new StringField('ProductType', PurchaseContractItem, '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<PurchaseContractItem> = new StringField('PurchaseContract', PurchaseContractItem, '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<PurchaseContractItem> = new StringField('PurchaseContractItem', PurchaseContractItem, '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_CONTRACT_ITEM_TEXT

PURCHASE_CONTRACT_ITEM_TEXT: StringField<PurchaseContractItem> = new StringField('PurchaseContractItemText', PurchaseContractItem, 'Edm.String')

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

Static PURCHASING_CONTRACT_DELETION_CODE

PURCHASING_CONTRACT_DELETION_CODE: StringField<PurchaseContractItem> = new StringField('PurchasingContractDeletionCode', PurchaseContractItem, 'Edm.String')

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

Static PURCHASING_DOCUMENT_ITEM_CATEGORY

PURCHASING_DOCUMENT_ITEM_CATEGORY: StringField<PurchaseContractItem> = new StringField('PurchasingDocumentItemCategory', PurchaseContractItem, 'Edm.String')

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

Static PURG_DOC_ESTIMATED_PRICE

PURG_DOC_ESTIMATED_PRICE: BooleanField<PurchaseContractItem> = new BooleanField('PurgDocEstimatedPrice', PurchaseContractItem, 'Edm.Boolean')

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

Static PURG_DOC_ORDER_ACKN_NUMBER

PURG_DOC_ORDER_ACKN_NUMBER: StringField<PurchaseContractItem> = new StringField('PurgDocOrderAcknNumber', PurchaseContractItem, 'Edm.String')

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

Static PURG_DOC_RELEASE_ORDER_QUANTITY

PURG_DOC_RELEASE_ORDER_QUANTITY: BigNumberField<PurchaseContractItem> = new BigNumberField('PurgDocReleaseOrderQuantity', PurchaseContractItem, 'Edm.Decimal')

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

Static REQUIREMENT_TRACKING

REQUIREMENT_TRACKING: StringField<PurchaseContractItem> = new StringField('RequirementTracking', PurchaseContractItem, 'Edm.String')

Static representation of the requirementTracking 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<PurchaseContractItem> = new StringField('ServicePerformer', PurchaseContractItem, '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 SHIPPING_INSTRUCTION

SHIPPING_INSTRUCTION: StringField<PurchaseContractItem> = new StringField('ShippingInstruction', PurchaseContractItem, 'Edm.String')

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

Static STOCK_TYPE

STOCK_TYPE: StringField<PurchaseContractItem> = new StringField('StockType', PurchaseContractItem, 'Edm.String')

Static representation of the stockType 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<PurchaseContractItem> = new StringField('StorageLocation', PurchaseContractItem, '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 SUBCONTRACTOR

SUBCONTRACTOR: StringField<PurchaseContractItem> = new StringField('Subcontractor', PurchaseContractItem, 'Edm.String')

Static representation of the subcontractor 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<PurchaseContractItem> = new StringField('SupplierMaterialNumber', PurchaseContractItem, '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 TARGET_QUANTITY

TARGET_QUANTITY: BigNumberField<PurchaseContractItem> = new BigNumberField('TargetQuantity', PurchaseContractItem, 'Edm.Decimal')

Static representation of the targetQuantity 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<PurchaseContractItem> = new StringField('TaxCode', PurchaseContractItem, '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 TO_PURCHASE_CONTRACT

TO_PURCHASE_CONTRACT: OneToOneLink<PurchaseContractItem, PurchaseContract> = new OneToOneLink('to_PurchaseContract', PurchaseContractItem, PurchaseContract)

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

Static TO_PUR_CONTR_ITEM_CONDITION

TO_PUR_CONTR_ITEM_CONDITION: Link<PurchaseContractItem, PurContrItemCondition> = new Link('to_PurContrItemCondition', PurchaseContractItem, PurContrItemCondition)

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

Static TO_PUR_CTR_ACCOUNT

TO_PUR_CTR_ACCOUNT: Link<PurchaseContractItem, PurCtrAccount> = new Link('to_PurCtrAccount', PurchaseContractItem, PurCtrAccount)

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

Static TO_PUR_CTR_ADDRESS

TO_PUR_CTR_ADDRESS: Link<PurchaseContractItem, PurCtrAddress> = new Link('to_PurCtrAddress', PurchaseContractItem, PurCtrAddress)

Static representation of the one-to-many navigation property toPurCtrAddress 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<PurchaseContractItem> = new BigNumberField('UnderdelivTolrtdLmtRatioInPct', PurchaseContractItem, '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<PurchaseContractItem> = new BooleanField('UnlimitedOverdeliveryIsAllowed', PurchaseContractItem, '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 VOLUME_UNIT

VOLUME_UNIT: StringField<PurchaseContractItem> = new StringField('VolumeUnit', PurchaseContractItem, 'Edm.String')

Static representation of the volumeUnit 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<PurchaseContractItem> | BigNumberField<PurchaseContractItem> | BooleanField<PurchaseContractItem> | OneToOneLink<PurchaseContractItem, PurchaseContract> | Link<PurchaseContractItem, PurContrItemCondition> | Link<PurchaseContractItem, PurCtrAccount> | Link<PurchaseContractItem, PurCtrAddress>> = [PurchaseContractItem.PURCHASE_CONTRACT,PurchaseContractItem.PURCHASE_CONTRACT_ITEM,PurchaseContractItem.PURCHASING_CONTRACT_DELETION_CODE,PurchaseContractItem.PURCHASE_CONTRACT_ITEM_TEXT,PurchaseContractItem.PLANT,PurchaseContractItem.STORAGE_LOCATION,PurchaseContractItem.REQUIREMENT_TRACKING,PurchaseContractItem.MATERIAL_GROUP,PurchaseContractItem.SUPPLIER_MATERIAL_NUMBER,PurchaseContractItem.ORDER_QUANTITY_UNIT,PurchaseContractItem.TARGET_QUANTITY,PurchaseContractItem.PURG_DOC_RELEASE_ORDER_QUANTITY,PurchaseContractItem.ORDER_PRICE_UNIT,PurchaseContractItem.ORDER_PRICE_UNIT_TO_ORDER_UNIT_NMRTR,PurchaseContractItem.ORD_PRICE_UNIT_TO_ORDER_UNIT_DNMNTR,PurchaseContractItem.CONTRACT_NET_PRICE_AMOUNT,PurchaseContractItem.DOCUMENT_CURRENCY,PurchaseContractItem.NET_PRICE_QUANTITY,PurchaseContractItem.TAX_CODE,PurchaseContractItem.STOCK_TYPE,PurchaseContractItem.IS_INFO_RECORD_UPDATED,PurchaseContractItem.PRICE_IS_TO_BE_PRINTED,PurchaseContractItem.PURG_DOC_ESTIMATED_PRICE,PurchaseContractItem.NO_DAYS_REMINDER_1,PurchaseContractItem.NO_DAYS_REMINDER_2,PurchaseContractItem.NO_DAYS_REMINDER_3,PurchaseContractItem.OVERDELIV_TOLRTD_LMT_RATIO_IN_PCT,PurchaseContractItem.UNLIMITED_OVERDELIVERY_IS_ALLOWED,PurchaseContractItem.UNDERDELIV_TOLRTD_LMT_RATIO_IN_PCT,PurchaseContractItem.PURCHASING_DOCUMENT_ITEM_CATEGORY,PurchaseContractItem.ACCOUNT_ASSIGNMENT_CATEGORY,PurchaseContractItem.MULTIPLE_ACCT_ASSGMT_DISTRIBUTION,PurchaseContractItem.GOODS_RECEIPT_IS_EXPECTED,PurchaseContractItem.GOODS_RECEIPT_IS_NON_VALUATED,PurchaseContractItem.INVOICE_IS_EXPECTED,PurchaseContractItem.INVOICE_IS_GOODS_RECEIPT_BASED,PurchaseContractItem.IS_ORDER_ACKN_RQD,PurchaseContractItem.PURG_DOC_ORDER_ACKN_NUMBER,PurchaseContractItem.SHIPPING_INSTRUCTION,PurchaseContractItem.MANUAL_DELIVERY_ADDRESS_ID,PurchaseContractItem.VOLUME_UNIT,PurchaseContractItem.SUBCONTRACTOR,PurchaseContractItem.EVALD_RCPT_SETTLMT_IS_ALLOWED,PurchaseContractItem.MATERIAL,PurchaseContractItem.SERVICE_PERFORMER,PurchaseContractItem.PRODUCT_TYPE,PurchaseContractItem.MATERIAL_TYPE,PurchaseContractItem.FORMATTED_PURCHASE_CONTRACT_ITEM,PurchaseContractItem.TO_PURCHASE_CONTRACT,PurchaseContractItem.TO_PUR_CONTR_ITEM_CONDITION,PurchaseContractItem.TO_PUR_CTR_ACCOUNT,PurchaseContractItem.TO_PUR_CTR_ADDRESS]

All fields of the PurchaseContractItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PurchaseContractItem"

Technical entity name for PurchaseContractItem.

Static _keyFields

_keyFields: Array<Selectable<PurchaseContractItem>> = [PurchaseContractItem.PURCHASE_CONTRACT, PurchaseContractItem.PURCHASE_CONTRACT_ITEM]

All key fields of the PurchaseContractItem entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PURCHASECONTRACT_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurchaseContractItem>

    A builder that constructs instances of entity type PurchaseContractItem.

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

    Returns PurchaseContractItemRequestBuilder

    A PurchaseContractItem request builder.