Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CentralPurchaseContract" of service "API_CENTRAL_PURCHASECONTRACT_SRV". This service is part of the following communication scenarios: SAP S/4HANA Procurement Hub - Central Contract Management Integration (SAP_COM_0243). See https://api.sap.com/api/API_CENTRAL_PURCHASECONTRACT_SRV for more information.

Hierarchy

  • Entity
    • CentralPurchaseContract

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

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

centralPurchaseContract

centralPurchaseContract: string

Central Purchase Contract. Maximum length: 10.

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 exchangeRateIsFixed

exchangeRateIsFixed: undefined | false | true

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

Optional incotermsClassification

incotermsClassification: undefined | string

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

nullable

Optional incotermsLocation1

incotermsLocation1: undefined | string

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

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

Optional incotermsLocation2

incotermsLocation2: undefined | string

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

nullable

Optional incotermsTransferLocation

incotermsTransferLocation: undefined | string

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

nullable

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

lastChangeDateTime: Moment

Change Time Stamp.

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

Optional purchaseContractTargetAmount

purchaseContractTargetAmount: BigNumber

Target Value for Header Area per Distribution. Displays the target value that is entered for each distribution at header level for a central contract. You specify this value manually for each distribution at header level of the central contract.If the specified value is exceeded, the user sees a message when creating the contract release order.

nullable

Optional purchaseContractType

purchaseContractType: 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 purchasingDocumentCategory

purchasingDocumentCategory: undefined | string

Purchasing Document Category. Identifier that allows you to differentiate between various kinds of purchasing document in the SAP System. Maximum length: 1.

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

quotationSubmissionDate: Moment

Quotation Submission Date. Date on which the supplier submitted the quotation.

nullable

Optional releaseCode

releaseCode: undefined | string

Release Indicator: Purchasing Document. Specifies whether the purchasing document can be processed in or is blocked for follow-on functions. Maximum length: 1.

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 supplierQuotation

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

toCentralPurchaseContractItem

toCentralPurchaseContractItem: CntrlPurchaseContractItem[]

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

toCntrlPurContrDistrMessages

toCntrlPurContrDistrMessages: CntrlPurContrDistrMessages[]

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

Optional validityEndDate

validityEndDate: Moment

End of Validity Period.

nullable

Optional validityStartDate

validityStartDate: Moment

Start of Validity Period.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

ALL_FIELDS: AllFields<CentralPurchaseContract> = new AllFields('*', CentralPurchaseContract)

All fields selector.

Static CASH_DISCOUNT_1_DAYS

