Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_FinPlanningEntryItem" of service "API_FINPLANNINGENTRYITEM_SRV". This service is part of the following communication scenarios: SAP Business Objects Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_FINPLANNINGENTRYITEM_SRV for more information.

Hierarchy

  • Entity
    • FinPlanningEntryItem

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns FinPlanningEntryItem

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 amountInCompanyCodeCurrency

amountInCompanyCodeCurrency: BigNumber

Amount in Company Code Currency.

nullable

Optional amountInGlobalCurrency

amountInGlobalCurrency: BigNumber

Amount in Global Currency.

nullable

Optional amountInTransactionCurrency

amountInTransactionCurrency: BigNumber

Amount in Transaction Currency.

nullable

Optional businessArea

businessArea: string

Business Area. Maximum length: 4.

nullable

Optional businessAreaName

businessAreaName: string

Business Area Name. Maximum length: 30.

nullable

Optional chartOfAccounts

chartOfAccounts: string

Chart of Accounts. Maximum length: 4.

nullable

Optional companyCode

companyCode: string

Company Code. Maximum length: 4.

nullable

Optional companyCodeCurrency

companyCodeCurrency: string

Company Code Currency. Maximum length: 5.

nullable

Optional companyCodeName

companyCodeName: string

Company Code Name. Maximum length: 25.

nullable

Optional controllingArea

controllingArea: string

Controlling Area. Maximum length: 4.

nullable

Optional controllingAreaName

controllingAreaName: string

Controlling Area Name. Maximum length: 25.

nullable

Optional controllingDebitCreditCode

controllingDebitCreditCode: string

CO Debit/Credit Indicator. Maximum length: 1.

nullable

Optional costCenter

costCenter: string

Cost Center. Maximum length: 10.

nullable

Optional costCenterName

costCenterName: string

Cost Center Name. Maximum length: 20.

nullable

Optional costCtrActivityType

costCtrActivityType: string

Activity Type. Key uniquely identifying . Activity types describe the activity produced by a cost center and are measured in units of time or quantity. In activity type planning, control data determines whether the activity price for evaluation of the activity type is manually set or is derived iteratively through activity price calculation. Maximum length: 6.

nullable

Optional costCtrActivityTypeName

costCtrActivityTypeName: string

Activity Type Name. Maximum length: 60.

nullable

Optional customer

customer: string

Customer Number. Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system. Maximum length: 10.

nullable

Optional customerGroup

customerGroup: string

Customer Group. Identifies a particular group of customers (for example, wholesale or retail) for the purpose of pricing or generating statistics. Maximum length: 2.

nullable

Optional customerGroupName

customerGroupName: string

Name of Customer Group. Maximum length: 30.

nullable

Optional customerName

customerName: string

Name of Customer. Maximum length: 80.

nullable

Optional customerSupplierCountry

customerSupplierCountry: string

Country of Customer or Supplier. Maximum length: 3.

nullable

Optional customerSupplierCountryName

customerSupplierCountryName: string

Country Name of Customer/Supplier. Maximum length: 15.

nullable

Optional customerSupplierIndustry

customerSupplierIndustry: string

Industry Key. Maximum length: 4.

nullable

Optional customerSupplierIndustryName

customerSupplierIndustryName: string

Customer Supplier Industry Name. Maximum length: 20.

nullable

Optional distributionChannel

distributionChannel: string

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.

nullable

Optional distributionChannelName

distributionChannelName: string

Name of Distribution Channel. Maximum length: 20.

nullable

Optional division

division: string

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.

nullable

Optional divisionName

divisionName: string

Name of Division. Maximum length: 30.

nullable

Optional fiscalPeriod

fiscalPeriod: string

Fiscal Period. A fiscal period is a self-contained part of a fiscal year. Every business transaction is allocated to a fiscal period. Examples of period classifications: Per calendar month -> 12 fiscal periods Every 4 weeks -> 13 fiscal periods Weekly -> 52 or 53 fiscal periods. Maximum length: 3.

nullable

Optional fiscalYearPeriod

fiscalYearPeriod: string

Fiscal Year Period. Maximum length: 8.

nullable

Optional fiscalYearVariant

fiscalYearVariant: string

Fiscal Year Variant. Maximum length: 2.

nullable

Optional functionalArea

functionalArea: string

Functional Area. Used to structure a public organization or enterprise according to functional criteria. The functional area is required in Funds Management in order to fulfill legal reporting requirements subdividing an organization into functions. You can use the functional area to map global aims and purposes, for example, public safety, town planning, and the expenditures of your organization. For more information on the functional area, see the Implementation Guide of Funds Management Government, section Functional Area in Funds Management Government. Maximum length: 16.

