Crm.Sales.ForecastItems Entity

Namespace: Crm.Sales

Forecast items form demand in MRP calculations. Entity: Crm_Forecast_Items

Renames

Old name: Crm.Marketing.ForecastItems
New name: Crm.Sales.ForecastItems
Version: 25.1.1.48
Case: 37717

Default Visualization

Default Display Text Format:
{Id}: {QuantityValue}
Default Search Members:
__
Category: Views
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Crm.Sales.ForecastItems

Attributes

Name	Type	Description
Date	datetime	The date for which the sales is forecasted. When forecasting for a period, this contains the first date of the period. `Required` `Filter(ge;le)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsActive	boolean	Indicates whether the current Forecast item is active. `Required` `Default(true)` `Filter(eq)` `Introduced in version 25.1.0.18`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Quantity	Quantity (18, 3)	The forecasted sales quantity in the base measurement category of the product. `Unit: Product.BaseMeasurementCategory.BaseUnit` `Required` `Default(0)` `Filter(ge;le)`

References

Name	Type	Description
Country	Countries (nullable)	The country for which the forecast is made. When null, the forecast is country neutral. `Filter(multi eq)`
Customer	Customers (nullable)	The customer for which the forecast is made. When null, the forecast is not for any specfic customer. `Filter(multi eq)`
Dealer	Dealers (nullable)	The dealer for which the forecast is made. When null, the forecast is not for any specfic dealer. `Filter(multi eq)`
Product	Products	The product for which the forecast is made. `Required` `Filter(multi eq)`
SalesPerson	SalesPersons (nullable)	The sales person for which the forecast is made. When null, the forecast is not for any specfic sales person. `Filter(multi eq)`
Store	Stores	The store which is expected to sell the products. `Required` `Filter(multi eq)`

Attribute Details

Date

The date for which the sales is forecasted. When forecasting for a period, this contains the first date of the period. Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsActive

Indicates whether the current Forecast item is active. Required Default(true) Filter(eq) Introduced in version 25.1.0.18

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Quantity

The forecasted sales quantity in the base measurement category of the product. Unit: Product.BaseMeasurementCategory.BaseUnit Required Default(0) Filter(ge;le)

Type: Quantity (18, 3)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

Reference Details

Country

The country for which the forecast is made. When null, the forecast is country neutral. Filter(multi eq)

Type: Countries (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Customer

The customer for which the forecast is made. When null, the forecast is not for any specfic customer. Filter(multi eq)

Type: Customers (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Dealer

The dealer for which the forecast is made. When null, the forecast is not for any specfic dealer. Filter(multi eq)

Type: Dealers (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Product

The product for which the forecast is made. Required Filter(multi eq)

Type: Products
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

SalesPerson

The sales person for which the forecast is made. When null, the forecast is not for any specfic sales person. Filter(multi eq)

Type: SalesPersons (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Store

The store which is expected to sell the products. Required Filter(multi eq)

Type: Stores
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST