Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductValuationAccount" of service "API_PRODUCT_SRV". This service is part of the following communication scenarios: Distributed Manufacturing Integration (SAP_COM_0077), SAP Analytics Cloud for Planning Integration (SAP_COM_0087), Product Integration (SAP_COM_0009). See https://api.sap.com/api/API_PRODUCT_SRV for more information.

Hierarchy

  • Entity
    • ProductValuationAccount

Implements

Index

Constructors

constructor

  • Returns ProductValuationAccount

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 commercialPrice1InCoCodeCrcy

commercialPrice1InCoCodeCrcy: BigNumber

Valuation price based on commercial law: level 1. Price at which the material is valuated for commercial purposes. (The distinction between tax valuation and commercial valuation is not observed in the United States of America or in some European countries.).

nullable

Optional commercialPrice2InCoCodeCrcy

commercialPrice2InCoCodeCrcy: BigNumber

Valuation price based on commercial law: level 2. Price at which the material is valuated from the commercial viewpoint, and which is derived in the determination of lowest value. It relates to the price unit of the previous year. Price level 2 is used for updating the lowest price that has been determined on the basis of range of coverage and movement rate.

nullable

Optional commercialPrice3InCoCodeCrcy

commercialPrice3InCoCodeCrcy: BigNumber

Valuation price based on commercial law: level 3. Price at which the material is valuated for reasons of commercial law. This price is given by the FIFO valuation. Alternatively, it can be specified by inventory costing or by an external source. The price relates to the price unit in the previous year (for more information, see the SAP Library documentation Invoice Verification and Material Valuation).

nullable

Optional devaluationYearCount

devaluationYearCount: string

Lowest value: devaluation indicator. The devaluation indicator shows how many years the material has been flagged as slow or non-moving. The devaluation indicator determines the percentage by which the value of a material is reduced. It allows the results from previous years to be taken into account when the "lowest value" of a material is determined on the basis of whether it is slow/non-moving. The devaluation indicator is:Increased by 1 if the material is slow or non-movingSet to 0 if the material is medium or fast moving. Maximum length: 2.

nullable

Optional futureEvaluatedAmountValue

futureEvaluatedAmountValue: BigNumber

Future price. Price at which the material will be valuated as from a precise date in the future. The future standard price is valid as of the date you enter in the relevant field.Before the future price can become effective, you must activate it for material valuation.

nullable

Optional futurePriceValidityStartDate

futurePriceValidityStartDate: Moment

Date as of which the price is valid. Date as from which the future price of the material is valid.

nullable

Optional isLifoAndFifoRelevant

isLifoAndFifoRelevant: boolean

Data element for domain BOOLE: TRUE (='X') and FALSE (=' ').

nullable

Optional lifoValuationPoolNumber

lifoValuationPoolNumber: string

Pool number for LIFO valuation. Alphanumeric key uniquely identifying the document. Materials to be valuated together in LIFO valuation are grouped under a pool number. Maximum length: 4.

nullable

product

product: string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

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

Optional taxPrice2InCoCodeCrcy

taxPrice2InCoCodeCrcy: BigNumber

Valuation price based on tax law: level 2. Price at which the material is valuated for tax purposes, and which is derived in the determination of lowest value. It relates to the price unit of the previous year. Price level 2 is used for updating the lowest price that has been determined on the basis of range of coverage and movement rate.

nullable

Optional taxPrice3InCoCodeCrcy

taxPrice3InCoCodeCrcy: BigNumber

Valuation price based on tax law: level 3. Price at which the material is valuated for reasons of tax law. This price is given by the FIFO valuation. Alternatively, it can be specified by inventory costing or by an external source. The price relates to the price unit in the previous year (for more information, see the SAP Library documentation Invoice Verification and Material Valuation).

nullable

Optional taxPricel1InCoCodeCrcy

taxPricel1InCoCodeCrcy: BigNumber

Valuation price based on tax law: level 1. Price at which the material is valuated for tax purposes. (The distinction between tax valuation and commercial valuation is not observed in the United States of America or in some European countries.).

nullable

valuationArea

valuationArea: string

Valuation Area. Organizational level at which the material is valuated. A valuation area can be one of the following: PlantAll plants belonging to a company code, in which case the valuation area is the company code. Maximum length: 4.

valuationType

valuationType: string

Valuation Type. Uniquely identifies separately valuated stocks of a material. The valuation types allowed for a material are determined by the valuation category.If a material is valuated according to its origin (valuation category H), you can define the possible countries of origin as valuation types. Maximum length: 10.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static COMMERCIAL_PRICE_1_IN_CO_CODE_CRCY

COMMERCIAL_PRICE_1_IN_CO_CODE_CRCY: BigNumberField<ProductValuationAccount> = new BigNumberField('CommercialPrice1InCoCodeCrcy', ProductValuationAccount, 'Edm.Decimal')

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

Static COMMERCIAL_PRICE_2_IN_CO_CODE_CRCY

COMMERCIAL_PRICE_2_IN_CO_CODE_CRCY: BigNumberField<ProductValuationAccount> = new BigNumberField('CommercialPrice2InCoCodeCrcy', ProductValuationAccount, 'Edm.Decimal')

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

