Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PurchaseOrder" 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
    • PurchaseOrder

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns PurchaseOrder

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 addressCityName

addressCityName: 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 addressCorrespondenceLanguage

addressCorrespondenceLanguage: undefined | string

Language Key. The language key indicates

  • the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts. Maximum length: 2.
nullable

Optional addressCountry

addressCountry: 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 addressFaxNumber

addressFaxNumber: undefined | string

First fax no.: dialling code+number. Fax number, consisting of dialing code and number, but without country dialing code. If the fax number consists of a company number and an extension, the extension must be entered in the field extension.Fax number, as it is to be dialed from within the same country.Enter the fax number.The following rules apply for the format of telephone and fax numbers:The length of the entries in the field Telephone and Extension (Fax and Extension) cannot be more than 24 characters in total.Leading spaces are not allowed in the field Telephone or Fax or in the field Extension.Valid characters are:Numbers (0123456789)Letters (ABCDEFGHIJKLMNOPQRSTUVWXYZ)Following other characters: /, (, ), - *, # and " " (space), but not as a leading space.If an + is entered as the first character, the system checks whether the specified number starts with a country code. If so, a warning message is displayed because the country code is automatically determined by the system and should not be stored in the Telephone number (Fax number) field.If an & is entered as the first character, the automatic check and formatting of the telephone number (fax number), as well as the determination of the country code, is suppressed.Enter the following for the number "01234/567-0":Fax: 01234/567Extension: 0Enter the following for the number "01234/567-891":Fax: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Fax: 012-345Extension: 678In the following cases, enter the complete number (without country dialing code) in the field Fax:No part of the number can be considered as an extension.You are not sure which part of the number can be considered as an extension.If the address has several fax numbers, the first fax number is flagged as the standard fax number. Maximum length: 30.

nullable

Optional addressHouseNumber

addressHouseNumber: 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 addressName

addressName: undefined | string

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

nullable

Optional addressPhoneNumber

addressPhoneNumber: undefined | string

First telephone no.: dialling code+number. Telephone numbmer, consisting of dialing code and number, but without the country code. If the telephone number consists of a company number and an extension, the extension must be entered in the field extension.Telephone number, as it must be dialed from within the country. Maximum length: 30.

nullable

Optional addressPostalCode

addressPostalCode: 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 addressRegion

addressRegion: 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 addressStreetName

addressStreetName: 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 cashDiscount1Days

cashDiscount1Days: BigNumber

Cash discount days 1. Period within which a payment must be made in order to take advantage of the first cash discount terms.

nullable

Optional cashDiscount1Percent

cashDiscount1Percent: BigNumber

Cash discount percentage 1. Cash discount percentage rate applied to the shortest payment period.

nullable

Optional cashDiscount2Days

cashDiscount2Days: BigNumber

Cash discount days 2. Period within which a payment must be made in order to take advantage of the second cash discount terms.

nullable

Optional cashDiscount2Percent

cashDiscount2Percent: BigNumber

Cash Discount Percentage 2. Cash discount percentage rate applied to the second payment period.

nullable

Optional companyCode

companyCode: undefined | string

Company Code. The company code is an organizational unit within financial accounting. Maximum length: 4.

nullable

Optional correspncExternalReference

correspncExternalReference: undefined | string

Your Reference. The internal reference number of the customer or supplier. The reference number usually identifies the individual who is responsible for the document at the customer or supplier site. It can, for example, be the person's initials. Maximum length: 12.

nullable

Optional correspncInternalReference

correspncInternalReference: undefined | string

Our Reference. Your company's internal reference number or code. This usually identifies the person responsible for the purchasing document in your company. The reference number/code often consists of the relevant person's initials. Maximum length: 12.

nullable

Optional createdByUser

createdByUser: undefined | string

Name of Person Who Created Object. Maximum length: 12.

nullable

Optional creationDate

creationDate: Moment

Date on Which Record Was Created.

nullable

Optional documentCurrency

documentCurrency: undefined | string

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

nullable

Optional exchangeRate

exchangeRate: undefined | string

Exchange Rate. Maximum length: 12.

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 incotermsVersion

incotermsVersion: undefined | string

