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 "*".
Valid-to Date.
Valid-from Date.
Name of Person Who Created Object. Maximum length: 12.
Date on Which Record Was Created.
Time at Which Record Was Created.
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.
Customer Reference Date. The date that appears on the customer's purchase order. This date can be, for example, the date on which the customer created the purchase order.
Customer Purchase Order Type. The way in which the sales document (the inquiry or sales order, for example) arrives from the customer. You can record here whether the sales document arrived, for example, by telephone, mail, or fax.Enter one of the values predefined for your system. Maximum length: 4.
MRP for delivery schedule types. Specifies whether forecast delivery schedules or JIT delivery schedules are relevant for planning and/or delivery. The SAP System contains the following requirements planning settings:No delivery schedules are used.This indicator is default for all sales documents without delivery schedules.Only forecast delivery schedules are relevant for requirements planning. Forecast delivery schedules and JIT (just-in-time) delivery schedules are relevant for delivery, depending on their validity.Forecast delivery schedules and JIT delivery schedules are relevant for requirements planning and delivery, depending on their validity.Only forecast delivery schedules are relevant for requirements planning. Only JIT delivery schedules are relevant for delivery.Forecast delivery schedules and JIT delivery schedules are relevant for requirements planning, depending on their validity. Only JIT delivery schedules are relevant for delivery.JIT delivery schedules are not used.You have set material requirements planning indicator B (Forecast and JIT delivery schedules are relevant for requirements planning and delivery) in the scheduling agreement header. The forecast delivery schedule contains schedule lines from January 1 up to March 31. The JIT delivery schedule horizon covers the period up to January 31. The JIT delivery schedule is relevant for requirements planning and delivery within this horizon. As of February 1, the forecast delivery schedule is relevant for requirements planning and delivery. Maximum length: 1.
Delivery Block (Document Header). Indicates if an entire sales document (a sales order, for example) is blocked for delivery. The system can propose a delivery block on header level according to sales document type. Users can also enter a block manually. A block in the header applies to the entire sales document.The system only proposes a delivery block at header level if delivery blocks have been assigned to the corresponding delivery type using the Define Reasons for Blocking in Shipping and the Assign Blocking Reasons to Delivery Types configuration steps.Additional InformationUsers can also block a sales document manually at schedule line level.The settings made in these configuration steps do not influence any delivery blocks set at schedule line level.The system can block delivery automatically for certain sales document types (for example, sales orders without charge) where it is important that someone checks the details before shipping takes place. Maximum length: 2.
Distribution Channel. The way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales. You can maintain information about customers and materials by sales organization and distribution channel. Within a sales organization you can deliver goods to a given customer through more than one distribution channel.You can assign a distribution channel to one or more sales organizations. If, for example, you have numerous sales organizations, each sales organization may use the "Wholesale" distribution channel.For each combination of sales organization and distribution channel, you can further assign one or more of the divisions that are defined for the sales organization. You can, for example, assign "Food" and "Non-food" divisions to the "Wholesale" distribution channel. A particular combination of sales organization, distribution channel, and division is known as a sales area. Maximum length: 2.
Posting Period. A posting period is a self-contained part of a fiscal year. Every business transaction is allocated to a posting period. The monthly debits and credits of the different business transactions are accumulated per posting period.Examples of period classifications:Per calendar month -> 12 posting periodsEvery 4 weeks -> 13 posting periodsWeekly -> 52 or 53 posting periods. Maximum length: 3.
Fiscal Year. Period, 12 months as a rule, for which the company is to create its inventory and balance sheet. The fiscal year can be the same as the calendar year, but does not have to be. Maximum length: 4.
Billing Block in SD Document. Indicates if the entire sales document is blocked for billing. The system can propose the billing block according to the type of sales document. The billing block applies to the entire document. You can block or unblock the entire document manually in the header. If you want to block only a particular item, enter a value at the item level.You may want to apply a billing block to certain documents so that prices can be checked before further processing. Maximum length: 2.
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.
Date of Last Change.
UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun). The UTC timestamp displays date and time according to UTC (Universal Coordinated Time). In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.
User Who Last Changed the Business Document. Maximum length: 12.
Usage Indicator. Defines how the material is used. The usage defines the conditions under which a material is sold. It can be entered at item or header level. Entries made at header level are valid for all items.The same material, but with different uses, can be sold to the same customer in separate items or orders.Enter whether the material is:A spare, or replacement partA samplePart of a series, used in repetitive manufacturing. Maximum length: 3.
Division. A way of grouping materials, products, or services. The system uses divisions to determine the sales areas and the business areas for a material, product, or service. A product or service is always assigned to just one division. From the point of view of sales and distribution, the use of divisions lets you organize your sales structure around groups of similar products or product lines. This allows the people in a division who process orders and service customers to specialize within a manageable area of expertise.If a sales organization sells food and non-food products through both retail and wholesaledistribution channels each distribution channel could then be further split into food and non-food divisions. Maximum length: 2.
Overall Billing Block Status. The value of the overall billing block field is calculated using the: Billing block status of item + sales document billing block + user status header. Maximum length: 1.
Overall Delivery Block Status. The value of this field is calculated using the following values: Item delivery block status + Document header delivery block + user status for header. Maximum length: 1.
Delivery Status. The delivery status of the sales document. Maximum length: 1.
Overall Rejection Status of All Document Items. Displays the rejection status of the entire sales document. The system determines the total status from the status of all individual items in the sales document. The status message tells you whether the sales document has been partially or completely rejected or whether nothing has been rejected. Maximum length: 1.
Overall Processing Status of Document. The processing status of the entire sales document. The system determines the status of the entire sales document by taking into account the status of all header-related information and the status of all individual items. The status message tells you whether processing of the sales document is open, in progress, or complete. Maximum length: 1.
Payment Method. Payment method with which this item is to be paid. If you enter a payment method, then only this payment method can be used in automatic payment transactions. Unless you enter a payment method, one of the payment methods that was allowed in the master record is selected in the payment program according to specified rules.For document entry or document changes, you only enter a payment method if you want to switch off the automatic payment method selection of the payment program. Maximum length: 1.
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.
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.
Sales District. A geographical sales district or region. Each customer can be assigned to a sales district. You can use sales districts to apply pricing conditions. When you want to generate sales statistics, you can use sales districts as a selection criteria.The system can propose a value from the customer master record of the sold-to party. You can change the value manually in the document at the header or item level. Maximum length: 6.
Sales Group. A group of sales people who are responsible for processing sales of certain products or services. By using sales groups you can designate different areas of responsibility within a sales office. When you generate sales statistics, you can use the sales group as one of the selection criteria.If sales office personnel service both retail and wholesale markets, you can assign a sales group to each market.You assign each salesperson to a sales group in his or her user master record. You assign each customer to a particular sales group in the customer's master record. Maximum length: 3.
Sales Office. A physical location (for example, a branch office) that has responsibility for the sale of certain products or services within a given geographical area. When you create sales statistics, you can use a sales office as one of the selection criteria. When you print out order confirmations, you can include the address of the sales office.You can assign each customer to a sales office in the customer master record.Within a sales office you can establish sales groups (for example, departments) with specific sales responsibilities. Each person who works in the sales office can be assigned to a sales group in his or her user master record. Each customer can also be assigned to a particular sales group in the customer master record. Maximum length: 4.
Sales Organization. An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims. You can assign any number of distribution channels and divisions to a sales organization. A particular combination of sales organization, distribution channel, and division is known as a sales area. Maximum length: 4.
Document Date (Date Received/Sent). The date on which you want the sales document (the sales order, for example) to become effective for sales management purposes. When you want to generate a list of sales documents or sales statistics, the document date you enter determines which sales documents are selected. You can define the document date to meet the needs of your organization.For sales orders, for example, you can define the document date as the date when the order actually arrives at your offices. Alternatively, you could define it as the date when the order was written up by a field sales representative.The system proposes the current date. You can change it manually in the sales document.
Sales Scheduling Agreement Type. A classification that distinguishes between different kinds of sales scheduling agreements. Maximum length: 4.
Sales Scheduling Agreement. The number that uniquely identifies the sales scheduling agreement. Maximum length: 10.
Order Reason (Reason for the Business Transaction). Indicates the reason for creating the sales document. You can freely define order reasons according to the needs of your organization. When you generate sales statistics, you can use the order reason as one of the selection criteria.Enter one of the values predefined for your system. If you are creating a credit or debit memo request, you must enter an order reason.If the order reason specifies, for example, that a customer placed a sales order as a result of contact at a trade fair, you can later generate statistics for all sales orders that were placed at trade fairs. Maximum length: 3.
Shipping Conditions. General shipping strategy for the delivery of goods from the vendor to the customer. You can define shipping conditions in your system which correspond to the requirements of your company. You can specify a shipping condition in the customer master and in the vendor master.Shipping point determination (outbound delivery):The loading group, the plant and the shipping condition determine the shipping point that will be proposed by the system.Route determination (outbound delivery):Apart from the country and the geographical region of the shipping point, the ship-to party and the transportation group, the shipping condition determines the route that the system proposes in the order for the delivery of the goods. In the delivery, the route proposal also takes the weight group into account.A particular customer always requires immediate delivery. You enter the appropriate shipping condition into the customer master record. This means that when you process orders for this customer, the system automatically proposes the express mail room as a shipping point and the quickest way to the airport as a route.If a shipping condition has been assigned to a sales document type in Customizing, this condition will be proposed by the system in the corresponding sales document. If there is no assignment, the system copies the relevant data from the corresponding customer master record of the sold-to party. You cannot change this value during delivery processing. The shipping condition will not be copied from the delivery into the shipment. The shipping condition is one of several criteria for selecting deliveries when you create a shipment. You can enter a shipping condition manually in the shipment where it only serves as a characteristic for grouping shipments. Maximum length: 2.
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.
Sold-to Party. Maximum length: 10.
One-to-many navigation property to the SalesSchedgAgrmtItem entity.
One-to-many navigation property to the SalesSchedgAgrmtPartner entity.
One-to-many navigation property to the SalesSchedgAgrmtPrcgElement entity.
One-to-many navigation property to the SalesSchedgAgrmtText entity.
Overall Blocked Status. Overall blocked status. The value of this field is calculated according to the following values:Overall header delivery block status + overall header billing block status + header credit check status. Maximum length: 1.
Overall Status of Credit Checks. Maximum length: 1.
Net Value of the Sales Order in Document Currency. The total value of all items in the sales document, after any discounts and surcharges are taken into account. The value is expressed in the document currency.
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.
Static representation of the agrmtValdtyEndDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the agrmtValdtyStartDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields selector.
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 creationTime 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 customerPurchaseOrderDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the customerPurchaseOrderType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the deliveryBlockReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the delivSchedTypeMrpRlvnceCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the distributionChannel property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the fiscalPeriod property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the fiscalYear property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the headerBillingBlockReason 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 lastChangedByUser 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 lastChangeDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the matlUsageIndicator property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the organizationDivision property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the overallBillingBlockStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the overallDeliveryBlockStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the overallDeliveryStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the overallSdDocumentRejectionSts property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the overallSdProcessStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the paymentMethod 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 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 salesDistrict property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesOffice property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesOrganization property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesSchedgAgrmtDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesSchedgAgrmtType 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 sdDocumentReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the shippingCondition 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 soldToParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the totalBlockStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the totalCreditCheckStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the totalNetAmount 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 toItem 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-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.
All fields of the SalesSchedgAgrmt entity.
Default url path for the according service.
Technical entity name for SalesSchedgAgrmt.
All key fields of the SalesSchedgAgrmt entity.
Mapping of all key field names to the respective static field property SalesSchedgAgrmt.
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 SalesSchedgAgrmt
.
A builder that constructs instances of entity type SalesSchedgAgrmt
.
Returns a selectable object that allows the selection of custom field in a get request for the entity SalesSchedgAgrmt
.
Name of the custom field to select
A builder that constructs instances of entity type SalesSchedgAgrmt
.
Returns a request builder to construct requests for operations on the SalesSchedgAgrmt
entity type.
A SalesSchedgAgrmt
request builder.
This class represents the entity "A_SalesSchedgAgrmt" 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.