nullable

Optional functionalAreaName

functionalAreaName: string

Functional Area Name. Maximum length: 30.

nullable

Optional glAccount

glAccount: string

G/L Account. Maximum length: 10.

nullable

Optional glAccountName

glAccountName: string

G/L Account Name. Maximum length: 30.

nullable

Optional globalCurrency

globalCurrency: string

Global Currency. Maximum length: 5.

nullable

id

id: string

Id.

Optional ledger

ledger: string

Ledger. Maximum length: 2.

nullable

Optional ledgerFiscalYear

ledgerFiscalYear: string

Ledger Fiscal Year. Maximum length: 4.

nullable

Optional ledgerName

ledgerName: string

Ledger Name. Maximum length: 30.

nullable

Optional materialGroup

materialGroup: string

Product Sold Group. Material group of the product sold This can differ from the material group of the material moved or service rendered, for example if the material consumed for a project differs from the product sold of the sales order related to the project. Maximum length: 9.

nullable

Optional materialGroupName

materialGroupName: string

Product Group Description. Maximum length: 20.

nullable

Optional orderId

orderId: string

Order ID. Maximum length: 12.

nullable

Optional partnerBusinessArea

partnerBusinessArea: string

Partner Business Area. Business area of the business partner. In each line item, a sender-receiver relationship is established in connection with the business area with which the posting is made. This relationship enables internal business volume to be eliminated at the business area level (as part of business area consolidation). Maximum length: 4.

nullable

Optional partnerBusinessAreaName

partnerBusinessAreaName: string

Partner Business Area Name. Maximum length: 30.

nullable

Optional partnerCompany

partnerCompany: string

Company ID of Trading Partner. Corporate-wide, unique company ID in your group. Maximum length: 6.

nullable

Optional partnerCompanyCode

partnerCompanyCode: string

Company Code of Partner. Maximum length: 4.

nullable

Optional partnerCompanyCodeName

partnerCompanyCodeName: string

Partner Company Code Name. Maximum length: 25.

nullable

Optional partnerCompanyName

partnerCompanyName: string

Company Name. Maximum length: 30.

nullable

Optional partnerCostCenter

partnerCostCenter: string

Partner Cost Center. The sender cost center is a cost center from which costs, revenues, or activities are charged to other cost centers or orders. This cost center is credited with the amount of incurred costs using a cost element. Maximum length: 10.

nullable

Optional partnerCostCenterName

partnerCostCenterName: string

Partner Cost Center Name. Maximum length: 20.

nullable

Optional partnerCostCtrActivityType

partnerCostCtrActivityType: string

Partner Cost Center Activity Type. Maximum length: 6.

nullable

Optional partnerCostCtrActivityTypeName

partnerCostCtrActivityTypeName: string

Partner Activity Type Name. Maximum length: 60.

nullable

Optional partnerFunctionalArea

partnerFunctionalArea: string

Partner Functional Area. Structure criterion for an enterprise or government based on functional aspects. Use for Cost-of-Sales Accounting The functional area is required to create a profit and loss account in Financial Accounting using cost-of-sales accounting. The following are examples of structure criteria: Manufacturing Administration Sales Research and development Use for Government The functional area is needed for Funds Management to meet legal requirements for reporting with functional aspects. You can use the functional area to represent the global targets and goals (such as public safety or city development), in particular the expenses of your organization. Use in cost-of-sales accounting See the documentation on Filling the Functional Area Field. For comprehensive information on cost-of-sales accounting and on the functional area, see the SAP Library under Accounting -> Financial Accounting -> General Ledger -> Cost-of-Sales Accounting. Use in government For more information on the functional area, see the implementation Guide for Funds Management Government in the section Activate Account Assignment Elements. Maximum length: 16.

nullable

Optional partnerFunctionalAreaName

partnerFunctionalAreaName: string

Partner Functional Area Name. Maximum length: 30.

nullable

Optional partnerOrder

partnerOrder: string

Partner Order. Maximum length: 12.

nullable

Optional partnerProfitCenter

partnerProfitCenter: string

Partner Profit Center. The partner profit center identifies the service and delivery relationships between profit centers. In the case of the receiver of a service/delivery, the sending profit center is entered as the partner profit center and vice versa. Maximum length: 10.

nullable

Optional partnerProfitCenterName

partnerProfitCenterName: string

Partner Profit Center Name. Maximum length: 50.

nullable

Optional partnerProject

partnerProject: string

Partner Project. Maximum length: 24.

nullable

Optional partnerProjectDescription