CASH_DISCOUNT_1_DAYS: BigNumberField<CentralPurchaseContract> = new BigNumberField('CashDiscount1Days', CentralPurchaseContract, '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<CentralPurchaseContract> = new BigNumberField('CashDiscount1Percent', CentralPurchaseContract, '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<CentralPurchaseContract> = new BigNumberField('CashDiscount2Days', CentralPurchaseContract, '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<CentralPurchaseContract> = new BigNumberField('CashDiscount2Percent', CentralPurchaseContract, '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 CENTRAL_PURCHASE_CONTRACT

CENTRAL_PURCHASE_CONTRACT: StringField<CentralPurchaseContract> = new StringField('CentralPurchaseContract', CentralPurchaseContract, 'Edm.String')

Static representation of the centralPurchaseContract 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<CentralPurchaseContract> = new StringField('CompanyCode', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('CorrespncExternalReference', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('CorrespncInternalReference', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('CreatedByUser', CentralPurchaseContract, '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<CentralPurchaseContract> = new DateField('CreationDate', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('DocumentCurrency', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('ExchangeRate', CentralPurchaseContract, '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 EXCHANGE_RATE_IS_FIXED

EXCHANGE_RATE_IS_FIXED: BooleanField<CentralPurchaseContract> = new BooleanField('ExchangeRateIsFixed', CentralPurchaseContract, 'Edm.Boolean')

Static representation of the exchangeRateIsFixed 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<CentralPurchaseContract> = new StringField('IncotermsClassification', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('IncotermsLocation1', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('IncotermsLocation2', CentralPurchaseContract, 'Edm.String')

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

Static INCOTERMS_TRANSFER_LOCATION

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

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

Static INCOTERMS_VERSION

INCOTERMS_VERSION: StringField<CentralPurchaseContract> = new StringField('IncotermsVersion', CentralPurchaseContract, '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 LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<CentralPurchaseContract> = new DateField('LastChangeDateTime', CentralPurchaseContract, '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 NET_PAYMENT_DAYS

NET_PAYMENT_DAYS: BigNumberField<CentralPurchaseContract> = new BigNumberField('NetPaymentDays', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('PaymentTerms', CentralPurchaseContract, '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_CONTRACT_TARGET_AMOUNT

PURCHASE_CONTRACT_TARGET_AMOUNT: BigNumberField<CentralPurchaseContract> = new BigNumberField('PurchaseContractTargetAmount', CentralPurchaseContract, 'Edm.Decimal')

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

Static PURCHASE_CONTRACT_TYPE

PURCHASE_CONTRACT_TYPE: StringField<CentralPurchaseContract> = new StringField('PurchaseContractType', CentralPurchaseContract, 'Edm.String')

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

Static PURCHASING_DOCUMENT_CATEGORY

PURCHASING_DOCUMENT_CATEGORY: StringField<CentralPurchaseContract> = new StringField('PurchasingDocumentCategory', CentralPurchaseContract, 'Edm.String')

Static representation of the purchasingDocumentCategory 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<CentralPurchaseContract> = new StringField('PurchasingDocumentDeletionCode', CentralPurchaseContract, '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_GROUP

PURCHASING_GROUP: StringField<CentralPurchaseContract> = new StringField('PurchasingGroup', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('PurchasingOrganization', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('PurchasingProcessingStatus', CentralPurchaseContract, '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 QUOTATION_SUBMISSION_DATE

QUOTATION_SUBMISSION_DATE: DateField<CentralPurchaseContract> = new DateField('QuotationSubmissionDate', CentralPurchaseContract, 'Edm.DateTime')

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

Static RELEASE_CODE

RELEASE_CODE: StringField<CentralPurchaseContract> = new StringField('ReleaseCode', CentralPurchaseContract, 'Edm.String')

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

Static SUPPLIER

SUPPLIER: StringField<CentralPurchaseContract> = new StringField('Supplier', CentralPurchaseContract, '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<CentralPurchaseContract> = new StringField('SupplierPhoneNumber', CentralPurchaseContract, '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

SUPPLIER_QUOTATION: StringField<CentralPurchaseContract> = new StringField('SupplierQuotation', CentralPurchaseContract, 'Edm.String')

Static representation of the supplierQuotation 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<CentralPurchaseContract> = new StringField('SupplierRespSalesPersonName', CentralPurchaseContract, '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_SUPPLIER

SUPPLYING_SUPPLIER: StringField<CentralPurchaseContract> = new StringField('SupplyingSupplier', CentralPurchaseContract, '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_CENTRAL_PURCHASE_CONTRACT_ITEM

TO_CENTRAL_PURCHASE_CONTRACT_ITEM: Link<CentralPurchaseContract, CntrlPurchaseContractItem> = new Link('to_CentralPurchaseContractItem', CentralPurchaseContract, CntrlPurchaseContractItem)

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

Static TO_CNTRL_PUR_CONTR_DISTR_MESSAGES

TO_CNTRL_PUR_CONTR_DISTR_MESSAGES: Link<CentralPurchaseContract, CntrlPurContrDistrMessages> = new Link('to_CntrlPurContrDistrMessages', CentralPurchaseContract, CntrlPurContrDistrMessages)

Static representation of the one-to-many navigation property toCntrlPurContrDistrMessages 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<CentralPurchaseContract> = new DateField('ValidityEndDate', CentralPurchaseContract, '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<CentralPurchaseContract> = new DateField('ValidityStartDate', CentralPurchaseContract, '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<CentralPurchaseContract> | DateField<CentralPurchaseContract> | BigNumberField<CentralPurchaseContract> | BooleanField<CentralPurchaseContract> | Link<CentralPurchaseContract, CntrlPurchaseContractItem> | Link<CentralPurchaseContract, CntrlPurContrDistrMessages>> = [CentralPurchaseContract.CENTRAL_PURCHASE_CONTRACT,CentralPurchaseContract.PURCHASE_CONTRACT_TYPE,CentralPurchaseContract.PURCHASING_DOCUMENT_CATEGORY,CentralPurchaseContract.SUPPLIER,CentralPurchaseContract.COMPANY_CODE,CentralPurchaseContract.PURCHASING_ORGANIZATION,CentralPurchaseContract.PURCHASING_GROUP,CentralPurchaseContract.VALIDITY_START_DATE,CentralPurchaseContract.VALIDITY_END_DATE,CentralPurchaseContract.DOCUMENT_CURRENCY,CentralPurchaseContract.LAST_CHANGE_DATE_TIME,CentralPurchaseContract.CREATION_DATE,CentralPurchaseContract.PAYMENT_TERMS,CentralPurchaseContract.CASH_DISCOUNT_1_DAYS,CentralPurchaseContract.CASH_DISCOUNT_2_DAYS,CentralPurchaseContract.CASH_DISCOUNT_1_PERCENT,CentralPurchaseContract.CASH_DISCOUNT_2_PERCENT,CentralPurchaseContract.NET_PAYMENT_DAYS,CentralPurchaseContract.INCOTERMS_CLASSIFICATION,CentralPurchaseContract.INCOTERMS_TRANSFER_LOCATION,CentralPurchaseContract.INCOTERMS_VERSION,CentralPurchaseContract.INCOTERMS_LOCATION_1,CentralPurchaseContract.INCOTERMS_LOCATION_2,CentralPurchaseContract.PURCHASE_CONTRACT_TARGET_AMOUNT,CentralPurchaseContract.EXCHANGE_RATE,CentralPurchaseContract.EXCHANGE_RATE_IS_FIXED,CentralPurchaseContract.SUPPLYING_SUPPLIER,CentralPurchaseContract.QUOTATION_SUBMISSION_DATE,CentralPurchaseContract.SUPPLIER_QUOTATION,CentralPurchaseContract.CORRESPNC_EXTERNAL_REFERENCE,CentralPurchaseContract.CORRESPNC_INTERNAL_REFERENCE,CentralPurchaseContract.SUPPLIER_RESP_SALES_PERSON_NAME,CentralPurchaseContract.SUPPLIER_PHONE_NUMBER,CentralPurchaseContract.RELEASE_CODE,CentralPurchaseContract.CREATED_BY_USER,CentralPurchaseContract.PURCHASING_DOCUMENT_DELETION_CODE,CentralPurchaseContract.PURCHASING_PROCESSING_STATUS,CentralPurchaseContract.TO_CENTRAL_PURCHASE_CONTRACT_ITEM,CentralPurchaseContract.TO_CNTRL_PUR_CONTR_DISTR_MESSAGES]

All fields of the CentralPurchaseContract entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CentralPurchaseContract"

Technical entity name for CentralPurchaseContract.

Static _keyFields

_keyFields: Array<Selectable<CentralPurchaseContract>> = [CentralPurchaseContract.CENTRAL_PURCHASE_CONTRACT]

All key fields of the CentralPurchaseContract entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CENTRAL_PURCHASECONTRACT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CentralPurchaseContract>

    A builder that constructs instances of entity type CentralPurchaseContract.

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

    Returns CentralPurchaseContractRequestBuilder

    A CentralPurchaseContract request builder.