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 "*".
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.
Delivery Priority. The delivery priority assigned to an item. You can assign delivery priority to either a particular material or to a combination of customer and material. When you process deliveries collectively, you can use delivery priority as one of the selection criteria. Maximum length: 2.
Delivery Status (Item). Displays the delivery status of the item. The status line tells you if the item is not yet delivered, is partly delivered, is completely delivered, or is not relevant for delivery. Maximum length: 1.
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.
Billing Incompletion Status (Item). Displays the incompletion status of billing-related information that applies to this item. The status line tells you to what extent the information necessary for billing the item is complete.A sales order item, for example, is incomplete for billing if prices are missing. You cannot bill the item until you provide the missing information. Maximum length: 1.
Delivery Incompletion Status (Item). Displays the status of delivery-related information that applies to this item. The status line tells you if delivery-related item information is complete. You must enter this information, if you want to process the item further.A sales order item is incomplete for delivery processing if, for example, you do not enter a shipping point. You cannot deliver the item until you provide this information. Maximum length: 1.
Incompletion Status (Item). Displays the status of all information that applies to this item. The status line tells you if all item information, necessary for further processing this item, is complete. Maximum length: 1.
Date of Last Change.
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.
Net Price. The net price that results from the net value divided by the order quantity. The net price always refers to the condition unit and the condition pricing unit in the relevant pricing condition.
Condition Pricing Unit. The quantity on which the amount or percentage is based. The quantity is expressed in sales units (for example, bottles). You want to create a condition record for a material price of US$8 for 1 piece. You enter "8" in the Rate field, "USD" in the Unit field, and "1" as the condition pricing unit in this field.You create a condition record that gives a fixed discount of $10 to a customer who buys 1000 bottles. In this case, the condition pricing unit is 1000.
Condition Unit. Quantity unit to which the condition amount refers. Maximum length: 3.
Cumulative Order Quantity in Sales Unit. The total (rounded) order quantity for this item. If there is more than one schedule line for the item, the total order quantity is taken from the rounded quantity of the total of all the schedule lines.If no rounding is carried out, then the order required quantity corresponds to a schedule line of the rounded quantity.
Sales Unit. Unit of measure in which the material is sold. Maximum length: 3.
Denominator (Divisor) for Conversion of Sales Qty into SKU. Denominator of the conversion factor that the system uses to convert sales units base units of measure. Many material processing functions, such as the generation of production requirements, may require that sales units are converted into base units of measureYou store a certain beverage in casks, but sell it in 1-liter bottles. The conversion factor is as follows:100 bt <=> 1 caThe first number (the denominator) represents the sales units, in this case, bottles. The second number (the numerator) represents the equivalent quantity in base units of measure, in this case, casks.
Numerator (factor) for conversion of sales quantity into SKU. Numerator of the conversion factor that the system uses to convert sales units base units of measure. Many material processing functions, such as the generation of production requirements, may require that sales units are converted into base units of measureYou store a certain beverage in casks, but sell it in 1-liter bottles. The conversion factor is as follows:100 bt <=> 1 caThe first number (the denominator) represents the sales units, in this case, bottles. The second number (the numerator) represents the equivalent quantity in base units of measure, in this case, casks.
Material entered. Material originally requested by the customer. If, for some reason, you have to send a substitute material instead of the material originally requested, you can see which product the customer originally ordered. Maximum length: 40.
Instruction for Planning Delivery Schedule. Determines how planning delivery schedules are generated. To create or change a planning delivery schedule, you must first enter a valid instruction in the relevant sales scheduling agreement item. Then you can process planning delivery schedules just as you process forecast and just-in-time (JIT) delivery schedules.Schedule lines in the planning delivery schedule replace those schedule lines in the forecast delivery schedule regarding planning relevance, and if any, delivery relevance. Maximum length: 4.
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.
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.
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.
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.
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.
Sales Scheduling Agreement. The number that uniquely identifies the sales scheduling agreement. Maximum length: 10.
Sales Scheduling Agreement Item. The number that uniquely identifies the item in the sales scheduling agreement. Maximum length: 6.
Overall Processing Status (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.
Shipping Type. Shipping type (for example, by road or rail) that has been selected for the transportation of the goods for the shipment legs. During automatic shipment leg determination, all legs created or only the main, direct, or return legs are assigned to this shipping type, depending on the type of leg determination.You can enter the shipment type for the main, direct or return legs in the shipping header. The value is proposed depending on the requirement in the shipment type.By setting the status "planned", you have the shipping type copied from the respective deliveries into the shipment header, provided:The shipping type is identical in all the deliveries.The shipping type in the shipment header is not already filled.See also: Leg determination. Maximum length: 2.
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.
Target Quantity in Sales Units. The target quantity for an item in a sales document. The quantity is expressed in sales units (for example, bottles). The following list shows the use of target quantities in different types of sales document.Scheduling agreements: A target quantity represents the total quantity of an item that the customer has agreed to buy during the validity period of the agreement.Credit and debit memo requests: A target quantity represents the total quantity of an item for which you want to issue a credit or debit memo request.Product proposals: A target quantity represents the total quantity of an item that is suggested as part of a product proposal. After you have copied the product proposal into a new sales document, you can create schedule lines.
Target Quantity UoM. The unit of measure of the target quantity of a material. You may use a different unit of measure when you actually process the item.You can create a contract, for example, in which you enter a target quantity in pallets. Later, when you create release orders against the contract, you can specify any other units of measure defined in the material master (for example, cartons). Maximum length: 3.
One-to-many navigation property to the SalesSchedgAgrmtItemPartner entity.
One-to-many navigation property to the SalesSchedgAgrmtItmPrcgElmnt entity.
One-to-one navigation property to the SalesSchedgAgrmt entity.
One-to-many navigation property to the SalesSchedgAgrmtDelivSched entity.
One-to-many navigation property to the SalesSchedgAgrmtItemText 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.
Item Number of the Underlying Purchase Order. The item number (from a purchase order, for example) that the customer uses to uniquely identify the item. Enter the item number from the customer's document. The item number may vary from the item number that appears in your own sales document. Maximum length: 6.
All fields selector.
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 deliveryPriority property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the deliveryStatus 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 itemBillingIncompletionStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the itemDeliveryIncompletionStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the itemGeneralIncompletionStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lastChangeDate 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 netPriceAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the netPriceQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the netPriceQuantityUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the orderQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the orderQuantityUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the orderToBaseQuantityDnmntr property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the orderToBaseQuantityNmrtr property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the originallyRequestedMaterial property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the plngDelivSchedInstrn 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 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 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 salesSchedgAgrmtItemCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesSchedgAgrmtItemText property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesSchedulingAgreement property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesSchedulingAgreementItem 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 shippingType 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 targetQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the targetQuantityUnit 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 toSalesSchedgAgrmt 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 toSalesSchedgAgrmtDelivSched 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 toText 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 underlyingPurchaseOrderItem property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the SalesSchedgAgrmtItem entity.
Default url path for the according service.
Technical entity name for SalesSchedgAgrmtItem.
All key fields of the SalesSchedgAgrmtItem entity.
Mapping of all key field names to the respective static field property SalesSchedgAgrmtItem.
ETag version identifier accessor.
The ETag version identifier of the retrieved entity, returns undefined if not retrieved
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 SalesSchedgAgrmtItem
.
A builder that constructs instances of entity type SalesSchedgAgrmtItem
.
Returns a selectable object that allows the selection of custom field in a get request for the entity SalesSchedgAgrmtItem
.
Name of the custom field to select
A builder that constructs instances of entity type SalesSchedgAgrmtItem
.
Returns a request builder to construct requests for operations on the SalesSchedgAgrmtItem
entity type.
A SalesSchedgAgrmtItem
request builder.
This class represents the entity "A_SalesSchedgAgrmtItem" of service "API_SALES_SCHEDULING_AGREEMENT". This service is part of the following communication scenarios: Sales Scheduling Agreements Integration (SAP_COM_0360). See https://api.sap.com/api/API_SALES_SCHEDULING_AGREEMENT for more information.