Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SalesSchedgAgrmtItmPrcgElmnt" 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.

Hierarchy

  • Entity
    • SalesSchedgAgrmtItmPrcgElmnt

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _customFields

_customFields: MapType<any>

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.

Protected _versionIdentifier

_versionIdentifier: string

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 "*".

Optional cndnIsRelevantForIntcoBilling

cndnIsRelevantForIntcoBilling: boolean

Condition for Intercompany Billing. A condition (KFKIV) that is relevant for intercompany billing.

nullable

Optional cndnIsRelevantForInvoiceList

cndnIsRelevantForInvoiceList: string

Condition for Invoice List. Indicates that the condition type is relevant for internal costing. Maximum length: 1.

nullable

Optional cndnRoundingOffDiffAmount

cndnRoundingOffDiffAmount: BigNumber

Rounding-Off Difference of the Condition.

nullable

Optional conditionAmount

conditionAmount: BigNumber

Condition Value. The value, resulting from pricing, for a particular condition, total, or subtotal in a document. This value is used as a total for the condition in the pricing procedure.

nullable

Optional conditionApplication

conditionApplication: string

Application. Subdivides the usage of a condition (for example, pricing) for use in different application areas (for example, sales & distribution or purchasing). Maximum length: 2.

nullable

Optional conditionBaseValue

conditionBaseValue: BigNumber

Condition Basis Value. The base value that the system uses to calculate pricing for the condition. The condition base value can be one of the following:QuantityWeightVolumeThe system multiplies the condition base value by the rate to produce the total amount for the condition. The total amount appears in the pricing procedure of a sales document.If, for example, you have a condition base value of 100 bottles and a rate of $10 per bottle, the amount for the pricing condition is $1000.

nullable

Optional conditionCalculationType

conditionCalculationType: string

Calculation Type for Condition. Determines how the system calculates prices, discounts, or surcharges in a condition. For example, the system can calculate a price as a fixed amount or as a percentage based on quantity, volume, or weight. The calculation type can be set when generating new condition records. If this does not happen, the calculation type maintained here is valid for the condition record. Maximum length: 3.

nullable

Optional conditionCategory

conditionCategory: string

Condition Category (Examples: Tax, Freight, Price, Cost). A classification of conditions according to pre-defined categories (for example, all conditions that relate to freight costs). Maximum length: 1.

nullable

Optional conditionClass

conditionClass: string

Condition Class. Preliminary structuring of condition types, for example, in surcharges and discounts or prices. Allows standardized processing of individual condition classes within the system. Maximum length: 1.

nullable

Optional conditionControl

conditionControl: string

Condition Control. Indicates whether the prices or values in a condition are fixed or whether and in what way they changed. The indicator shows, for example, if the prices generated by a condition have been changed manually during processing. Maximum length: 1.

nullable

Optional conditionCurrency

conditionCurrency: string

Currency Key. Currency key for amounts in the system. Maximum length: 5.

nullable

Optional conditionInactiveReason

conditionInactiveReason: string

Condition is Inactive. Indicates if the condition is active. A condition can be inactive due to the following reasons:Condition is excludedSubsequent price deactivates conditionFormula deactivates conditionError during pricing. Maximum length: 1.

nullable

Optional conditionIsForConfiguration

conditionIsForConfiguration: boolean

Condition for Configuration. A variant condition (KVARC) is a condition that is relevant for configuration.

nullable

Optional conditionIsForStatistics

conditionIsForStatistics: boolean

Condition is used for statistics. This indicator causes a surcharge or discount to be set in the document statistically (that is, without altering the value).

nullable

Optional conditionIsManuallyChanged

conditionIsManuallyChanged: boolean

Condition Changed Manually. If this flag is set, the condition has been manually or automatically changed or created (by entry in the condition screen).

nullable

Optional conditionOrigin

conditionOrigin: string

Origin of the Condition. Indicates where the condition originated (for example, whether you entered the condition manually or whether the system determined it automatically). Maximum length: 1.

nullable

Optional conditionQuantity

conditionQuantity: BigNumber

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.

nullable

Optional conditionQuantityUnit

conditionQuantityUnit: string

Condition Unit in the Document. Quantity unit, to which the condition amount or percentage refers. Maximum length: 3.

nullable

Optional conditionRateValue

conditionRateValue: BigNumber

