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 "*".
Batch Number. Assigns a material that is manufactured in batches or production lots to a specific batch. Maximum length: 10.
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.
Higher-Level item in bill of material structures. The number of the higher-level item to which this item belongs in a hierarchy. Items can be organized hierarchically. When you assign a sub-item to another item, the other item becomes a higher-level item.Enter the number of a higher-level item. Maximum length: 6.
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.
Billing Block for Item. Indicates if the item is blocked for billing. To block an item for billing, enter one of the values predefined for your system.You can block an item for billing so that, for example, terms of payment or prices can be checked before further processing takes place. Maximum length: 2.
Gross Weight of the Item. The total gross weight of the item. The gross weight represents the net weight plus the weight of packaging. The system calculates the gross weight based on the order quantity for the item and the gross weight proposed from the material master record.If the item has more than one schedule line, the system uses the total order quantity of all schedule lines to calculate the gross weight. In sales documents where schedule lines are not allowed (contracts, for example), the system calculates the gross weight using the target quantity.You can change the value manually at the item level.
Net Weight of the Item. The total net weight for the item. The net weight represents the gross weight less the weight of packaging. The system calculates the net weight based on the order quantity for the item and the net weight proposed from the material master record. If the item has more than one schedule line, the system uses the total order quantity of all schedule lines to calculate the net weight. In sales documents where schedule lines are not allowed (contracts, for example), the system calculates the net weight using the target quantity.You can change the value manually at the item level.The gross weight of a refrigerator and its packaging (a cardboard box including protective padding) is 350 pounds. The packaging weighs 25 pounds. In this case, the net weight is 325 pounds.
Volume of the item. The total volume for the item. The system calculates the volume based on the order quantity for the item and the volume proposed from the material master record. If the item has more than one schedule line, the system uses the total order quantity of all schedule lines to calculate the volume. In sales documents where schedule lines are not allowed (contracts, for example), the system calculates the volume using the target quantity.You can change the value manually at the item level.
Volume Unit. Unit referring to the volume of the material. If you specify a volume, you have to enter the corresponding volume unit here. Maximum length: 3.
Unit of Weight. Unit referring to the gross weight or net weight of the material. If you specify a weight, you must enter the corresponding unit of weight here. Maximum length: 3.
Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.
Material Number Used by Customer. Uniquely identifies the material from the customer's point of view. If the customer uses a different identifier than the one you use for the material, you can include this information in a customer-material info record. You can also include in this record specific shipping details, such asMinimum delivery quantityPartial delivery conditionsEnter a value from an existing customer-material info record. Maximum length: 35.
Material Group. Key that you use to group together several materials or services with the same attributes, and to assign them to a particular material group. You can use material groups to:Restrict the scope of analysesSearch specifically for material master records via search helps. Maximum length: 9.
Material Price Group. A way of grouping materials to which you want to apply the same condition. You can create condition records for a material price group using the following condition types:Material price group (for example, all non-food products)A combination of customer and material price groupA combination of customer price group and material price group (for example, all wholesale customers and all non-food products). Maximum length: 2.
Net Value of the Order Item in Document Currency. The net value of the item, after any discounts and surcharges are taken into account. Sales taxes are not included. The value is expressed in the document currency.
Validity Period of Contract. Maximum length: 3.
Target Value for Outline Agreement in Document Currency. The target value of an outline agreement (for example, a value contract). The value is expressed in the document currency. The target value represents the value of products or services that a customer has agreed to purchase or that a supplier has agreed to supply during the validity period of the outline agreement.
Date for Pricing and Exchange Rate. The date that determines date-related pricing elements, such as conditions and foreign exchange rate. You can use the pricing date as a selection criterion when you process billing documents collectively.The system proposes the current date. You can change it manually in the document. If you change the pricing date, the system recalculates pricing for the entire document. If the date is in the past, you receive a warning before you can continue.Determining the ProposalIn the order: You can customize the order type to determine a proposal, such as the current date or the requested delivery date as the pricing date.In the billing document: The billing date is proposed as the pricing date.
Plant (Own or External). Key that uniquely identifies a plant. Maximum length: 4.
Profit Center. Key which together with the controlling area uniquely identifies a profit center. Maximum length: 10.
Customer Reference. Number that the customer uses to uniquely identify a purchasing document (e.g. an inquiry or a purchase order). The number creates the link between the customer purchase order and the sales document that you create. You can use the number used by the customer during correspondence with the customer to find certain document information. If the number refers to a purchase order, you can also print it on the documents that you send to the customer (e.g. on the delivery note). Maximum length: 35.
Document Number of the Reference Document. Identifies the sales order to which the delivery refers. Maximum length: 10.
Item Number of the Reference Item. The number of the sales order item to which the delivery item refers. Maximum length: 6.
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.
Requested Quantity.
Requested Quantity Unit. Maximum length: 3.
Sales Contract. Maximum length: 10.
Action at end of contract. Enter the follow-up action which is to be taken when the contract ends. Follow-up actions are Creating a contractCreating a quotationCreating a sales activity such as a telephone callSending an internal electronic mail. Maximum length: 4.
Sales Contract Item. Maximum length: 6.
Sales Document Item Category. A classification that distinguishes between different types of item (for example, free of charge items and text items) and determines how the system processes the item. The system proposes an item category. If alternatives are defined for your system, you can change the item category manually in the sales document.If, for example, you identify an item as a free or charge item, you tell the system, in this case, to ignore normal pricing procedures. Maximum length: 4.
Short Text for Sales Order Item. A short description of the item. Short texts are used throughout sales order processing, shipping, and billing. They also appear on printed order confirmations.The system proposes the short text from the material master record. If you have included a short text in a customer-material info record, it replaces the material master text during sales document processing. You can change the text at the item level in the sales document or during delivery processing. Maximum length: 40.
Date on Which Contract Is Signed. Enter the date on which the customer signs the contract. The date you enter can be used as a baseline date for determining other dates in the contract.You want the contract to become valid on the day it is signed by the customer. You enter a date rule for the contract start date which has the date on which the contract is signed as its baseline date. When you enter the date on which the contract was signed in the contract, the system automatically makes the appropriate entry in the contract start date field.
Contract End Date.
Validity Period Category of Contract. Enter a value here to indicate what kind of validity period the contract has (6 months, one year, and so on). Maximum length: 2.
Unit of Validity Period of Contract. Maximum length: 1.
Contract Start Date. Enter the contract start date. The contract start date can be entered both at header and at item level. If the contract start date is only entered at header level, then it is valid for all items.The contract start date can be proposed automatically as a default from another data field on the basis of a date rule.
Reason for Rejection of Sales Documents. The reason for rejecting a sales document (for example, a sales quotation or a sales order). The rejection can come from your organization (for example, you can reject a customer request for a credit memo because it is unreasonable) or from the customer (for example, the customer rejects a quotation because the price is too high). The following list shows the effects on different document types after you enter a reason for rejection:Inquiries and quotations: no further references by other documentsSales orders: no further delivery of itemsContracts: no further creation of release ordersCredit and debit memo requests: no further processing of credit or debit memosEnter one of the values predefined for your system.If you enter a reason for rejection, the system automatically cancels any MRP requirements previously generated for the items. Maximum length: 2.
Overall Processing Status of the SD Document Item. Displays the overall processing status of the item. The system determines the overall status from all statuses (for example, delivery and billing) for this item. The status message tells you whether processing of the item is open, in progress, or complete. Maximum length: 1.
Shipping Point / Receiving Point. The physical location (for example, a warehouse or collection of loading ramps) from which you ship the item. You can predefine shipping/receiving points in the system, based on different combinations ofPlantsShipping conditionsLoading groupsDuring delivery processing, the shipping/receiving point is the most important criterion that you use to select deliveries.A delivery can be shipped from only one shipping point or received at only one receiving point.If you want to provide more detailed information about a shipping point you can specify a loading point (for example, one of a number of different loading ramps).If, for example, you want to ship refrigerated goods to a certain customer by rail, the system proposes a shipping point with a suitable location and equipment for loading refrigerated goods onto rail cars.The system can propose a shipping/receiving point. If valid alternatives are predefined in your system, you can change the shipping/receiving point manually. Maximum length: 4.
Date for Action. Enter the date on which you want the follow-up action for the contract to be performed. The contract will be included in the worklist for contracts with follow-up actions whenThe date you enter in this field lies within the selection period you define for the worklistThe contract fulfills the other selection criteria you define for the worklist.You reach the selection screen for the worklist for contracts with follow-up actions by choosing Outline agreements -> Contracts -> Subsequent functions -> Follow-up actions.
Storage Location. Number of the storage location in which the material is stored. A plant may contain one or more storage locations. Maximum length: 4.
One-to-many navigation property to the SalesContractItemPartner entity.
One-to-many navigation property to the SalesContractItemPrcgElmnt entity.
One-to-one navigation property to the SalesContract entity.
SD document currency. The currency that applies to the document (for example, to a sales order or an invoice). The system proposes the document currency from the customer master record of the sold-to party. You can change the currency manually in the document. If you change the currency, the system recalculates prices for the entire document. Maximum length: 5.
ETag version identifier accessor.
Work Breakdown Structure Element (WBS Element). Key that identifies a WBS element. Maximum length: 24.
All fields selector.
Static representation of the batch property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the customerPaymentTerms property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the higherLevelItem 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 itemBillingBlockReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the itemGrossWeight property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the itemNetWeight property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the itemVolume property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the itemVolumeUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the itemWeightUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the material property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialByCustomer property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the materialPricingGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the netAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the nmbrOfSalesContractValdtyPerd property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the outlineAgreementTargetAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the pricingDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the productionPlant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the profitCenter property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the purchaseOrderByCustomer property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the referenceSdDocument property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the referenceSdDocumentItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the requestedQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the requestedQuantityUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContract property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContractFollowUpAction property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContractItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContractItemCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContractItemText property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContractSignedDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContractValidityEndDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContractValidityPerdCat property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContractValidityPerdUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesContractValidityStartDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesDocumentRjcnReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the sdProcessStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the shippingPoint property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the slsContractFollowUpActionDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the storageLocation 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 toPartner 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 toPricingElement 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-one navigation property toSalesContract for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the transactionCurrency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the wbsElement property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the SalesContractItem entity.
Default url path for the according service.
Technical entity name for SalesContractItem.
All key fields of the SalesContractItem entity.
Mapping of all key field names to the respective static field property SalesContractItem.
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 SalesContractItem
.
A builder that constructs instances of entity type SalesContractItem
.
Returns a selectable object that allows the selection of custom field in a get request for the entity SalesContractItem
.
Name of the custom field to select
A builder that constructs instances of entity type SalesContractItem
.
Returns a request builder to construct requests for operations on the SalesContractItem
entity type.
A SalesContractItem
request builder.
This class represents the entity "A_SalesContractItem" of service "API_SALES_CONTRACT_SRV". This service is part of the following communication scenarios: Sales Contract Integration (SAP_COM_0119). See https://api.sap.com/api/API_SALES_CONTRACT_SRV for more information.