Incoterms Version. An incoterms version is an edition containing a list of international terms for transportation that is defined by the International Chamber of Commerce (ICC). Maximum length: 4.

nullable

Optional invoicingParty

invoicingParty: undefined | string

Different Invoicing Party. Alphanumeric key uniquely identifying the document. This number denotes the supplier (creditor) invoicing the ordered material or services performed, to whom the amount due is payable.When the invoice is received, the number of the invoicing party is inserted in the invoice in place of the actual supplier. Maximum length: 10.

nullable

Optional isEndOfPurposeBlocked

isEndOfPurposeBlocked: undefined | string

Business Purpose Completed. Indicates whether the end of purpose (EoP) has been reached. The EoP is the point in time for a data set when the processing of personal data is no longer required for the primary business purpose. After the EoP has been reached, the data is blocked and can only be accessed by users with special authorization. Maximum length: 1.

nullable

Optional language

language: undefined | string

Language Key. The language key indicates

  • the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts. Maximum length: 2.
nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

Change Time Stamp.

nullable

Optional manualSupplierAddressId

manualSupplierAddressId: undefined | string

Address Number. Internal key for identifying a Business Address Services address. For more information about the meaning and use of the address number and the Business Address Services concepts, see the function group SZA0 documentation. Maximum length: 10.

nullable

Optional netPaymentDays

netPaymentDays: BigNumber

Net Payment Terms Period. Standard settlement period (in days).

nullable

Optional paymentTerms

paymentTerms: undefined | string

Terms of Payment Key. Key for defining payment terms composed of cash discount percentages and payment periods. It is used in sales orders, purchase orders, and invoices. Terms of payment provide information for:Cash managementDunning proceduresPayment transactionsData can be entered in the field for the terms of payment key in various ways as you enter a business transaction:In most business transactions, the system defaults the key specified in the master record of the customer/vendor in question.In some transactions (for example, credit memos), however, the system does not default the key from the master record. Despite this, you can use the key from the customer/vendor master record by entering "*" in the field.Regardless of whether or not a key is defaulted from the master record, you can manually enter a key during document entry at:item level in sales ordersheader level in purchase orders and invoicesMaster records have separate areas for Financial Accounting, Sales, and Purchasing. You can specify different terms of payment keys in each of these areas. When you then enter a business transaction, the application in question will use the key specified in its area of the master record. Maximum length: 4.

nullable

purchaseOrder

purchaseOrder: string

Purchase Order Number. Maximum length: 10.

Optional purchaseOrderDate

purchaseOrderDate: Moment

Purchase Order Date. Specifies the date on which the purchase order was created.

nullable

Optional purchaseOrderSubtype

purchaseOrderSubtype: undefined | string

Control indicator for purchasing document type. Allows differentiation between the various kinds of purchasing document. On the basis of the purchasing document type you can, for example, distinguish between a standard purchase order and a stock transport order, although both documents belong to the purchasing document category purchase requisition.The purchasing document type controls, for instance, the number assignment for a purchase order, as well as the fields to be maintained. Maximum length: 1.

nullable

Optional purchaseOrderType

purchaseOrderType: undefined | string

Purchasing Document Type. Identifier allowing differentiation between the various kinds of purchasing document in the SAP system. On the basis of the purchasing document type, you can, for example, distinguish between a purchase order, an RFQ and a scheduling agreement.The purchasing document type controls, for instance, the number assignment of a purchase order, as well as the selection of the fields to be maintained. Maximum length: 4.

nullable

Optional purchasingCompletenessStatus

purchasingCompletenessStatus: undefined | false | true

Purchase order not yet complete. You can use the Hold function to store faulty or incomplete purchase orders in the SAP System. You can then continue processing or complete these POs that you have put "on hold" in this way at some later date.A PO that is on hold is not transmitted to the supplier. It is, however, MRP-relevant.The following functions are not not possible in the case of a PO that is on hold:Message output (printing or transmission of documents in message form)Posting a goods receiptPosting an invoiceNote:If a PO has been saved, it cannot later be processed using the Hold function.

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 purchasingDocumentOrigin

purchasingDocumentOrigin: undefined | string