Rate (Amount or Percentage). Determines how the system calculates pricing using this condition. Depending on the condition type, the rate can be an amount or a percentage. If the condition includes a pricing scale, the rate displays the first line of the scale. The following examples illustrate how you can use the rate in different condition types:If you create a condition that includes prices (for example, prices for a material), you enter an amount.If you are creating a condition based on percentage discounts or surcharges (for example, a customer-specific discount), you enter the value of a percentage. If the condition is a discount, the system automatically enters a minus sign behind the amount and a percent sign in the Rate unit field.

nullable

Optional conditionRecord

conditionRecord: string

Number of the Condition Record. Number that uniquely identifies a condition record. The system uses the condition record number to store and retrieve information during processing (pricing, for example). Maximum length: 10.

nullable

Optional conditionScaleBasisCurrency

conditionScaleBasisCurrency: string

Scale Currency. Specifies a currency for a pricing scale in a condition record. If a pricing scale is based on a value instead of a quantity, you can specify a currency for the value. In the standard version of the SAP System, this field is only relevant in condition records for the following discounts:Price groupPrice group/Material pricing groupYou apply a price group discount to customers in a particular foreign country. When you create a condition record for this discount and enter values in the pricing scale, you can also enter the corresponding foreign currency. During pricing, the system then calculates discounts based on scale values in the foreign currency. The discount amount is then converted into the currency you are using in the sales document.After you enter a currency in this field and save the condition record, you cannot change the currency without deleting the record and creating it again. Maximum length: 5.

nullable

Optional conditionScaleBasisUnit

conditionScaleBasisUnit: string

Condition Scale Unit of Measure. Unit of measure to which the quantity scale refers. Maximum length: 3.

nullable

Optional conditionScaleBasisValue

conditionScaleBasisValue: BigNumber

Scale Basis Value. The level of the pricing scale that applies to the item. You create a pricing condition based on a simple quantity scale:Quantity Price per unit10 $12100 $111000 $10A sales order item for 150 units qualifies for the $11 price. In this case, the scale base value that determines the price is 100.

nullable

Optional conditionSequentialNumber

conditionSequentialNumber: string

Sequential Number of the Condition. The sequential number that uniquely identifies the condition if a condition supplement exists. If you have assigned a condition supplement to the condition, the system automatically assigns the number. Maximum length: 3.

nullable

Optional conditionType

conditionType: string

Condition Type. The key that uniquely identifies the condition. The condition type indicates, for example, whether, during pricing, the system applies a price, a discount, a surcharge, or other pricing elements, such as freight costs and sales taxes. For each of these pricing elements, there is a condition type defined in the system. Maximum length: 4.

nullable

Optional factorForConditionBasisValue

factorForConditionBasisValue: number

Factor for Condition Base Value.

nullable

Optional isGroupCondition

isGroupCondition: string

Group Condition. Indicates whether the system calculates the scale base value or the condition value taking all related items of the business document into account. For a group condition to be effective, the items must belong to a group. You can freely define the group to meet the needs of your own organization. The items can, for example, all belong to the same material group.A sales order contains two items. Both items belong to the material group 01.Material Quantity Material groupA 150 01B 100 01The group condition indicator is set in the definition of the condition type for material group discounts. The condition record for material group 01 includes the following pricing scale:Scale quantity Discountfrom 1 pc -1%from 200 pc -2%Neither item alone qualifies for the 2% discount. However, when the items are combined as part of a group condition, the combined quantity creates a basis of 250 pieces. This basis then exceeds the scale value of 200 pieces, which is necessary to qualify for the higher discount. Maximum length: 1.

nullable

Optional isRelevantForAccrual

isRelevantForAccrual: boolean

Condition is Relevant for Accrual (e.g. Freight). Indicates that the system posts the amounts resulting from this condition to financial accounting as accruals. If you mark this indicator, the condition appears in the document as a statistical condition.

nullable

Optional periodFactorForCndnBasisValue

periodFactorForCndnBasisValue: number

Factor for Condition Basis (Period).

nullable

Optional prcgProcedureCounterForHeader

prcgProcedureCounterForHeader: string

Condition Counter (Header). Maximum length: 3.

nullable

Optional pricingDateTime

pricingDateTime: string

Timestamp for Pricing. Maximum length: 14.

nullable

pricingProcedureCounter

pricingProcedureCounter: string