Static COMMERCIAL_PRICE_3_IN_CO_CODE_CRCY

COMMERCIAL_PRICE_3_IN_CO_CODE_CRCY: BigNumberField<ProductValuationAccount> = new BigNumberField('CommercialPrice3InCoCodeCrcy', ProductValuationAccount, 'Edm.Decimal')

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

Static DEVALUATION_YEAR_COUNT

DEVALUATION_YEAR_COUNT: StringField<ProductValuationAccount> = new StringField('DevaluationYearCount', ProductValuationAccount, 'Edm.String')

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

Static FUTURE_EVALUATED_AMOUNT_VALUE

FUTURE_EVALUATED_AMOUNT_VALUE: BigNumberField<ProductValuationAccount> = new BigNumberField('FutureEvaluatedAmountValue', ProductValuationAccount, 'Edm.Decimal')

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

Static FUTURE_PRICE_VALIDITY_START_DATE

FUTURE_PRICE_VALIDITY_START_DATE: DateField<ProductValuationAccount> = new DateField('FuturePriceValidityStartDate', ProductValuationAccount, 'Edm.DateTime')

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

Static IS_LIFO_AND_FIFO_RELEVANT

IS_LIFO_AND_FIFO_RELEVANT: BooleanField<ProductValuationAccount> = new BooleanField('IsLIFOAndFIFORelevant', ProductValuationAccount, 'Edm.Boolean')

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

Static LIFO_VALUATION_POOL_NUMBER

LIFO_VALUATION_POOL_NUMBER: StringField<ProductValuationAccount> = new StringField('LIFOValuationPoolNumber', ProductValuationAccount, 'Edm.String')

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

Static PRODUCT

PRODUCT: StringField<ProductValuationAccount> = new StringField('Product', ProductValuationAccount, 'Edm.String')

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

Static TAX_PRICEL_1_IN_CO_CODE_CRCY

TAX_PRICEL_1_IN_CO_CODE_CRCY: BigNumberField<ProductValuationAccount> = new BigNumberField('TaxPricel1InCoCodeCrcy', ProductValuationAccount, 'Edm.Decimal')

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

Static TAX_PRICE_2_IN_CO_CODE_CRCY

TAX_PRICE_2_IN_CO_CODE_CRCY: BigNumberField<ProductValuationAccount> = new BigNumberField('TaxPrice2InCoCodeCrcy', ProductValuationAccount, 'Edm.Decimal')

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

Static TAX_PRICE_3_IN_CO_CODE_CRCY

TAX_PRICE_3_IN_CO_CODE_CRCY: BigNumberField<ProductValuationAccount> = new BigNumberField('TaxPrice3InCoCodeCrcy', ProductValuationAccount, 'Edm.Decimal')

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

Static VALUATION_AREA

VALUATION_AREA: StringField<ProductValuationAccount> = new StringField('ValuationArea', ProductValuationAccount, 'Edm.String')

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

Static VALUATION_TYPE

VALUATION_TYPE: StringField<ProductValuationAccount> = new StringField('ValuationType', ProductValuationAccount, 'Edm.String')

Static representation of the valuationType 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<ProductValuationAccount> | BigNumberField<ProductValuationAccount> | DateField<ProductValuationAccount> | BooleanField<ProductValuationAccount>> = [ProductValuationAccount.PRODUCT,ProductValuationAccount.VALUATION_AREA,ProductValuationAccount.VALUATION_TYPE,ProductValuationAccount.COMMERCIAL_PRICE_1_IN_CO_CODE_CRCY,ProductValuationAccount.COMMERCIAL_PRICE_2_IN_CO_CODE_CRCY,ProductValuationAccount.COMMERCIAL_PRICE_3_IN_CO_CODE_CRCY,ProductValuationAccount.DEVALUATION_YEAR_COUNT,ProductValuationAccount.FUTURE_EVALUATED_AMOUNT_VALUE,ProductValuationAccount.FUTURE_PRICE_VALIDITY_START_DATE,ProductValuationAccount.IS_LIFO_AND_FIFO_RELEVANT,ProductValuationAccount.LIFO_VALUATION_POOL_NUMBER,ProductValuationAccount.TAX_PRICEL_1_IN_CO_CODE_CRCY,ProductValuationAccount.TAX_PRICE_2_IN_CO_CODE_CRCY,ProductValuationAccount.TAX_PRICE_3_IN_CO_CODE_CRCY]

All fields of the ProductValuationAccount entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductValuationAccount"

Technical entity name for ProductValuationAccount.

Static _keyFields

_keyFields: Array<Selectable<ProductValuationAccount>> = [ProductValuationAccount.PRODUCT, ProductValuationAccount.VALUATION_AREA, ProductValuationAccount.VALUATION_TYPE]

All key fields of the ProductValuationAccount entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_PRODUCT_SRV"
deprecated

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

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 ProductValuationAccount.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductValuationAccount>

    A builder that constructs instances of entity type ProductValuationAccount.

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 ProductValuationAccount entity type.

    Returns ProductValuationAccountRequestBuilder

    A ProductValuationAccount request builder.