import { Entity, DefaultDeSerializers, DeSerializers, DeserializedType } from '@sap-cloud-sdk/odata-v2'; import { PurchaseOrderItem, PurchaseOrderItemType } from './PurchaseOrderItem'; import { PurchaseOrderNote, PurchaseOrderNoteType } from './PurchaseOrderNote'; /** * This class represents the entity "A_PurchaseOrder" of service "API_PURCHASEORDER_PROCESS_SRV". */ export declare class PurchaseOrder extends Entity implements PurchaseOrderType { /** * Technical entity name for PurchaseOrder. */ static _entityName: string; /** * Default url path for the according service. */ static _defaultServicePath: string; /** * All key fields of the PurchaseOrder entity */ static _keys: string[]; /** * Purchase Order Number. * Maximum length: 10. */ purchaseOrder: DeserializedType; /** * Company Code. * The company code is an organizational unit within financial accounting. * Maximum length: 4. * @nullable */ companyCode?: DeserializedType | null; /** * 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 */ purchaseOrderType?: DeserializedType | null; /** * Purchase Order Deletion Code. * Maximum length: 1. * @nullable */ purchasingDocumentDeletionCode?: DeserializedType | null; /** * Purchasing Document Processing State. * Maximum length: 2. * @nullable */ purchasingProcessingStatus?: DeserializedType | null; /** * User of person who created a purchasing document. * User that created a purchasing document. In general, it is the system user when the purchasing document is saved for the first time. * Depending on system and user configuration the logon user and the user ID persisted in this field might differ. * Maximum length: 12. * @nullable */ createdByUser?: DeserializedType | null; /** * Creation Date of Purchasing Document. * The date when a purchasing document was created. The relevant date is the system date when the document is the first time saved in the database. * @nullable */ creationDate?: DeserializedType | null; /** * Change Time Stamp. * Shows the year, month, day, hour, second, millisecond, microsecond, * and the first decimal of the nanoseconds when the record was created.This value is for display only. * @nullable */ lastChangeDateTime?: DeserializedType | null; /** * Supplier. * Maximum length: 10. * @nullable */ supplier?: DeserializedType | null; /** * 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 */ purchaseOrderSubtype?: DeserializedType | null; /** * 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 */ language?: DeserializedType | null; /** * 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 */ paymentTerms?: DeserializedType | null; /** * Cash Discount Days 1. * Period within which a payment must be made in order to take advantage of the first cash discount terms. * @nullable */ cashDiscount1Days?: DeserializedType | null; /** * Cash Discount Days 2. * Period within which a payment must be made in order to take advantage of the second cash discount terms. * @nullable */ cashDiscount2Days?: DeserializedType | null; /** * Net Payment Terms Period. * Standard settlement period (in days). * @nullable */ netPaymentDays?: DeserializedType | null; /** * Cash Discount Percentage 1. * Cash discount percentage rate applied to the shortest payment period. * @nullable */ cashDiscount1Percent?: DeserializedType | null; /** * Cash Discount Percentage 2. * Cash discount percentage rate applied to the second payment period. * @nullable */ cashDiscount2Percent?: DeserializedType | null; /** * Purchasing Organization. * Denotes the purchasing organization. * Maximum length: 4. * @nullable */ purchasingOrganization?: DeserializedType | null; /** * Status of Purchasing Document. * Key specifying whether a quotation has been received in respect of an RFQ. * Maximum length: 1. * @nullable */ purchasingDocumentOrigin?: DeserializedType | null; /** * 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 */ purchasingGroup?: DeserializedType | null; /** * Purchase Order Date. * Specifies the date on which the purchase order was created. * @nullable */ purchaseOrderDate?: DeserializedType | null; /** * Currency Key. * Currency key for amounts in the system. * Maximum length: 5. * @nullable */ documentCurrency?: DeserializedType | null; /** * Exchange Rate. * Maximum length: 12. * @nullable */ exchangeRate?: DeserializedType | null; /** * Indicator for Fixed Exchange Rate. * Determines that the exchange rate used for currency translation purposes calculated or entered in the purchasing document is fixed. * If you fix the exchange rate, the purchase order currency and the exchange rate cannot be changed during invoice verification. * @nullable */ exchangeRateIsFixed?: DeserializedType | null; /** * 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 */ validityStartDate?: DeserializedType | null; /** * 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 */ validityEndDate?: DeserializedType | null; /** * Quotation Number. * Number of supplier's quotation. * Maximum length: 10. * @nullable */ supplierQuotationExternalId?: DeserializedType | null; /** * Responsible Salesperson at Supplier's Office. * The name of a contact on the supplier side can be freely maintained. * There is no relation to any other data in the system, for examplebusiness partner. * Maximum length: 30. * @nullable */ supplierRespSalesPersonName?: DeserializedType | null; /** * Supplier's Phone Number. * This entry is for information only. It is not copied into purchasing documents. * Maximum length: 16. * @nullable */ supplierPhoneNumber?: DeserializedType | null; /** * 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 */ supplyingSupplier?: DeserializedType | null; /** * 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 */ supplyingPlant?: DeserializedType | null; /** * 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 */ incotermsClassification?: DeserializedType | null; /** * 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 */ correspncExternalReference?: DeserializedType | null; /** * 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 */ correspncInternalReference?: DeserializedType | null; /** * 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 */ invoicingParty?: DeserializedType | null; /** * Release Not Yet Completely Effected. * Specifies that the release (approval) process for the purchasing document has not yet been completed. * @nullable */ releaseIsNotCompleted?: DeserializedType | null; /** * 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 */ purchasingCompletenessStatus?: DeserializedType | null; /** * 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 */ incotermsVersion?: DeserializedType | null; /** * 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 Shipment or Port of Destination2. For any mode of transport - Place of Delivery 2010 or Place of DestinationFor non-C clauses, both costs and risk are transferred from the seller to the buyer at location 1.For C clauses, the costs are transferred at location 1 and the risk is transferred at location 2.Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterm Incoterm 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 waterwaysIncoterm Incoterm 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 */ incotermsLocation1?: DeserializedType | null; /** * 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 ShipmentAny mode of transport - Place of Delivery2010 Incoterms are divided as follows:Group 1: Rules for any mode or modes of transport (including by vessel)Incoterm Incoterm Description Location 2CPT Carriage Paid To Place of DeliveryCIP Carriage & Insurance Paid To Place of DeliveryGroup 2: Rules for sea and inland waterwaysIncoterm Incoterm Description Location 2CFR Cost & Freight Port of ShipmentCIF Cost Insurance & Freight Port of Shipment. * Maximum length: 70. * @nullable */ incotermsLocation2?: DeserializedType | null; /** * 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 */ manualSupplierAddressId?: DeserializedType | null; /** * 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 */ isEndOfPurposeBlocked?: DeserializedType | null; /** * 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 */ addressCityName?: DeserializedType | null; /** * First Fax No.: Area 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 */ addressFaxNumber?: DeserializedType | null; /** * 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 */ addressHouseNumber?: DeserializedType | null; /** * Name 1. * Address component: Name of an address. * Maximum length: 40. * @nullable */ addressName?: DeserializedType | null; /** * 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 */ addressPostalCode?: DeserializedType | null; /** * 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 */ addressStreetName?: DeserializedType | null; /** * First Telephone No.: Dialing 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 */ addressPhoneNumber?: DeserializedType | null; /** * 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 */ addressRegion?: DeserializedType | null; /** * Country/Region Key. * The country/region 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/region code or a typical country/region key, for example, in Germany the Federal statistics office key.The country/region keys are determined at system installation in the global settings.The definition of the country/region keys in the SAP system does not necessarily have to match political or state units.Since the country/region key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country/region key cannot query the country/region key T005-LAND1, but have to program based on the ISO code T005 INTCA. * Maximum length: 3. * @nullable */ addressCountry?: DeserializedType | null; /** * 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 */ addressCorrespondenceLanguage?: DeserializedType | null; /** * Product Compliance Supplier Check Status (All Items). * If Product Compliance is activated, the system runs a check whether the supplier fulfills the compliance expectations and is a valid supplier for the product or not. The check is executed on item level and sets a corresponding product compliance supplier status. This is true for standard purchase orders. * This status is the accumulated product compliance supplier status on header level.If all items are blocked, the purchase order is blocked. If at least one item is blocked and at least one item is not blocked, the purchase order is partially blocked. * Maximum length: 1. * @nullable */ purgAggrgdProdCmplncSuplrSts?: DeserializedType | null; /** * Product Marketability Status (All Items). * If Product Compliance is activated, the system runs a check whether the product is transported only into those countries approved by Product Compliance. The check is executed on item level and sets a corresponding product marketability status. This is true for stock transport orders. * This status is the accumulated product marketability status on header level.If all items are blocked, the purchase order is blocked. If at least one item is blocked and at least one item is not blocked, the purchase order is partially blocked. * Maximum length: 1. * @nullable */ purgAggrgdProdMarketabilitySts?: DeserializedType | null; /** * Safety Data Sheet Status (All Items). * If a material has been marked as relevant for compliance in the material master and scope item 3VQ ( Safety Data Sheets in Sales) is active, the system runs a safety data sheet check when you add or change items and save your purchase orders and seta corresponding status. This is true for stock transport orders. Your configuration expert can find this scope item in the Best Practices Explorer. * The check determines whether safety data sheets are available in all defined languages for the country of the ship-to party. If a safety data sheet is needed, but doesn't exist yet, the system automatically triggers a request for the product steward.Purchase orders can have one of the following status:Not relevant: No material is relevant for compliance, or the relevant scope item is not active in the system.Approved: Safety data sheets are available for all relevant materials.Warning: Safety data sheets are necessary and at least one of them has been requested for one or more languages, but no item is blocked.Partially blocked: At least one item is blocked, and at least one item is either not relevant for compliance or the safety data sheet is not required, available, or has been requested. The purchase order is partially blocked.Blocked: All items are blocked, hence the purchase order is blocked. * Maximum length: 1. * @nullable */ purgAggrgdSftyDataSheetStatus?: DeserializedType | null; /** * Dangerous Goods Status (All Items). * If Product Compliance is activated and a product is transport relevant, the system checks that the product is transported only into those countries and with those transport modes which are approved by Product Compliance. The check is executed on purchase order item level and sets a corresponding status. This is true for standard purchase orders and stock transport orders. * This status is the accumulated dangerous goods status on header level.If the transport for all items is forbidden, the purchase order is blocked. If at least the transport for one item is forbidden and the transport for at least one item is allowed, the purchase order is partially blocked. * Maximum length: 1. * @nullable */ purgProdCmplncTotDngrsGoodsSts?: DeserializedType | null; /** * One-to-many navigation property to the [[PurchaseOrderItem]] entity. */ toPurchaseOrderItem: PurchaseOrderItem[]; /** * One-to-many navigation property to the [[PurchaseOrderNote]] entity. */ toPurchaseOrderNote: PurchaseOrderNote[]; } export interface PurchaseOrderType { purchaseOrder: DeserializedType; companyCode?: DeserializedType | null; purchaseOrderType?: DeserializedType | null; purchasingDocumentDeletionCode?: DeserializedType | null; purchasingProcessingStatus?: DeserializedType | null; createdByUser?: DeserializedType | null; creationDate?: DeserializedType | null; lastChangeDateTime?: DeserializedType | null; supplier?: DeserializedType | null; purchaseOrderSubtype?: DeserializedType | null; language?: DeserializedType | null; paymentTerms?: DeserializedType | null; cashDiscount1Days?: DeserializedType | null; cashDiscount2Days?: DeserializedType | null; netPaymentDays?: DeserializedType | null; cashDiscount1Percent?: DeserializedType | null; cashDiscount2Percent?: DeserializedType | null; purchasingOrganization?: DeserializedType | null; purchasingDocumentOrigin?: DeserializedType | null; purchasingGroup?: DeserializedType | null; purchaseOrderDate?: DeserializedType | null; documentCurrency?: DeserializedType | null; exchangeRate?: DeserializedType | null; exchangeRateIsFixed?: DeserializedType | null; validityStartDate?: DeserializedType | null; validityEndDate?: DeserializedType | null; supplierQuotationExternalId?: DeserializedType | null; supplierRespSalesPersonName?: DeserializedType | null; supplierPhoneNumber?: DeserializedType | null; supplyingSupplier?: DeserializedType | null; supplyingPlant?: DeserializedType | null; incotermsClassification?: DeserializedType | null; correspncExternalReference?: DeserializedType | null; correspncInternalReference?: DeserializedType | null; invoicingParty?: DeserializedType | null; releaseIsNotCompleted?: DeserializedType | null; purchasingCompletenessStatus?: DeserializedType | null; incotermsVersion?: DeserializedType | null; incotermsLocation1?: DeserializedType | null; incotermsLocation2?: DeserializedType | null; manualSupplierAddressId?: DeserializedType | null; isEndOfPurposeBlocked?: DeserializedType | null; addressCityName?: DeserializedType | null; addressFaxNumber?: DeserializedType | null; addressHouseNumber?: DeserializedType | null; addressName?: DeserializedType | null; addressPostalCode?: DeserializedType | null; addressStreetName?: DeserializedType | null; addressPhoneNumber?: DeserializedType | null; addressRegion?: DeserializedType | null; addressCountry?: DeserializedType | null; addressCorrespondenceLanguage?: DeserializedType | null; purgAggrgdProdCmplncSuplrSts?: DeserializedType | null; purgAggrgdProdMarketabilitySts?: DeserializedType | null; purgAggrgdSftyDataSheetStatus?: DeserializedType | null; purgProdCmplncTotDngrsGoodsSts?: DeserializedType | null; toPurchaseOrderItem: PurchaseOrderItemType[]; toPurchaseOrderNote: PurchaseOrderNoteType[]; } //# sourceMappingURL=PurchaseOrder.d.ts.map