Condition Counter. Access number of the conditions within a step in the pricing procedure. During automatic pricing, the system takes into account the sequence specified by the counter. Maximum length: 3.

pricingProcedureStep

pricingProcedureStep: string

Step Number. Number that determines the sequence of the condition within a procedure. Maximum length: 3.

Optional pricingScaleBasis

pricingScaleBasis: string

Scale Basis Indicator. Determines how the system interprets a pricing scale in a condition. For example, the scale can be based on quantity, weight, or volume. Maximum length: 3.

nullable

Optional pricingScaleType

pricingScaleType: string

Scale Type. Indicator that controls the validity of the scale value or percentage: From a certain quantity or value (base scale)Up to a certain quantity or value (to-scale)Alternatively, it is possible to work with interval scales. Interval scales must be stored in the condition type, that is, the scale type "interval scale" cannot be changed in the condition record. The reason for this is technical restrictions resulting from the programming within pricing. Maximum length: 1.

nullable

Protected remoteState

remoteState: object

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.

Type declaration

  • [keys: string]: any

salesSchedulingAgreement

salesSchedulingAgreement: string

Sales Scheduling Agreement. The number that uniquely identifies the sales scheduling agreement. Maximum length: 10.

salesSchedulingAgreementItem

salesSchedulingAgreementItem: string

Sales Scheduling Agreement Item. The number that uniquely identifies the item in the sales scheduling agreement. Maximum length: 6.

Optional structureCondition

structureCondition: string

Structure Condition. Controls whether the condition type is a duplicated condition or a cumulated condition. This control is only helpful when you use bill of materials or configurable materials:' ' - None'A' - Duplication Condition: A duplicated condition is duplicated into all assigned items.'B' - Cumulation Condition: A cumulated condition contains the net value of all assigned items. Maximum length: 1.

nullable

Optional taxCode

taxCode: string

Tax on Sales/Purchases Code. The tax code represents a tax category which must be taken into consideration when making a tax return to the tax authorities. Tax codes are unique per country. The tax rate calculation rules and further features are stored in a table for each tax code.For tax-exempt or non-taxable transactions, you should use tax codes with a 0 percentage rate if the corresponding transactions are to be displayed in the tax returns.You must define new tax codes if tax rates are changed by the state. The old codes with the old tax rates must remain in the system until no more open items which use this tax code exist. Maximum length: 2.

nullable

toSalesSchedgAgrmt

toSalesSchedgAgrmt: SalesSchedgAgrmt

One-to-one navigation property to the SalesSchedgAgrmt entity.

toSalesSchedgAgrmtItem

toSalesSchedgAgrmtItem: SalesSchedgAgrmtItem

One-to-one navigation property to the SalesSchedgAgrmtItem entity.

Optional transactionCurrency

transactionCurrency: string

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.

nullable

Optional variantCondition

variantCondition: string

Variant condition. Maximum length: 26.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Optional withholdingTaxCode

withholdingTaxCode: string

Withholding Tax Code. One or more "withholding tax codes" are assigned to each withholding tax type. One of the things these codes determine is the various percentage rates for the withholding tax type. Note that when processing a business transaction, no more than one withholding tax code can be assigned per withholding tax type. If the business transaction is subject to more than one withholding taxes, these must be represented in the system by defining various withholding tax types. Maximum length: 2.

nullable

Static ALL_FIELDS

ALL_FIELDS: AllFields<SalesSchedgAgrmtItmPrcgElmnt> = new AllFields('*', SalesSchedgAgrmtItmPrcgElmnt)

All fields selector.

Static CNDN_IS_RELEVANT_FOR_INTCO_BILLING

