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.
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 "*".
Cash Discount Days 1. Period within which a payment must be made in order to take advantage of the first cash discount terms.
Cash Discount Percentage 1. Cash discount percentage rate applied to the shortest payment period.
Cash Discount Days 2. Period within which a payment must be made in order to take advantage of the second cash discount terms.
Cash Discount Percentage 2. Cash discount percentage rate applied to the second payment period.
Company Code. The company code is an organizational unit within financial accounting. Maximum length: 4.
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.
Name of Person Who Created Object. Maximum length: 12.
Date on Which Record Was Created.
Currency Key. Currency key for amounts in the system. Maximum length: 5.
Exchange Rate. Maximum length: 12.
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.
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.
Incoterms Location 1. Provides additional information for the primary Incoterm. For Incoterms 2010, this field represents:
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.
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.
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.
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.
Language Key. The language key indicates
Net Payment Terms Period. Standard settlement period (in days).
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.
Purchasing Document Category. Identifier that allows you to differentiate between various kinds of purchasing document in the SAP System. Maximum length: 1.
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.
Purchasing Document Date. Date on which the purchasing document was created.
Status of Purchasing Document. Key specifying whether a quotation has been received in respect of an RFQ. Maximum length: 1.
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.
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.
Purchasing Organization. Denotes the purchasing organization. Maximum length: 4.
Quotation Submission Date. Date on which the supplier submitted the quotation.
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.
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.
Purchasing Document Number. Alphanumeric key uniquely identifying the document. Maximum length: 10.
Supplier. Maximum length: 10.
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.
Supplier's Telephone Number. This entry is for information only. It is not copied into purchasing documents. Maximum length: 16.
Quotation Number. Number of supplier's quotation. Maximum length: 10.
Responsible Salesperson at Supplier's Office. Maximum length: 30.
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.
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.
One-to-many navigation property to the SchAgrmtPartner entity.
One-to-many navigation property to the SchAgrmtItem entity.
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.
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.
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.
ETag version identifier accessor.
All fields selector.
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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 representation of the vatRegistrationCountry property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the SchAgrmtHeader entity.
Default url path for the according service.
Technical entity name for SchAgrmtHeader.
All key fields of the SchAgrmtHeader entity.
Mapping of all key field names to the respective static field property SchAgrmtHeader.
Returns a map of all defined fields in entity to their current values.
Entity with all defined entity fields
Custom field value getter.
The name of the custom field
The value of the corresponding custom field
Returns a map that contains all entity custom fields.
A map of all defined custom fields in the entity
Returns all updated custom field properties compared to the last known remote state.
A map containing all updated custom properties, with their new values
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.
Entity with all properties that changed
Validates whether a custom field exists in the entity.
The name of the custom field to update
A boolean value, that indicates whether a custom field is defined in entity
Sets all retrieved custom fields in entity.
Extracted custom fields from a retrieved entity
A boolean value, that indicates the existence of the field in entity
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check
Boolean value that describes whether a field name can be defined as custom field
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.
The name of the custom field to update
The value of the field
The entity itself, to facilitate method chaining
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.
State to be set as remote state
The entity itself, to facilitate method chaining
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity
The entity itself, to facilitate method chaining
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Returns an entity builder to construct instances SchAgrmtHeader.
A builder that constructs instances of entity type SchAgrmtHeader.
Returns a selectable object that allows the selection of custom field in a get request for the entity SchAgrmtHeader.
Name of the custom field to select
A builder that constructs instances of entity type SchAgrmtHeader.
Returns a request builder to construct requests for operations on the SchAgrmtHeader entity type.
A SchAgrmtHeader request builder.
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.