partnerProjectDescription: string

Partner Project Description (1st text line). Maximum length: 40.

nullable

Optional partnerSegment

partnerSegment: string

Partner Segment for Segmental Reporting. Maximum length: 10.

nullable

Optional partnerSegmentName

partnerSegmentName: string

Partner Segment Name. Maximum length: 50.

nullable

Optional partnerWbsElement

partnerWbsElement: string

Partner WBS Element. Maximum length: 24.

nullable

Optional partnerWbsElementDescription

partnerWbsElementDescription: string

Partner Project Description (1st text line). Maximum length: 40.

nullable

Optional planningCategory

planningCategory: string

Category. Specifies the BPC category. Categories from SAP Business Planning & Consolidation are mapped in Real-Time Consolidation to consolidation versions. This mapping is defined in the Model transaction (RTCMD) under the Version tab. Maximum length: 10.

nullable

Optional plant

plant: string

Plant. Key uniquely identifying a plant. Maximum length: 4.

nullable

Optional plantName

plantName: string

Plant Name. Maximum length: 30.

nullable

Optional profitCenter

profitCenter: string

Profit Center. Maximum length: 10.

nullable

Optional profitCenterName

profitCenterName: string

Profit Center Name. Maximum length: 20.

nullable

Optional project

project: string

Project definition. Key identifying a project definition. Maximum length: 24.

nullable

Optional projectDescription

projectDescription: string

Project Description. Maximum length: 40.

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

Optional salesDistrict

salesDistrict: string

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.

nullable

Optional salesDistrictName

salesDistrictName: string

Name of the district. Maximum length: 20.

nullable

Optional salesOrganization

salesOrganization: string

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.

nullable

Optional salesOrganizationName

salesOrganizationName: string

Name of Sales Organization. Maximum length: 20.

nullable

Optional segment

segment: string

Segment for Segmental Reporting. Maximum length: 10.

nullable

Optional segmentName

segmentName: string

Segment Name. Maximum length: 50.

nullable

Optional soldMaterial

soldMaterial: string

Product Sold. Identifier of the product used in the sales process. This can differ from the material moved or service rendered, for example if the material consumed for a project differs from the product sold of the sales order related to the project. Maximum length: 40.

nullable

Optional soldMaterialName

soldMaterialName: string

Sold Material Name. Maximum length: 40.

nullable

toCompanyCode

toCompanyCode: CompanyCode

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

toCurrentCostCenter

toCurrentCostCenter: CostCenter

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

toCurrentProfitCenter

toCurrentProfitCenter: ProfitCenter

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

Optional transactionCurrency

transactionCurrency: string

Transaction Currency. Maximum length: 5.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional wbsElement

wbsElement: string

Work Breakdown Structure Element (WBS Element). Key identifying a WBS element. Maximum length: 24.

nullable

Optional wbsElementDescription

wbsElementDescription: string

PS: Short description (1st text line). Maximum length: 40.

nullable

Static ALL_FIELDS

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

All fields selector.

Static AMOUNT_IN_COMPANY_CODE_CURRENCY

AMOUNT_IN_COMPANY_CODE_CURRENCY: BigNumberField<FinPlanningEntryItem> = new BigNumberField('AmountInCompanyCodeCurrency', FinPlanningEntryItem, 'Edm.Decimal')

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

Static AMOUNT_IN_GLOBAL_CURRENCY

AMOUNT_IN_GLOBAL_CURRENCY: BigNumberField<FinPlanningEntryItem> = new BigNumberField('AmountInGlobalCurrency', FinPlanningEntryItem, 'Edm.Decimal')

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

Static AMOUNT_IN_TRANSACTION_CURRENCY

AMOUNT_IN_TRANSACTION_CURRENCY: BigNumberField<FinPlanningEntryItem> = new BigNumberField('AmountInTransactionCurrency', FinPlanningEntryItem, 'Edm.Decimal')

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

Static BUSINESS_AREA

BUSINESS_AREA: StringField<FinPlanningEntryItem> = new StringField('BusinessArea', FinPlanningEntryItem, 'Edm.String')

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

Static BUSINESS_AREA_NAME

BUSINESS_AREA_NAME: StringField<FinPlanningEntryItem> = new StringField('BusinessAreaName', FinPlanningEntryItem, 'Edm.String')

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

Static CHART_OF_ACCOUNTS

CHART_OF_ACCOUNTS: StringField<FinPlanningEntryItem> = new StringField('ChartOfAccounts', FinPlanningEntryItem, 'Edm.String')

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

Static COMPANY_CODE

