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 "*".
Base Unit of Measure. Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure. You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified. Maximum length: 3.
Customer number. The customer to whom the condition or the customer-material info record applies. Enter the number of your customer. Maximum length: 10.
Item Usage. The item usage controls the system reaction when you process a sales document item in a certain context. The item usage can be used for the determination of item categories. It controls which other item categories are to be found in a certain environment (text items and packing items, for example).It can also control which items are to be billed in a service quotation or the corresponding sales order and which are only there for statistical reasons. 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.
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.
ETag. Comparison key for tracking the most recent version of the customer material. Maximum length: 10.
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.
Customer Description of Material. The short text that the customer uses to describe the material. If you include the customer's description as short text in the customer-material info record, the system automatically uses the text during sales document processing. When you create a sales order, for example, the customer's description appears instead of the short text from the material master record. Maximum length: 40.
Maximum Number of Partial Deliveries Allowed Per Item. The maximum number of partial deliveries you can make (including the first delivery) to satisfy the order quantity for an item. The system can propose a number from the shipping information in the customer master record. During sales order processing, you can change the proposed value in the shipping information for each item in the sales document.You can only specify a maximum number of partial deliveries if the Partial delivery/item field (in either the customer master record or in the sales document) indicates that partial deliveries are allowed.
Minimum Delivery Quantity in Delivery Note Processing. Minimum quantity that may be delivered to a customer.
Overdelivery Tolerance. Percentage (based on the order quantity) up to which an overdelivery of this item will be accepted. If you have set the indicator in the Partial delivery/Item field to 'D' (partial delivery allowed), this takes priority. It makes no sense to define a tolerance limit for overdelivery in such case.
Partial Delivery at Item Level. Specifies whether the customer requires full or partial delivery for the item. You use this field to control partial deliveries at the item level. If the customer allows partial delivery, you can choose from different partial delivery options. For example, you can specify whether the customer allows you to make one delivery attempt only on the requested delivery date or whether unlimited delivery attempts are possible.When partial delivery indicator 'D' is set, the order can never have status 'fully delivered'. You must complete each item by entering a reason for rejection. This could be applied to scheduling agreements, for example.You can enter a value in this field only if the customer allows partial deliveries for the entire sales document. Maximum length: 1.
Plant (Own or External). Key that uniquely identifies a plant. Maximum length: 4.
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 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.
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.
Sales Unit. Unit of measure in which the material is sold. Maximum length: 3.
Underdelivery Tolerance. Percentage (based on the order quantity) up to which an underdelivery of this item will be accepted.
Unlimited Overdelivery Allowed. Indicates whether the customer allows unlimited over- and underdeliveries. If the customer allows unlimited over- and underdeliveries, you cannot enter values in the fields that specify over- and underdelivery tolerance.
ETag version identifier accessor.
All fields selector.
Static representation of the baseUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the customer property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the customerMaterialItemUsage 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 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 eTag 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 materialDescriptionByCustomer property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the maxNmbrOfPartialDelivery property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the minDeliveryQtyInBaseUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the overdelivTolrtdLmtRatioInPct property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the partialDeliveryIsAllowed property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the plant 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 salesQtyToBaseQtyDnmntr property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesQtyToBaseQtyNmrtr property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the salesUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the underdelivTolrtdLmtRatioInPct property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the unlimitedOverdeliveryIsAllowed property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the CustomerMaterial entity.
Default url path for the according service.
Technical entity name for CustomerMaterial.
All key fields of the CustomerMaterial entity.
Mapping of all key field names to the respective static field property CustomerMaterial.
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 CustomerMaterial.
A builder that constructs instances of entity type CustomerMaterial.
Returns a selectable object that allows the selection of custom field in a get request for the entity CustomerMaterial.
Name of the custom field to select
A builder that constructs instances of entity type CustomerMaterial.
Returns a request builder to construct requests for operations on the CustomerMaterial entity type.
A CustomerMaterial request builder.
This class represents the entity "A_CustomerMaterial" of service "API_CUSTOMER_MATERIAL_SRV". This service is part of the following communication scenarios: Customer Material Info Record Integration (SAP_COM_0134). See https://api.sap.com/api/API_CUSTOMER_MATERIAL_SRV for more information.