Status of Purchasing Document. Key specifying whether a quotation has been received in respect of an RFQ. Maximum length: 1.

nullable

Optional purchasingGroup

purchasingGroup: undefined | string

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

nullable

Optional purchasingOrganization

purchasingOrganization: undefined | string

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

nullable

Optional purchasingProcessingStatus

purchasingProcessingStatus: undefined | string

Purchasing document processing state. Maximum length: 2.

nullable

Optional releaseIsNotCompleted

releaseIsNotCompleted: undefined | false | true

Release Not Yet Completely Effected. Specifies that the release (approval) process for the purchasing document has not yet been completed.

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 supplier

supplier: undefined | string

Supplier. Maximum length: 10.

nullable

Optional supplierPhoneNumber

supplierPhoneNumber: undefined | string

Supplier's Telephone Number. This entry is for information only. It is not copied into purchasing documents. Maximum length: 16.

nullable

Optional supplierQuotationExternalId

supplierQuotationExternalId: undefined | string

Quotation Number. Number of supplier's quotation. Maximum length: 10.

nullable

Optional supplierRespSalesPersonName

supplierRespSalesPersonName: undefined | string

Responsible Salesperson at Supplier's Office. Maximum length: 30.

nullable

Optional supplyingPlant

supplyingPlant: undefined | string

Supplying (issuing) plant in case of stock transport order. Describes the plant from which the ordered material is supplied. The supplying, or issuing, plant is only entered in the case of stock transport orders. Maximum length: 4.

nullable

Optional supplyingSupplier

supplyingSupplier: undefined | string

Goods Supplier. Key identifying the supplier within the SAP system. If the supplier from whom the goods are ordered is not the actual goods supplier, you can enter the account number of the goods supplying business partner here. Maximum length: 10.

nullable

toPurchaseOrderItem

toPurchaseOrderItem: PurchaseOrderItem[]

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

Optional validityEndDate

validityEndDate: Moment

End of Validity Period. Date up to which services can be performed or materials delivered. In the case of outline agreements:End of the stipulated validity period of the agreement.In the case of RFQs:End of the period in which the quotation is to be submitted.In the case of POs:End of the period in which the service is to be performed or the material delivered.NoteNo further service entry sheets can be created after this date.

nullable

Optional validityStartDate

validityStartDate: Moment

Start of Validity Period. Date as of which services can be performed or materials delivered. In the case of outline agreements:Start of the stipulated validity period of an outline agreement.In the case of RFQs:Start of the period in which the quotation is to be submitted.In the case of purchase orders:Start of the period in which the service is to be performed or the material delivered.NoteService entry sheets can only be created within the specified period.

nullable

Static ADDRESS_CITY_NAME

ADDRESS_CITY_NAME: StringField<PurchaseOrder> = new StringField('AddressCityName', PurchaseOrder, 'Edm.String')

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

Static ADDRESS_CORRESPONDENCE_LANGUAGE

ADDRESS_CORRESPONDENCE_LANGUAGE: StringField<PurchaseOrder> = new StringField('AddressCorrespondenceLanguage', PurchaseOrder, 'Edm.String')

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

Static ADDRESS_COUNTRY

ADDRESS_COUNTRY: StringField<PurchaseOrder> = new StringField('AddressCountry', PurchaseOrder, 'Edm.String')

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

Static ADDRESS_FAX_NUMBER

ADDRESS_FAX_NUMBER: StringField<PurchaseOrder> = new StringField('AddressFaxNumber', PurchaseOrder, 'Edm.String')

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

Static ADDRESS_HOUSE_NUMBER

ADDRESS_HOUSE_NUMBER: StringField<PurchaseOrder> = new StringField('AddressHouseNumber', PurchaseOrder, 'Edm.String')

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

Static ADDRESS_NAME

ADDRESS_NAME: StringField<PurchaseOrder> = new StringField('AddressName', PurchaseOrder, 'Edm.String')

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

Static ADDRESS_PHONE_NUMBER

ADDRESS_PHONE_NUMBER: StringField<PurchaseOrder> = new StringField('AddressPhoneNumber', PurchaseOrder, 'Edm.String')

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

Static ADDRESS_POSTAL_CODE