COMPANY_CODE: StringField<FinPlanningEntryItem> = new StringField('CompanyCode', FinPlanningEntryItem, 'Edm.String')

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

Static COMPANY_CODE_CURRENCY

COMPANY_CODE_CURRENCY: StringField<FinPlanningEntryItem> = new StringField('CompanyCodeCurrency', FinPlanningEntryItem, 'Edm.String')

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

Static COMPANY_CODE_NAME

COMPANY_CODE_NAME: StringField<FinPlanningEntryItem> = new StringField('CompanyCodeName', FinPlanningEntryItem, 'Edm.String')

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

Static CONTROLLING_AREA

CONTROLLING_AREA: StringField<FinPlanningEntryItem> = new StringField('ControllingArea', FinPlanningEntryItem, 'Edm.String')

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

Static CONTROLLING_AREA_NAME

CONTROLLING_AREA_NAME: StringField<FinPlanningEntryItem> = new StringField('ControllingAreaName', FinPlanningEntryItem, 'Edm.String')

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

Static CONTROLLING_DEBIT_CREDIT_CODE

CONTROLLING_DEBIT_CREDIT_CODE: StringField<FinPlanningEntryItem> = new StringField('ControllingDebitCreditCode', FinPlanningEntryItem, 'Edm.String')

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

Static COST_CENTER

COST_CENTER: StringField<FinPlanningEntryItem> = new StringField('CostCenter', FinPlanningEntryItem, 'Edm.String')

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

Static COST_CENTER_NAME

COST_CENTER_NAME: StringField<FinPlanningEntryItem> = new StringField('CostCenterName', FinPlanningEntryItem, 'Edm.String')

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

Static COST_CTR_ACTIVITY_TYPE

COST_CTR_ACTIVITY_TYPE: StringField<FinPlanningEntryItem> = new StringField('CostCtrActivityType', FinPlanningEntryItem, 'Edm.String')

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

Static COST_CTR_ACTIVITY_TYPE_NAME

COST_CTR_ACTIVITY_TYPE_NAME: StringField<FinPlanningEntryItem> = new StringField('CostCtrActivityTypeName', FinPlanningEntryItem, 'Edm.String')

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

Static CUSTOMER

CUSTOMER: StringField<FinPlanningEntryItem> = new StringField('Customer', FinPlanningEntryItem, 'Edm.String')

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 CUSTOMER_GROUP

CUSTOMER_GROUP: StringField<FinPlanningEntryItem> = new StringField('CustomerGroup', FinPlanningEntryItem, 'Edm.String')

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

Static CUSTOMER_GROUP_NAME

CUSTOMER_GROUP_NAME: StringField<FinPlanningEntryItem> = new StringField('CustomerGroupName', FinPlanningEntryItem, 'Edm.String')

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

Static CUSTOMER_NAME

CUSTOMER_NAME: StringField<FinPlanningEntryItem> = new StringField('CustomerName', FinPlanningEntryItem, 'Edm.String')

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

Static CUSTOMER_SUPPLIER_COUNTRY

CUSTOMER_SUPPLIER_COUNTRY: StringField<FinPlanningEntryItem> = new StringField('CustomerSupplierCountry', FinPlanningEntryItem, 'Edm.String')

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

Static CUSTOMER_SUPPLIER_COUNTRY_NAME

CUSTOMER_SUPPLIER_COUNTRY_NAME: StringField<FinPlanningEntryItem> = new StringField('CustomerSupplierCountryName', FinPlanningEntryItem, 'Edm.String')

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

Static CUSTOMER_SUPPLIER_INDUSTRY

CUSTOMER_SUPPLIER_INDUSTRY: StringField<FinPlanningEntryItem> = new StringField('CustomerSupplierIndustry', FinPlanningEntryItem, 'Edm.String')

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

Static CUSTOMER_SUPPLIER_INDUSTRY_NAME

CUSTOMER_SUPPLIER_INDUSTRY_NAME: StringField<FinPlanningEntryItem> = new StringField('CustomerSupplierIndustryName', FinPlanningEntryItem, 'Edm.String')

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

Static DISTRIBUTION_CHANNEL

DISTRIBUTION_CHANNEL: StringField<FinPlanningEntryItem> = new StringField('DistributionChannel', FinPlanningEntryItem, 'Edm.String')

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 DISTRIBUTION_CHANNEL_NAME

DISTRIBUTION_CHANNEL_NAME: StringField<FinPlanningEntryItem> = new StringField('DistributionChannelName', FinPlanningEntryItem, 'Edm.String')

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

Static DIVISION