CNDN_IS_RELEVANT_FOR_INTCO_BILLING: BooleanField<SalesSchedgAgrmtItmPrcgElmnt> = new BooleanField('CndnIsRelevantForIntcoBilling', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Boolean')

Static representation of the cndnIsRelevantForIntcoBilling property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_IS_RELEVANT_FOR_INVOICE_LIST

CNDN_IS_RELEVANT_FOR_INVOICE_LIST: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('CndnIsRelevantForInvoiceList', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the cndnIsRelevantForInvoiceList property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CNDN_ROUNDING_OFF_DIFF_AMOUNT

CNDN_ROUNDING_OFF_DIFF_AMOUNT: BigNumberField<SalesSchedgAgrmtItmPrcgElmnt> = new BigNumberField('CndnRoundingOffDiffAmount', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Decimal')

Static representation of the cndnRoundingOffDiffAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_AMOUNT

CONDITION_AMOUNT: BigNumberField<SalesSchedgAgrmtItmPrcgElmnt> = new BigNumberField('ConditionAmount', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Decimal')

Static representation of the conditionAmount property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_APPLICATION

CONDITION_APPLICATION: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionApplication', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionApplication property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_BASE_VALUE

CONDITION_BASE_VALUE: BigNumberField<SalesSchedgAgrmtItmPrcgElmnt> = new BigNumberField('ConditionBaseValue', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Decimal')

Static representation of the conditionBaseValue property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_CALCULATION_TYPE

CONDITION_CALCULATION_TYPE: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionCalculationType', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionCalculationType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_CATEGORY

CONDITION_CATEGORY: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionCategory', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_CLASS

CONDITION_CLASS: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionClass', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionClass property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_CONTROL

CONDITION_CONTROL: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionControl', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionControl property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_CURRENCY

CONDITION_CURRENCY: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionCurrency', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionCurrency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_INACTIVE_REASON

CONDITION_INACTIVE_REASON: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionInactiveReason', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionInactiveReason property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_IS_FOR_CONFIGURATION

CONDITION_IS_FOR_CONFIGURATION: BooleanField<SalesSchedgAgrmtItmPrcgElmnt> = new BooleanField('ConditionIsForConfiguration', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Boolean')

Static representation of the conditionIsForConfiguration property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_IS_FOR_STATISTICS

CONDITION_IS_FOR_STATISTICS: BooleanField<SalesSchedgAgrmtItmPrcgElmnt> = new BooleanField('ConditionIsForStatistics', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Boolean')

Static representation of the conditionIsForStatistics property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_IS_MANUALLY_CHANGED

CONDITION_IS_MANUALLY_CHANGED: BooleanField<SalesSchedgAgrmtItmPrcgElmnt> = new BooleanField('ConditionIsManuallyChanged', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Boolean')

Static representation of the conditionIsManuallyChanged property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_ORIGIN

CONDITION_ORIGIN: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionOrigin', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionOrigin property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_QUANTITY

CONDITION_QUANTITY: BigNumberField<SalesSchedgAgrmtItmPrcgElmnt> = new BigNumberField('ConditionQuantity', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Decimal')

Static representation of the conditionQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_QUANTITY_UNIT

CONDITION_QUANTITY_UNIT: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionQuantityUnit', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionQuantityUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_RATE_VALUE

CONDITION_RATE_VALUE: BigNumberField<SalesSchedgAgrmtItmPrcgElmnt> = new BigNumberField('ConditionRateValue', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Decimal')

Static representation of the conditionRateValue property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_RECORD

CONDITION_RECORD: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionRecord', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionRecord property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_SCALE_BASIS_CURRENCY

CONDITION_SCALE_BASIS_CURRENCY: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionScaleBasisCurrency', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionScaleBasisCurrency property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_SCALE_BASIS_UNIT

CONDITION_SCALE_BASIS_UNIT: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionScaleBasisUnit', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionScaleBasisUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_SCALE_BASIS_VALUE

CONDITION_SCALE_BASIS_VALUE: BigNumberField<SalesSchedgAgrmtItmPrcgElmnt> = new BigNumberField('ConditionScaleBasisValue', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Decimal')

Static representation of the conditionScaleBasisValue property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_SEQUENTIAL_NUMBER

CONDITION_SEQUENTIAL_NUMBER: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionSequentialNumber', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionSequentialNumber property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CONDITION_TYPE

CONDITION_TYPE: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('ConditionType', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the conditionType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static FACTOR_FOR_CONDITION_BASIS_VALUE

FACTOR_FOR_CONDITION_BASIS_VALUE: NumberField<SalesSchedgAgrmtItmPrcgElmnt> = new NumberField('FactorForConditionBasisValue', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Double')

Static representation of the factorForConditionBasisValue property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static IS_GROUP_CONDITION

IS_GROUP_CONDITION: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('IsGroupCondition', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the isGroupCondition property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static IS_RELEVANT_FOR_ACCRUAL

IS_RELEVANT_FOR_ACCRUAL: BooleanField<SalesSchedgAgrmtItmPrcgElmnt> = new BooleanField('IsRelevantForAccrual', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Boolean')

Static representation of the isRelevantForAccrual property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PERIOD_FACTOR_FOR_CNDN_BASIS_VALUE

PERIOD_FACTOR_FOR_CNDN_BASIS_VALUE: NumberField<SalesSchedgAgrmtItmPrcgElmnt> = new NumberField('PeriodFactorForCndnBasisValue', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.Double')

Static representation of the periodFactorForCndnBasisValue property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRCG_PROCEDURE_COUNTER_FOR_HEADER

PRCG_PROCEDURE_COUNTER_FOR_HEADER: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('PrcgProcedureCounterForHeader', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the prcgProcedureCounterForHeader property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRICING_DATE_TIME

PRICING_DATE_TIME: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('PricingDateTime', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the pricingDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRICING_PROCEDURE_COUNTER

PRICING_PROCEDURE_COUNTER: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('PricingProcedureCounter', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the pricingProcedureCounter property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRICING_PROCEDURE_STEP

PRICING_PROCEDURE_STEP: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('PricingProcedureStep', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the pricingProcedureStep property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRICING_SCALE_BASIS

PRICING_SCALE_BASIS: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('PricingScaleBasis', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the pricingScaleBasis property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRICING_SCALE_TYPE

PRICING_SCALE_TYPE: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('PricingScaleType', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the pricingScaleType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SALES_SCHEDULING_AGREEMENT

SALES_SCHEDULING_AGREEMENT: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('SalesSchedulingAgreement', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

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 SALES_SCHEDULING_AGREEMENT_ITEM

SALES_SCHEDULING_AGREEMENT_ITEM: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('SalesSchedulingAgreementItem', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

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 STRUCTURE_CONDITION

STRUCTURE_CONDITION: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('StructureCondition', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the structureCondition property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TAX_CODE

TAX_CODE: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('TaxCode', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the taxCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_SALES_SCHEDG_AGRMT

TO_SALES_SCHEDG_AGRMT: OneToOneLink<SalesSchedgAgrmtItmPrcgElmnt, SalesSchedgAgrmt> = new OneToOneLink('to_SalesSchedgAgrmt', SalesSchedgAgrmtItmPrcgElmnt, SalesSchedgAgrmt)

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 TO_SALES_SCHEDG_AGRMT_ITEM

TO_SALES_SCHEDG_AGRMT_ITEM: OneToOneLink<SalesSchedgAgrmtItmPrcgElmnt, SalesSchedgAgrmtItem> = new OneToOneLink('to_SalesSchedgAgrmtItem', SalesSchedgAgrmtItmPrcgElmnt, SalesSchedgAgrmtItem)

Static representation of the one-to-one navigation property toSalesSchedgAgrmtItem for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TRANSACTION_CURRENCY

TRANSACTION_CURRENCY: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('TransactionCurrency', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

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 VARIANT_CONDITION

VARIANT_CONDITION: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('VariantCondition', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the variantCondition property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static WITHHOLDING_TAX_CODE

WITHHOLDING_TAX_CODE: StringField<SalesSchedgAgrmtItmPrcgElmnt> = new StringField('WithholdingTaxCode', SalesSchedgAgrmtItmPrcgElmnt, 'Edm.String')

Static representation of the withholdingTaxCode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<SalesSchedgAgrmtItmPrcgElmnt> | BigNumberField<SalesSchedgAgrmtItmPrcgElmnt> | BooleanField<SalesSchedgAgrmtItmPrcgElmnt> | NumberField<SalesSchedgAgrmtItmPrcgElmnt> | OneToOneLink<SalesSchedgAgrmtItmPrcgElmnt, SalesSchedgAgrmt> | OneToOneLink<SalesSchedgAgrmtItmPrcgElmnt, SalesSchedgAgrmtItem>> = [SalesSchedgAgrmtItmPrcgElmnt.SALES_SCHEDULING_AGREEMENT,SalesSchedgAgrmtItmPrcgElmnt.SALES_SCHEDULING_AGREEMENT_ITEM,SalesSchedgAgrmtItmPrcgElmnt.PRICING_PROCEDURE_STEP,SalesSchedgAgrmtItmPrcgElmnt.PRICING_PROCEDURE_COUNTER,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_APPLICATION,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_TYPE,SalesSchedgAgrmtItmPrcgElmnt.PRICING_DATE_TIME,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_CALCULATION_TYPE,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_BASE_VALUE,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_RATE_VALUE,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_CURRENCY,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_QUANTITY,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_QUANTITY_UNIT,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_CATEGORY,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_IS_FOR_STATISTICS,SalesSchedgAgrmtItmPrcgElmnt.PRICING_SCALE_TYPE,SalesSchedgAgrmtItmPrcgElmnt.IS_RELEVANT_FOR_ACCRUAL,SalesSchedgAgrmtItmPrcgElmnt.CNDN_IS_RELEVANT_FOR_INVOICE_LIST,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_ORIGIN,SalesSchedgAgrmtItmPrcgElmnt.IS_GROUP_CONDITION,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_RECORD,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_SEQUENTIAL_NUMBER,SalesSchedgAgrmtItmPrcgElmnt.TAX_CODE,SalesSchedgAgrmtItmPrcgElmnt.WITHHOLDING_TAX_CODE,SalesSchedgAgrmtItmPrcgElmnt.CNDN_ROUNDING_OFF_DIFF_AMOUNT,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_AMOUNT,SalesSchedgAgrmtItmPrcgElmnt.TRANSACTION_CURRENCY,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_CONTROL,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_INACTIVE_REASON,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_CLASS,SalesSchedgAgrmtItmPrcgElmnt.PRCG_PROCEDURE_COUNTER_FOR_HEADER,SalesSchedgAgrmtItmPrcgElmnt.FACTOR_FOR_CONDITION_BASIS_VALUE,SalesSchedgAgrmtItmPrcgElmnt.STRUCTURE_CONDITION,SalesSchedgAgrmtItmPrcgElmnt.PERIOD_FACTOR_FOR_CNDN_BASIS_VALUE,SalesSchedgAgrmtItmPrcgElmnt.PRICING_SCALE_BASIS,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_SCALE_BASIS_VALUE,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_SCALE_BASIS_UNIT,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_SCALE_BASIS_CURRENCY,SalesSchedgAgrmtItmPrcgElmnt.CNDN_IS_RELEVANT_FOR_INTCO_BILLING,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_IS_MANUALLY_CHANGED,SalesSchedgAgrmtItmPrcgElmnt.CONDITION_IS_FOR_CONFIGURATION,SalesSchedgAgrmtItmPrcgElmnt.VARIANT_CONDITION,SalesSchedgAgrmtItmPrcgElmnt.TO_SALES_SCHEDG_AGRMT,SalesSchedgAgrmtItmPrcgElmnt.TO_SALES_SCHEDG_AGRMT_ITEM]

All fields of the SalesSchedgAgrmtItmPrcgElmnt entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_SALES_SCHEDULING_AGREEMENT"

Default url path for the according service.

Static _entityName

_entityName: string = "A_SalesSchedgAgrmtItmPrcgElmnt"

Technical entity name for SalesSchedgAgrmtItmPrcgElmnt.

Static _keyFields

_keyFields: Array<Selectable<SalesSchedgAgrmtItmPrcgElmnt>> = [SalesSchedgAgrmtItmPrcgElmnt.SALES_SCHEDULING_AGREEMENT, SalesSchedgAgrmtItmPrcgElmnt.SALES_SCHEDULING_AGREEMENT_ITEM, SalesSchedgAgrmtItmPrcgElmnt.PRICING_PROCEDURE_STEP, SalesSchedgAgrmtItmPrcgElmnt.PRICING_PROCEDURE_COUNTER]

All key fields of the SalesSchedgAgrmtItmPrcgElmnt entity.

Static _keys

_keys: any = SalesSchedgAgrmtItmPrcgElmnt._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property SalesSchedgAgrmtItmPrcgElmnt.

Static _serviceName

_serviceName: string = "API_SALES_SCHEDULING_AGREEMENT"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for SalesSchedgAgrmtItmPrcgElmnt.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • 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.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • 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.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • 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.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity SalesSchedgAgrmtItmPrcgElmnt.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SalesSchedgAgrmtItmPrcgElmnt>

    A builder that constructs instances of entity type SalesSchedgAgrmtItmPrcgElmnt.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the SalesSchedgAgrmtItmPrcgElmnt entity type.

    Returns SalesSchedgAgrmtItmPrcgElmntRequestBuilder

    A SalesSchedgAgrmtItmPrcgElmnt request builder.