ADDRESS_POSTAL_CODE: StringField<PurchaseOrder> = new StringField('AddressPostalCode', PurchaseOrder, 'Edm.String')

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

Static ADDRESS_REGION

ADDRESS_REGION: StringField<PurchaseOrder> = new StringField('AddressRegion', PurchaseOrder, 'Edm.String')

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

Static ADDRESS_STREET_NAME

ADDRESS_STREET_NAME: StringField<PurchaseOrder> = new StringField('AddressStreetName', PurchaseOrder, 'Edm.String')

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

All fields selector.

Static CASH_DISCOUNT_1_DAYS

CASH_DISCOUNT_1_DAYS: BigNumberField<PurchaseOrder> = new BigNumberField('CashDiscount1Days', PurchaseOrder, 'Edm.Decimal')

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

Static CASH_DISCOUNT_1_PERCENT

CASH_DISCOUNT_1_PERCENT: BigNumberField<PurchaseOrder> = new BigNumberField('CashDiscount1Percent', PurchaseOrder, 'Edm.Decimal')

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

Static CASH_DISCOUNT_2_DAYS

CASH_DISCOUNT_2_DAYS: BigNumberField<PurchaseOrder> = new BigNumberField('CashDiscount2Days', PurchaseOrder, 'Edm.Decimal')

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

Static CASH_DISCOUNT_2_PERCENT

CASH_DISCOUNT_2_PERCENT: BigNumberField<PurchaseOrder> = new BigNumberField('CashDiscount2Percent', PurchaseOrder, 'Edm.Decimal')

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

Static COMPANY_CODE

COMPANY_CODE: StringField<PurchaseOrder> = new StringField('CompanyCode', PurchaseOrder, 'Edm.String')

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

Static CORRESPNC_EXTERNAL_REFERENCE

CORRESPNC_EXTERNAL_REFERENCE: StringField<PurchaseOrder> = new StringField('CorrespncExternalReference', PurchaseOrder, 'Edm.String')

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

Static CORRESPNC_INTERNAL_REFERENCE