DIVISION: StringField<FinPlanningEntryItem> = new StringField('Division', FinPlanningEntryItem, 'Edm.String')

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

Static DIVISION_NAME

DIVISION_NAME: StringField<FinPlanningEntryItem> = new StringField('DivisionName', FinPlanningEntryItem, 'Edm.String')

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

Static FISCAL_PERIOD

FISCAL_PERIOD: StringField<FinPlanningEntryItem> = new StringField('FiscalPeriod', FinPlanningEntryItem, 'Edm.String')

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 FISCAL_YEAR_PERIOD

FISCAL_YEAR_PERIOD: StringField<FinPlanningEntryItem> = new StringField('FiscalYearPeriod', FinPlanningEntryItem, 'Edm.String')

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

Static FISCAL_YEAR_VARIANT

FISCAL_YEAR_VARIANT: StringField<FinPlanningEntryItem> = new StringField('FiscalYearVariant', FinPlanningEntryItem, 'Edm.String')

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

Static FUNCTIONAL_AREA

FUNCTIONAL_AREA: StringField<FinPlanningEntryItem> = new StringField('FunctionalArea', FinPlanningEntryItem, 'Edm.String')

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

Static FUNCTIONAL_AREA_NAME

FUNCTIONAL_AREA_NAME: StringField<FinPlanningEntryItem> = new StringField('FunctionalAreaName', FinPlanningEntryItem, 'Edm.String')

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

Static GLOBAL_CURRENCY

GLOBAL_CURRENCY: StringField<FinPlanningEntryItem> = new StringField('GlobalCurrency', FinPlanningEntryItem, 'Edm.String')

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

Static GL_ACCOUNT

GL_ACCOUNT: StringField<FinPlanningEntryItem> = new StringField('GLAccount', FinPlanningEntryItem, 'Edm.String')

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

Static GL_ACCOUNT_NAME

GL_ACCOUNT_NAME: StringField<FinPlanningEntryItem> = new StringField('GLAccountName', FinPlanningEntryItem, 'Edm.String')

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

Static ID

ID: StringField<FinPlanningEntryItem> = new StringField('ID', FinPlanningEntryItem, 'Edm.String')

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

Static LEDGER

LEDGER: StringField<FinPlanningEntryItem> = new StringField('Ledger', FinPlanningEntryItem, 'Edm.String')

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

Static LEDGER_FISCAL_YEAR

LEDGER_FISCAL_YEAR: StringField<FinPlanningEntryItem> = new StringField('LedgerFiscalYear', FinPlanningEntryItem, 'Edm.String')

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

Static LEDGER_NAME

LEDGER_NAME: StringField<FinPlanningEntryItem> = new StringField('LedgerName', FinPlanningEntryItem, 'Edm.String')

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

Static MATERIAL_GROUP

MATERIAL_GROUP: StringField<FinPlanningEntryItem> = new StringField('MaterialGroup', FinPlanningEntryItem, 'Edm.String')

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

Static MATERIAL_GROUP_NAME

MATERIAL_GROUP_NAME: StringField<FinPlanningEntryItem> = new StringField('MaterialGroupName', FinPlanningEntryItem, 'Edm.String')

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

Static ORDER_ID

