Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SchAgrmtHeader" of service "API_SCHED_AGRMT_PROCESS_SRV". This service is part of the following communication scenarios: Purchase Scheduling Agreement Integration (SAP_COM_0103). See https://api.sap.com/api/API_SCHED_AGRMT_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • SchAgrmtHeader

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns SchAgrmtHeader

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

Optional companyCode

companyCode: string

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

nullable

Optional companyVatRegistration

companyVatRegistration: string

VAT Registration Number. VAT registration number (VAT reg.no.) of the customer, vendor or your company code. The VAT registration number is used within the EU for tax-exempt deliveries for the "EC sales list". The check rules are defined for each EU country and cannot be changed. Maximum length: 20.

nullable

Optional createdByUser

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

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

nullable

Optional exchangeRate

exchangeRate: string

Exchange Rate. Maximum length: 12.

nullable

Optional exchangeRateIsFixed

exchangeRateIsFixed: boolean

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

language: 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 netPaymentDays

netPaymentDays: BigNumber

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

nullable

Optional paymentTerms

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

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

purchasingDocumentOrderDate: Moment

Purchasing Document Date. Date on which the purchasing document was created.

nullable

Optional purchasingDocumentOrigin

purchasingDocumentOrigin: string

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

nullable

Optional purchasingDocumentType

purchasingDocumentType: 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 purchasingGroup

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

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

nullable

Optional quotationSubmissionDate

quotationSubmissionDate: Moment

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

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 scheduleAgreementHasReleaseDoc

scheduleAgreementHasReleaseDoc: boolean

Indicator for scheduling agreement release documentation. Determines whether the scheduling agreement release documentation is active. If you set the indicator, the forecast delivery schedule releases will be saved in a separate file and can be displayed at any time.

nullable

schedulingAgreement

schedulingAgreement: string

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

Optional supplier

supplier: string

Supplier. Maximum length: 10.

nullable

Optional supplierAddressId

supplierAddressId: 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 supplierPhoneNumber

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

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

nullable

Optional supplierRespSalesPersonName

supplierRespSalesPersonName: string

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

nullable

Optional supplyingSupplier

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

Optional targetAmount

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

toSchAgrmtPartner

toSchAgrmtPartner: SchAgrmtPartner[]

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

toSchedgAgrmtItm

toSchedgAgrmtItm: SchAgrmtItem[]

One-to-many navigation property to the SchAgrmtItem 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

Optional vatRegistrationCountry

vatRegistrationCountry: string

Country of Sales Tax ID Number. Specifies the key for the country of the VAT registration number. This key is used to check country-specific entries such as the length of the zip code or bank account number. Maximum length: 3.

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<SchAgrmtHeader> = new AllFields('*', SchAgrmtHeader)

All fields selector.

Static CASH_DISCOUNT_1_DAYS