CORRESPNC_INTERNAL_REFERENCE: StringField<PurchaseOrder> = new StringField('CorrespncInternalReference', PurchaseOrder, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<PurchaseOrder> = new StringField('CreatedByUser', PurchaseOrder, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<PurchaseOrder> = new DateField('CreationDate', PurchaseOrder, 'Edm.DateTime')

Static representation of the creationDate 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<PurchaseOrder> = new StringField('DocumentCurrency', PurchaseOrder, '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 EXCHANGE_RATE

EXCHANGE_RATE: StringField<PurchaseOrder> = new StringField('ExchangeRate', PurchaseOrder, 'Edm.String')

Static representation of the exchangeRate 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<PurchaseOrder> = new StringField('IncotermsClassification', PurchaseOrder, '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<PurchaseOrder> = new StringField('IncotermsLocation1', PurchaseOrder, '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<PurchaseOrder> = new StringField('IncotermsLocation2', PurchaseOrder, '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_VERSION

INCOTERMS_VERSION: StringField<PurchaseOrder> = new StringField('IncotermsVersion', PurchaseOrder, 'Edm.String')

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

Static INVOICING_PARTY

INVOICING_PARTY: StringField<PurchaseOrder> = new StringField('InvoicingParty', PurchaseOrder, 'Edm.String')

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

Static IS_END_OF_PURPOSE_BLOCKED

IS_END_OF_PURPOSE_BLOCKED: StringField<PurchaseOrder> = new StringField('IsEndOfPurposeBlocked', PurchaseOrder, 'Edm.String')

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

Static LANGUAGE

LANGUAGE: StringField<PurchaseOrder> = new StringField('Language', PurchaseOrder, 'Edm.String')

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

Static LAST_CHANGE_DATE_TIME

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

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

Static MANUAL_SUPPLIER_ADDRESS_ID

MANUAL_SUPPLIER_ADDRESS_ID: StringField<PurchaseOrder> = new StringField('ManualSupplierAddressID', PurchaseOrder, 'Edm.String')

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

Static NET_PAYMENT_DAYS

NET_PAYMENT_DAYS: BigNumberField<PurchaseOrder> = new BigNumberField('NetPaymentDays', PurchaseOrder, 'Edm.Decimal')

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

Static PAYMENT_TERMS

PAYMENT_TERMS: StringField<PurchaseOrder> = new StringField('PaymentTerms', PurchaseOrder, 'Edm.String')

Static representation of the paymentTerms 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<PurchaseOrder> = new StringField('PurchaseOrder', PurchaseOrder, '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_DATE

PURCHASE_ORDER_DATE: DateField<PurchaseOrder> = new DateField('PurchaseOrderDate', PurchaseOrder, 'Edm.DateTime')

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

Static PURCHASE_ORDER_SUBTYPE

PURCHASE_ORDER_SUBTYPE: StringField<PurchaseOrder> = new StringField('PurchaseOrderSubtype', PurchaseOrder, 'Edm.String')

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

Static PURCHASE_ORDER_TYPE

PURCHASE_ORDER_TYPE: StringField<PurchaseOrder> = new StringField('PurchaseOrderType', PurchaseOrder, 'Edm.String')

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

Static PURCHASING_COMPLETENESS_STATUS

PURCHASING_COMPLETENESS_STATUS: BooleanField<PurchaseOrder> = new BooleanField('PurchasingCompletenessStatus', PurchaseOrder, 'Edm.Boolean')

Static representation of the purchasingCompletenessStatus 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<PurchaseOrder> = new StringField('PurchasingDocumentDeletionCode', PurchaseOrder, '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_DOCUMENT_ORIGIN

PURCHASING_DOCUMENT_ORIGIN: StringField<PurchaseOrder> = new StringField('PurchasingDocumentOrigin', PurchaseOrder, 'Edm.String')

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

Static PURCHASING_GROUP

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

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

Static PURCHASING_ORGANIZATION

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

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

Static PURCHASING_PROCESSING_STATUS

PURCHASING_PROCESSING_STATUS: StringField<PurchaseOrder> = new StringField('PurchasingProcessingStatus', PurchaseOrder, 'Edm.String')

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

Static RELEASE_IS_NOT_COMPLETED

RELEASE_IS_NOT_COMPLETED: BooleanField<PurchaseOrder> = new BooleanField('ReleaseIsNotCompleted', PurchaseOrder, 'Edm.Boolean')

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

Static SUPPLIER

SUPPLIER: StringField<PurchaseOrder> = new StringField('Supplier', PurchaseOrder, 'Edm.String')

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

Static SUPPLIER_PHONE_NUMBER

SUPPLIER_PHONE_NUMBER: StringField<PurchaseOrder> = new StringField('SupplierPhoneNumber', PurchaseOrder, 'Edm.String')

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

Static SUPPLIER_QUOTATION_EXTERNAL_ID

SUPPLIER_QUOTATION_EXTERNAL_ID: StringField<PurchaseOrder> = new StringField('SupplierQuotationExternalID', PurchaseOrder, 'Edm.String')

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

Static SUPPLIER_RESP_SALES_PERSON_NAME

SUPPLIER_RESP_SALES_PERSON_NAME: StringField<PurchaseOrder> = new StringField('SupplierRespSalesPersonName', PurchaseOrder, 'Edm.String')

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

Static SUPPLYING_PLANT

SUPPLYING_PLANT: StringField<PurchaseOrder> = new StringField('SupplyingPlant', PurchaseOrder, 'Edm.String')

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

Static SUPPLYING_SUPPLIER

SUPPLYING_SUPPLIER: StringField<PurchaseOrder> = new StringField('SupplyingSupplier', PurchaseOrder, 'Edm.String')

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

Static TO_PURCHASE_ORDER_ITEM

TO_PURCHASE_ORDER_ITEM: Link<PurchaseOrder, PurchaseOrderItem> = new Link('to_PurchaseOrderItem', PurchaseOrder, PurchaseOrderItem)

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

Static VALIDITY_END_DATE

VALIDITY_END_DATE: DateField<PurchaseOrder> = new DateField('ValidityEndDate', PurchaseOrder, 'Edm.DateTime')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<PurchaseOrder> = new DateField('ValidityStartDate', PurchaseOrder, 'Edm.DateTime')

Static representation of the validityStartDate 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<PurchaseOrder> | DateField<PurchaseOrder> | BigNumberField<PurchaseOrder> | BooleanField<PurchaseOrder> | Link<PurchaseOrder, PurchaseOrderItem>> = [PurchaseOrder.PURCHASE_ORDER,PurchaseOrder.COMPANY_CODE,PurchaseOrder.PURCHASE_ORDER_TYPE,PurchaseOrder.PURCHASING_DOCUMENT_DELETION_CODE,PurchaseOrder.PURCHASING_PROCESSING_STATUS,PurchaseOrder.CREATED_BY_USER,PurchaseOrder.CREATION_DATE,PurchaseOrder.LAST_CHANGE_DATE_TIME,PurchaseOrder.SUPPLIER,PurchaseOrder.PURCHASE_ORDER_SUBTYPE,PurchaseOrder.LANGUAGE,PurchaseOrder.PAYMENT_TERMS,PurchaseOrder.CASH_DISCOUNT_1_DAYS,PurchaseOrder.CASH_DISCOUNT_2_DAYS,PurchaseOrder.NET_PAYMENT_DAYS,PurchaseOrder.CASH_DISCOUNT_1_PERCENT,PurchaseOrder.CASH_DISCOUNT_2_PERCENT,PurchaseOrder.PURCHASING_ORGANIZATION,PurchaseOrder.PURCHASING_DOCUMENT_ORIGIN,PurchaseOrder.PURCHASING_GROUP,PurchaseOrder.PURCHASE_ORDER_DATE,PurchaseOrder.DOCUMENT_CURRENCY,PurchaseOrder.EXCHANGE_RATE,PurchaseOrder.VALIDITY_START_DATE,PurchaseOrder.VALIDITY_END_DATE,PurchaseOrder.SUPPLIER_QUOTATION_EXTERNAL_ID,PurchaseOrder.SUPPLIER_RESP_SALES_PERSON_NAME,PurchaseOrder.SUPPLIER_PHONE_NUMBER,PurchaseOrder.SUPPLYING_SUPPLIER,PurchaseOrder.SUPPLYING_PLANT,PurchaseOrder.INCOTERMS_CLASSIFICATION,PurchaseOrder.CORRESPNC_EXTERNAL_REFERENCE,PurchaseOrder.CORRESPNC_INTERNAL_REFERENCE,PurchaseOrder.INVOICING_PARTY,PurchaseOrder.RELEASE_IS_NOT_COMPLETED,PurchaseOrder.PURCHASING_COMPLETENESS_STATUS,PurchaseOrder.INCOTERMS_VERSION,PurchaseOrder.INCOTERMS_LOCATION_1,PurchaseOrder.INCOTERMS_LOCATION_2,PurchaseOrder.MANUAL_SUPPLIER_ADDRESS_ID,PurchaseOrder.IS_END_OF_PURPOSE_BLOCKED,PurchaseOrder.ADDRESS_CITY_NAME,PurchaseOrder.ADDRESS_FAX_NUMBER,PurchaseOrder.ADDRESS_HOUSE_NUMBER,PurchaseOrder.ADDRESS_NAME,PurchaseOrder.ADDRESS_POSTAL_CODE,PurchaseOrder.ADDRESS_STREET_NAME,PurchaseOrder.ADDRESS_PHONE_NUMBER,PurchaseOrder.ADDRESS_REGION,PurchaseOrder.ADDRESS_COUNTRY,PurchaseOrder.ADDRESS_CORRESPONDENCE_LANGUAGE,PurchaseOrder.TO_PURCHASE_ORDER_ITEM]

All fields of the PurchaseOrder 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_PurchaseOrder"

Technical entity name for PurchaseOrder.

Static _keyFields

_keyFields: Array<Selectable<PurchaseOrder>> = [PurchaseOrder.PURCHASE_ORDER]

All key fields of the PurchaseOrder entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PURCHASEORDER_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurchaseOrder>

    A builder that constructs instances of entity type PurchaseOrder.

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

    Returns PurchaseOrderRequestBuilder

    A PurchaseOrder request builder.