ORDER_ID: StringField<FinPlanningEntryItem> = new StringField('OrderID', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_BUSINESS_AREA

PARTNER_BUSINESS_AREA: StringField<FinPlanningEntryItem> = new StringField('PartnerBusinessArea', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_BUSINESS_AREA_NAME

PARTNER_BUSINESS_AREA_NAME: StringField<FinPlanningEntryItem> = new StringField('PartnerBusinessAreaName', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_COMPANY

PARTNER_COMPANY: StringField<FinPlanningEntryItem> = new StringField('PartnerCompany', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_COMPANY_CODE

PARTNER_COMPANY_CODE: StringField<FinPlanningEntryItem> = new StringField('PartnerCompanyCode', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_COMPANY_CODE_NAME

PARTNER_COMPANY_CODE_NAME: StringField<FinPlanningEntryItem> = new StringField('PartnerCompanyCodeName', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_COMPANY_NAME

PARTNER_COMPANY_NAME: StringField<FinPlanningEntryItem> = new StringField('PartnerCompanyName', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_COST_CENTER

PARTNER_COST_CENTER: StringField<FinPlanningEntryItem> = new StringField('PartnerCostCenter', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_COST_CENTER_NAME

PARTNER_COST_CENTER_NAME: StringField<FinPlanningEntryItem> = new StringField('PartnerCostCenterName', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_COST_CTR_ACTIVITY_TYPE

PARTNER_COST_CTR_ACTIVITY_TYPE: StringField<FinPlanningEntryItem> = new StringField('PartnerCostCtrActivityType', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_COST_CTR_ACTIVITY_TYPE_NAME

PARTNER_COST_CTR_ACTIVITY_TYPE_NAME: StringField<FinPlanningEntryItem> = new StringField('PartnerCostCtrActivityTypeName', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_FUNCTIONAL_AREA

PARTNER_FUNCTIONAL_AREA: StringField<FinPlanningEntryItem> = new StringField('PartnerFunctionalArea', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_FUNCTIONAL_AREA_NAME

PARTNER_FUNCTIONAL_AREA_NAME: StringField<FinPlanningEntryItem> = new StringField('PartnerFunctionalAreaName', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_ORDER

PARTNER_ORDER: StringField<FinPlanningEntryItem> = new StringField('PartnerOrder', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_PROFIT_CENTER

PARTNER_PROFIT_CENTER: StringField<FinPlanningEntryItem> = new StringField('PartnerProfitCenter', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_PROFIT_CENTER_NAME

PARTNER_PROFIT_CENTER_NAME: StringField<FinPlanningEntryItem> = new StringField('PartnerProfitCenterName', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_PROJECT

PARTNER_PROJECT: StringField<FinPlanningEntryItem> = new StringField('PartnerProject', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_PROJECT_DESCRIPTION

PARTNER_PROJECT_DESCRIPTION: StringField<FinPlanningEntryItem> = new StringField('PartnerProjectDescription', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_SEGMENT

PARTNER_SEGMENT: StringField<FinPlanningEntryItem> = new StringField('PartnerSegment', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_SEGMENT_NAME

PARTNER_SEGMENT_NAME: StringField<FinPlanningEntryItem> = new StringField('PartnerSegmentName', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_WBS_ELEMENT

PARTNER_WBS_ELEMENT: StringField<FinPlanningEntryItem> = new StringField('PartnerWBSElement', FinPlanningEntryItem, 'Edm.String')

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

Static PARTNER_WBS_ELEMENT_DESCRIPTION

PARTNER_WBS_ELEMENT_DESCRIPTION: StringField<FinPlanningEntryItem> = new StringField('PartnerWBSElementDescription', FinPlanningEntryItem, 'Edm.String')

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

Static PLANNING_CATEGORY

PLANNING_CATEGORY: StringField<FinPlanningEntryItem> = new StringField('PlanningCategory', FinPlanningEntryItem, 'Edm.String')

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

Static PLANT

PLANT: StringField<FinPlanningEntryItem> = new StringField('Plant', FinPlanningEntryItem, 'Edm.String')

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 PLANT_NAME

PLANT_NAME: StringField<FinPlanningEntryItem> = new StringField('PlantName', FinPlanningEntryItem, 'Edm.String')

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

Static PROFIT_CENTER

PROFIT_CENTER: StringField<FinPlanningEntryItem> = new StringField('ProfitCenter', FinPlanningEntryItem, 'Edm.String')

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

Static PROFIT_CENTER_NAME

PROFIT_CENTER_NAME: StringField<FinPlanningEntryItem> = new StringField('ProfitCenterName', FinPlanningEntryItem, 'Edm.String')

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

Static PROJECT

PROJECT: StringField<FinPlanningEntryItem> = new StringField('Project', FinPlanningEntryItem, 'Edm.String')

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

Static PROJECT_DESCRIPTION

PROJECT_DESCRIPTION: StringField<FinPlanningEntryItem> = new StringField('ProjectDescription', FinPlanningEntryItem, 'Edm.String')

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

Static SALES_DISTRICT

SALES_DISTRICT: StringField<FinPlanningEntryItem> = new StringField('SalesDistrict', FinPlanningEntryItem, 'Edm.String')

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 SALES_DISTRICT_NAME

SALES_DISTRICT_NAME: StringField<FinPlanningEntryItem> = new StringField('SalesDistrictName', FinPlanningEntryItem, 'Edm.String')

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

Static SALES_ORGANIZATION

SALES_ORGANIZATION: StringField<FinPlanningEntryItem> = new StringField('SalesOrganization', FinPlanningEntryItem, 'Edm.String')

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 SALES_ORGANIZATION_NAME

SALES_ORGANIZATION_NAME: StringField<FinPlanningEntryItem> = new StringField('SalesOrganizationName', FinPlanningEntryItem, 'Edm.String')

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

Static SEGMENT

SEGMENT: StringField<FinPlanningEntryItem> = new StringField('Segment', FinPlanningEntryItem, 'Edm.String')

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

Static SEGMENT_NAME

SEGMENT_NAME: StringField<FinPlanningEntryItem> = new StringField('SegmentName', FinPlanningEntryItem, 'Edm.String')

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

Static SOLD_MATERIAL

SOLD_MATERIAL: StringField<FinPlanningEntryItem> = new StringField('SoldMaterial', FinPlanningEntryItem, 'Edm.String')

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

Static SOLD_MATERIAL_NAME

SOLD_MATERIAL_NAME: StringField<FinPlanningEntryItem> = new StringField('SoldMaterialName', FinPlanningEntryItem, 'Edm.String')

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

Static TO_COMPANY_CODE

TO_COMPANY_CODE: OneToOneLink<FinPlanningEntryItem, CompanyCode> = new OneToOneLink('to_CompanyCode', FinPlanningEntryItem, CompanyCode)

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

Static TO_CURRENT_COST_CENTER

TO_CURRENT_COST_CENTER: OneToOneLink<FinPlanningEntryItem, CostCenter> = new OneToOneLink('to_CurrentCostCenter', FinPlanningEntryItem, CostCenter)

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

Static TO_CURRENT_PROFIT_CENTER

TO_CURRENT_PROFIT_CENTER: OneToOneLink<FinPlanningEntryItem, ProfitCenter> = new OneToOneLink('to_CurrentProfitCenter', FinPlanningEntryItem, ProfitCenter)

Static representation of the one-to-one navigation property toCurrentProfitCenter 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<FinPlanningEntryItem> = new StringField('TransactionCurrency', FinPlanningEntryItem, '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 WBS_ELEMENT

WBS_ELEMENT: StringField<FinPlanningEntryItem> = new StringField('WBSElement', FinPlanningEntryItem, 'Edm.String')

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

Static WBS_ELEMENT_DESCRIPTION

WBS_ELEMENT_DESCRIPTION: StringField<FinPlanningEntryItem> = new StringField('WBSElementDescription', FinPlanningEntryItem, 'Edm.String')

Static representation of the wbsElementDescription 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<FinPlanningEntryItem> | BigNumberField<FinPlanningEntryItem> | OneToOneLink<FinPlanningEntryItem, CompanyCode> | OneToOneLink<FinPlanningEntryItem, CostCenter> | OneToOneLink<FinPlanningEntryItem, ProfitCenter>> = [FinPlanningEntryItem.ID,FinPlanningEntryItem.LEDGER,FinPlanningEntryItem.LEDGER_NAME,FinPlanningEntryItem.PLANNING_CATEGORY,FinPlanningEntryItem.LEDGER_FISCAL_YEAR,FinPlanningEntryItem.GL_ACCOUNT,FinPlanningEntryItem.GL_ACCOUNT_NAME,FinPlanningEntryItem.COMPANY_CODE,FinPlanningEntryItem.COMPANY_CODE_NAME,FinPlanningEntryItem.COST_CENTER,FinPlanningEntryItem.COST_CENTER_NAME,FinPlanningEntryItem.PROFIT_CENTER,FinPlanningEntryItem.PROFIT_CENTER_NAME,FinPlanningEntryItem.FUNCTIONAL_AREA,FinPlanningEntryItem.FUNCTIONAL_AREA_NAME,FinPlanningEntryItem.BUSINESS_AREA,FinPlanningEntryItem.BUSINESS_AREA_NAME,FinPlanningEntryItem.CONTROLLING_AREA,FinPlanningEntryItem.CONTROLLING_AREA_NAME,FinPlanningEntryItem.SEGMENT,FinPlanningEntryItem.SEGMENT_NAME,FinPlanningEntryItem.PARTNER_COST_CENTER,FinPlanningEntryItem.PARTNER_COST_CENTER_NAME,FinPlanningEntryItem.PARTNER_PROFIT_CENTER,FinPlanningEntryItem.PARTNER_PROFIT_CENTER_NAME,FinPlanningEntryItem.PARTNER_FUNCTIONAL_AREA,FinPlanningEntryItem.PARTNER_FUNCTIONAL_AREA_NAME,FinPlanningEntryItem.PARTNER_BUSINESS_AREA,FinPlanningEntryItem.PARTNER_BUSINESS_AREA_NAME,FinPlanningEntryItem.PARTNER_COMPANY,FinPlanningEntryItem.PARTNER_COMPANY_NAME,FinPlanningEntryItem.PARTNER_SEGMENT,FinPlanningEntryItem.PARTNER_SEGMENT_NAME,FinPlanningEntryItem.TRANSACTION_CURRENCY,FinPlanningEntryItem.AMOUNT_IN_TRANSACTION_CURRENCY,FinPlanningEntryItem.COMPANY_CODE_CURRENCY,FinPlanningEntryItem.AMOUNT_IN_COMPANY_CODE_CURRENCY,FinPlanningEntryItem.GLOBAL_CURRENCY,FinPlanningEntryItem.AMOUNT_IN_GLOBAL_CURRENCY,FinPlanningEntryItem.FISCAL_PERIOD,FinPlanningEntryItem.FISCAL_YEAR_VARIANT,FinPlanningEntryItem.FISCAL_YEAR_PERIOD,FinPlanningEntryItem.CHART_OF_ACCOUNTS,FinPlanningEntryItem.PLANT,FinPlanningEntryItem.PLANT_NAME,FinPlanningEntryItem.CUSTOMER,FinPlanningEntryItem.CUSTOMER_NAME,FinPlanningEntryItem.CONTROLLING_DEBIT_CREDIT_CODE,FinPlanningEntryItem.PROJECT,FinPlanningEntryItem.PROJECT_DESCRIPTION,FinPlanningEntryItem.WBS_ELEMENT,FinPlanningEntryItem.WBS_ELEMENT_DESCRIPTION,FinPlanningEntryItem.PARTNER_COMPANY_CODE,FinPlanningEntryItem.PARTNER_COMPANY_CODE_NAME,FinPlanningEntryItem.COST_CTR_ACTIVITY_TYPE,FinPlanningEntryItem.COST_CTR_ACTIVITY_TYPE_NAME,FinPlanningEntryItem.ORDER_ID,FinPlanningEntryItem.PARTNER_ORDER,FinPlanningEntryItem.PARTNER_COST_CTR_ACTIVITY_TYPE,FinPlanningEntryItem.PARTNER_COST_CTR_ACTIVITY_TYPE_NAME,FinPlanningEntryItem.PARTNER_PROJECT,FinPlanningEntryItem.PARTNER_PROJECT_DESCRIPTION,FinPlanningEntryItem.PARTNER_WBS_ELEMENT,FinPlanningEntryItem.PARTNER_WBS_ELEMENT_DESCRIPTION,FinPlanningEntryItem.SALES_ORGANIZATION,FinPlanningEntryItem.SALES_ORGANIZATION_NAME,FinPlanningEntryItem.DISTRIBUTION_CHANNEL,FinPlanningEntryItem.DISTRIBUTION_CHANNEL_NAME,FinPlanningEntryItem.DIVISION,FinPlanningEntryItem.DIVISION_NAME,FinPlanningEntryItem.SOLD_MATERIAL,FinPlanningEntryItem.SOLD_MATERIAL_NAME,FinPlanningEntryItem.MATERIAL_GROUP,FinPlanningEntryItem.MATERIAL_GROUP_NAME,FinPlanningEntryItem.CUSTOMER_GROUP,FinPlanningEntryItem.CUSTOMER_GROUP_NAME,FinPlanningEntryItem.CUSTOMER_SUPPLIER_COUNTRY,FinPlanningEntryItem.CUSTOMER_SUPPLIER_COUNTRY_NAME,FinPlanningEntryItem.CUSTOMER_SUPPLIER_INDUSTRY,FinPlanningEntryItem.CUSTOMER_SUPPLIER_INDUSTRY_NAME,FinPlanningEntryItem.SALES_DISTRICT,FinPlanningEntryItem.SALES_DISTRICT_NAME,FinPlanningEntryItem.TO_COMPANY_CODE,FinPlanningEntryItem.TO_CURRENT_COST_CENTER,FinPlanningEntryItem.TO_CURRENT_PROFIT_CENTER]

All fields of the FinPlanningEntryItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_FinPlanningEntryItem"

Technical entity name for FinPlanningEntryItem.

Static _keyFields

_keyFields: Array<Selectable<FinPlanningEntryItem>> = [FinPlanningEntryItem.ID]

All key fields of the FinPlanningEntryItem entity.

Static _keys

_keys: object = FinPlanningEntryItem._keyFields.reduce((acc: { [keys: string]: Selectable<FinPlanningEntryItem> }, field: Selectable<FinPlanningEntryItem>) => {acc[field.fieldName] = field;return acc;}, {})

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

Type declaration

Static _serviceName

_serviceName: string = "API_FINPLANNINGENTRYITEM_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<FinPlanningEntryItem>

    A builder that constructs instances of entity type FinPlanningEntryItem.

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, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns FinPlanningEntryItemRequestBuilder

    A FinPlanningEntryItem request builder.