CASH_DISCOUNT_1_DAYS: BigNumberField<SchAgrmtHeader> = new BigNumberField('CashDiscount1Days', SchAgrmtHeader, '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<SchAgrmtHeader> = new BigNumberField('CashDiscount1Percent', SchAgrmtHeader, '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<SchAgrmtHeader> = new BigNumberField('CashDiscount2Days', SchAgrmtHeader, '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<SchAgrmtHeader> = new BigNumberField('CashDiscount2Percent', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('CompanyCode', SchAgrmtHeader, '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 COMPANY_VAT_REGISTRATION

COMPANY_VAT_REGISTRATION: StringField<SchAgrmtHeader> = new StringField('CompanyVATRegistration', SchAgrmtHeader, 'Edm.String')

Static representation of the companyVatRegistration 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<SchAgrmtHeader> = new StringField('CreatedByUser', SchAgrmtHeader, '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<SchAgrmtHeader> = new DateField('CreationDate', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('DocumentCurrency', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('ExchangeRate', SchAgrmtHeader, '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<SchAgrmtHeader> = new BooleanField('ExchangeRateIsFixed', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('IncotermsClassification', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('IncotermsLocation1', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('IncotermsLocation2', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('IncotermsTransferLocation', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('IncotermsVersion', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('InvoicingParty', SchAgrmtHeader, '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 LANGUAGE

LANGUAGE: StringField<SchAgrmtHeader> = new StringField('Language', SchAgrmtHeader, '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 NET_PAYMENT_DAYS

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

PURCHASING_DOCUMENT_CATEGORY: StringField<SchAgrmtHeader> = new StringField('PurchasingDocumentCategory', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('PurchasingDocumentDeletionCode', SchAgrmtHeader, '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_ORDER_DATE

PURCHASING_DOCUMENT_ORDER_DATE: DateField<SchAgrmtHeader> = new DateField('PurchasingDocumentOrderDate', SchAgrmtHeader, 'Edm.DateTime')

Static representation of the purchasingDocumentOrderDate 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<SchAgrmtHeader> = new StringField('PurchasingDocumentOrigin', SchAgrmtHeader, '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_DOCUMENT_TYPE

PURCHASING_DOCUMENT_TYPE: StringField<SchAgrmtHeader> = new StringField('PurchasingDocumentType', SchAgrmtHeader, 'Edm.String')

Static representation of the purchasingDocumentType 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<SchAgrmtHeader> = new StringField('PurchasingGroup', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('PurchasingOrganization', SchAgrmtHeader, '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 QUOTATION_SUBMISSION_DATE

QUOTATION_SUBMISSION_DATE: DateField<SchAgrmtHeader> = new DateField('QuotationSubmissionDate', SchAgrmtHeader, '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 SCHEDULE_AGREEMENT_HAS_RELEASE_DOC

SCHEDULE_AGREEMENT_HAS_RELEASE_DOC: BooleanField<SchAgrmtHeader> = new BooleanField('ScheduleAgreementHasReleaseDoc', SchAgrmtHeader, 'Edm.Boolean')

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

Static SCHEDULING_AGREEMENT

SCHEDULING_AGREEMENT: StringField<SchAgrmtHeader> = new StringField('SchedulingAgreement', SchAgrmtHeader, 'Edm.String')

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

Static SUPPLIER

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

SUPPLIER_ADDRESS_ID: StringField<SchAgrmtHeader> = new StringField('SupplierAddressID', SchAgrmtHeader, 'Edm.String')

Static representation of the supplierAddressId 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<SchAgrmtHeader> = new StringField('SupplierPhoneNumber', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('SupplierQuotationExternalID', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('SupplierRespSalesPersonName', SchAgrmtHeader, '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<SchAgrmtHeader> = new StringField('SupplyingSupplier', SchAgrmtHeader, '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 TARGET_AMOUNT

TARGET_AMOUNT: BigNumberField<SchAgrmtHeader> = new BigNumberField('TargetAmount', SchAgrmtHeader, 'Edm.Decimal')

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

Static TO_SCHEDG_AGRMT_ITM

TO_SCHEDG_AGRMT_ITM: Link<SchAgrmtHeader, SchAgrmtItem> = new Link('to_SchedgAgrmtItm', SchAgrmtHeader, SchAgrmtItem)

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

Static TO_SCH_AGRMT_PARTNER

TO_SCH_AGRMT_PARTNER: Link<SchAgrmtHeader, SchAgrmtPartner> = new Link('to_SchAgrmtPartner', SchAgrmtHeader, SchAgrmtPartner)

Static representation of the one-to-many navigation property toSchAgrmtPartner 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<SchAgrmtHeader> = new DateField('ValidityEndDate', SchAgrmtHeader, '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<SchAgrmtHeader> = new DateField('ValidityStartDate', SchAgrmtHeader, '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 VAT_REGISTRATION_COUNTRY

VAT_REGISTRATION_COUNTRY: StringField<SchAgrmtHeader> = new StringField('VATRegistrationCountry', SchAgrmtHeader, 'Edm.String')

Static representation of the vatRegistrationCountry 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<SchAgrmtHeader> | DateField<SchAgrmtHeader> | BigNumberField<SchAgrmtHeader> | BooleanField<SchAgrmtHeader> | Link<SchAgrmtHeader, SchAgrmtPartner> | Link<SchAgrmtHeader, SchAgrmtItem>> = [SchAgrmtHeader.SCHEDULING_AGREEMENT,SchAgrmtHeader.COMPANY_CODE,SchAgrmtHeader.PURCHASING_DOCUMENT_CATEGORY,SchAgrmtHeader.PURCHASING_DOCUMENT_TYPE,SchAgrmtHeader.CREATED_BY_USER,SchAgrmtHeader.CREATION_DATE,SchAgrmtHeader.LANGUAGE,SchAgrmtHeader.PURCHASING_ORGANIZATION,SchAgrmtHeader.PURCHASING_GROUP,SchAgrmtHeader.DOCUMENT_CURRENCY,SchAgrmtHeader.INCOTERMS_CLASSIFICATION,SchAgrmtHeader.INCOTERMS_TRANSFER_LOCATION,SchAgrmtHeader.PAYMENT_TERMS,SchAgrmtHeader.CASH_DISCOUNT_1_DAYS,SchAgrmtHeader.CASH_DISCOUNT_2_DAYS,SchAgrmtHeader.CASH_DISCOUNT_1_PERCENT,SchAgrmtHeader.CASH_DISCOUNT_2_PERCENT,SchAgrmtHeader.NET_PAYMENT_DAYS,SchAgrmtHeader.TARGET_AMOUNT,SchAgrmtHeader.EXCHANGE_RATE,SchAgrmtHeader.EXCHANGE_RATE_IS_FIXED,SchAgrmtHeader.INCOTERMS_LOCATION_1,SchAgrmtHeader.INCOTERMS_LOCATION_2,SchAgrmtHeader.INCOTERMS_VERSION,SchAgrmtHeader.PURCHASING_DOCUMENT_ORDER_DATE,SchAgrmtHeader.SCHEDULE_AGREEMENT_HAS_RELEASE_DOC,SchAgrmtHeader.SUPPLIER,SchAgrmtHeader.SUPPLIER_ADDRESS_ID,SchAgrmtHeader.VALIDITY_START_DATE,SchAgrmtHeader.VALIDITY_END_DATE,SchAgrmtHeader.PURCHASING_DOCUMENT_ORIGIN,SchAgrmtHeader.PURCHASING_DOCUMENT_DELETION_CODE,SchAgrmtHeader.QUOTATION_SUBMISSION_DATE,SchAgrmtHeader.SUPPLIER_QUOTATION_EXTERNAL_ID,SchAgrmtHeader.SUPPLIER_RESP_SALES_PERSON_NAME,SchAgrmtHeader.SUPPLIER_PHONE_NUMBER,SchAgrmtHeader.INVOICING_PARTY,SchAgrmtHeader.SUPPLYING_SUPPLIER,SchAgrmtHeader.COMPANY_VAT_REGISTRATION,SchAgrmtHeader.VAT_REGISTRATION_COUNTRY,SchAgrmtHeader.TO_SCH_AGRMT_PARTNER,SchAgrmtHeader.TO_SCHEDG_AGRMT_ITM]

All fields of the SchAgrmtHeader entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SchAgrmtHeader"

Technical entity name for SchAgrmtHeader.

Static _keyFields

_keyFields: Array<Selectable<SchAgrmtHeader>> = [SchAgrmtHeader.SCHEDULING_AGREEMENT]

All key fields of the SchAgrmtHeader entity.

Static _keys

_keys: any = SchAgrmtHeader._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_SCHED_AGRMT_PROCESS_SRV"
deprecated

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

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.

    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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      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

  • Returns an entity builder to construct instances SchAgrmtHeader.

    Returns EntityBuilderType<SchAgrmtHeader, SchAgrmtHeaderType>

    A builder that constructs instances of entity type SchAgrmtHeader.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity SchAgrmtHeader.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SchAgrmtHeader>

    A builder that constructs instances of entity type SchAgrmtHeader.

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, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the SchAgrmtHeader entity type.

    Returns SchAgrmtHeaderRequestBuilder

    A SchAgrmtHeader request builder.