Edit

Share via

msdyn_forecastinstance table/entity reference

  • Article

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Stores sales predictions for your team or organization. For internal use.

Added by: Forecasting Solution

Messages

Message Web API Operation SDK class or method
Assign PATCH /msdyn_forecastinstances(msdyn_forecastinstanceid)
Update ownerid property.		 AssignRequest
BulkRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Create POST /msdyn_forecastinstances
See Create		 CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /msdyn_forecastinstances(msdyn_forecastinstanceid)
See Delete		 DeleteRequest or
Delete
GrantAccess GrantAccess GrantAccessRequest
IsValidStateTransition IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess ModifyAccess ModifyAccessRequest
PurgeRetainedContent This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retrieve GET /msdyn_forecastinstances(msdyn_forecastinstanceid)
See Retrieve		 RetrieveRequest or
Retrieve
RetrieveMultiple GET /msdyn_forecastinstances
See Query Data		 RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess RevokeAccessRequest
RollbackRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
SetState PATCH /msdyn_forecastinstances(msdyn_forecastinstanceid)
Update statecode and statuscode properties.		 SetStateRequest
Update PATCH /msdyn_forecastinstances(msdyn_forecastinstanceid)
See Update		 UpdateRequest or
Update
UpdateMultiple UpdateMultiple UpdateMultipleRequest
ValidateRetentionConfig This message is to be executed only by Dataverse to trigger registered plug-ins and flows.

Properties

Property Value
CollectionSchemaName msdyn_forecastinstances
DisplayCollectionName Forecasts
DisplayName Forecast
EntitySetName msdyn_forecastinstances
IsBPFEntity False
LogicalCollectionName msdyn_forecastinstances
LogicalName msdyn_forecastinstance
OwnershipType UserOwned
PrimaryIdAttribute msdyn_forecastinstanceid
PrimaryNameAttribute msdyn_forecastname
SchemaName msdyn_forecastinstance

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_actualamount

Property Value
Description Shows the actual value (money) achieved toward the target as of the last rollup date.
DisplayName Closed
IsValidForForm True
IsValidForRead True
LogicalName msdyn_actualamount
MaxValue 9999999999999
MinValue -9999999999999
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_bestcaseamount

Property Value
Description Shows the rollup value (money) for the best case category as of the last rollup date.
DisplayName Best case
IsValidForForm True
IsValidForRead True
LogicalName msdyn_bestcaseamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_committedamount

Property Value
Description Shows the committed rollup value (money) as of the last rollup date.
DisplayName Committed
IsValidForForm True
IsValidForRead True
LogicalName msdyn_committedamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_forecastdefinitionid

Property Value
Description Unique identifier for the forecast definition that is associated with the forecast.
DisplayName Forecast definition
IsValidForForm True
IsValidForRead True
LogicalName msdyn_forecastdefinitionid
RequiredLevel None
Targets msdyn_forecastdefinition
Type Lookup

msdyn_forecastinstanceId

Property Value
Description Unique identifier for the forecast.
DisplayName Forecast
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_forecastinstanceid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_forecastinstancetype

Property Value
Description For internal use only.
DisplayName Forecast type
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_forecastinstancetype
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

msdyn_forecastname

Property Value
Description Name of the forecast.
DisplayName Forecast
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_forecastname
MaxLength 100
RequiredLevel ApplicationRequired
Type String

msdyn_forecastparentid

Property Value
Description Unique identifier for the parent forecast that is associated with the forecast.
DisplayName Forecast parent
IsValidForForm True
IsValidForRead True
LogicalName msdyn_forecastparentid
RequiredLevel None
Targets msdyn_forecastinstance
Type Lookup

msdyn_forecastrecurrenceid

Property Value
Description Unique identifier for the forecast recurrence associated with the forecast.
DisplayName Forecast recurrence
IsValidForForm True
IsValidForRead True
LogicalName msdyn_forecastrecurrenceid
RequiredLevel None
Targets msdyn_forecastrecurrence
Type Lookup

msdyn_ismanualbestcase

Property Value
Description Select whether the bestcase rollup has been manually updated.
DisplayName Adjust manually (Best case)
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ismanualbestcase
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_ismanualcommitted

Property Value
Description Select whether the committed rollup has been manually updated.
DisplayName Adjust manually (Committed)
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ismanualcommitted
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_ismanualpipeline

Property Value
Description Select whether the pipeline rollup has been manually updated.
DisplayName Adjust manually (Pipeline)
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ismanualpipeline
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_isquotasourcemanual

Property Value
Description Is quota source manual
DisplayName Is quota source manual
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_isquotasourcemanual
RequiredLevel None
Type Boolean

msdyn_isquotasourcemanual Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

msdyn_level

Property Value
Description For internal use only.
DisplayName Record level
Format None
IsValidForForm False
IsValidForRead True
LogicalName msdyn_level
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

msdyn_manualbestcaseamount

Property Value
Description Shows the changed value of the best case rollup (Money type) as of the last rolled-up date.
DisplayName Best case
IsValidForForm True
IsValidForRead True
LogicalName msdyn_manualbestcaseamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_manualcommittedamount

Property Value
Description Shows the changed value of the committed rollup (Money type) as of the last rolled-up date.
DisplayName Committed
IsValidForForm True
IsValidForRead True
LogicalName msdyn_manualcommittedamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_manualpipelineamount

Property Value
Description Shows the changed value of the pipeline rollup (Money type) as of the last rolled-up date.
DisplayName Pipeline
IsValidForForm True
IsValidForRead True
LogicalName msdyn_manualpipelineamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_matchinggoalid

Property Value
Description Unique identifier for the matching goal associated with the forecast.
DisplayName Matching goal
IsValidForForm True
IsValidForRead True
LogicalName msdyn_matchinggoalid
RequiredLevel None
Targets goal
Type Lookup

msdyn_pipelineamount

Property Value
Description Shows the pipeline rollup value (money) as of the last rollup date.
DisplayName Pipeline
IsValidForForm True
IsValidForRead True
LogicalName msdyn_pipelineamount
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_recurrenceindex

Property Value
Description Shows the recurrence index of the forecast created from the forecast definition.
DisplayName Recurrence index
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_recurrenceindex
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_targetamount

Property Value
Description Select a target (Money type) to track a monetary amount, such as estimated revenue from an opportunity.
DisplayName Quota
IsValidForForm True
IsValidForRead True
LogicalName msdyn_targetamount
MaxValue 9999999999999
MinValue 0
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Added by: Active Solution Solution

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Added by: Active Solution Solution

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

statecode

Property Value
Description Status of the Forecast
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Property Value
Description Reason for the status of the Forecast
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TransactionCurrencyId

Added by: Active Solution Solution

Property Value
Description Unique identifier of the currency associated with the entity.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ExchangeRate

Added by: Active Solution Solution

Property Value
Description Exchange rate for the currency associated with the entity with respect to the base currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.000000000001
Precision 12
RequiredLevel None
Type Decimal

ModifiedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

msdyn_actualamount_Base

Property Value
Description Value of the Actual (Money) in base currency.
DisplayName Actual (Money) (Base)
IsValidForForm True
IsValidForRead True
LogicalName msdyn_actualamount_base
MaxValue 9999999999999
MinValue -9999999999999
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_bestcaseamount_Base

Property Value
Description Value of the BestCase in base currency.
DisplayName bestcaseamount (Base)
IsValidForForm True
IsValidForRead True
LogicalName msdyn_bestcaseamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_committedamount_Base

Property Value
Description Value of the Committed in base currency.
DisplayName Committed (Base)
IsValidForForm True
IsValidForRead True
LogicalName msdyn_committedamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_forecastdefinitionidName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_forecastdefinitionidname
MaxLength 100
RequiredLevel None
Type String

msdyn_forecastparentidName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_forecastparentidname
MaxLength 100
RequiredLevel None
Type String

msdyn_forecastrecurrenceidName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_forecastrecurrenceidname
MaxLength 100
RequiredLevel None
Type String

msdyn_manualbestcaseamount_Base

Property Value
Description Value of the Manual BestCase in base currency.
DisplayName Manual BestCase (Base)
IsValidForForm True
IsValidForRead True
LogicalName msdyn_manualbestcaseamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_manualcommittedamount_Base

Property Value
Description Value of the Manual Committed in base currency.
DisplayName Manual Committed (Base)
IsValidForForm True
IsValidForRead True
LogicalName msdyn_manualcommittedamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_manualpipelineamount_Base

Property Value
Description Value of the Manual Pipeline in base currency.
DisplayName Manual Pipeline (Base)
IsValidForForm True
IsValidForRead True
LogicalName msdyn_manualpipelineamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_matchinggoalidName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_matchinggoalidname
MaxLength 100
RequiredLevel None
Type String

msdyn_percentageachieved

Property Value
Description Shows the percentage achieved against the target.
DisplayName Achieved %
IsValidForForm True
IsValidForRead True
LogicalName msdyn_percentageachieved
MaxValue 100000000000
MinValue -100000000000
Precision 2
RequiredLevel None
Type Decimal

msdyn_pipelineamount_Base

Property Value
Description Value of the Pipeline in base currency.
DisplayName Pipeline (Base)
IsValidForForm True
IsValidForRead True
LogicalName msdyn_pipelineamount_base
MaxValue 922337203685477
MinValue -922337203685477
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

msdyn_targetamount_Base

Property Value
Description Value of the Target (Money) in base currency.
DisplayName Target (Money) (Base)
IsValidForForm True
IsValidForRead True
LogicalName msdyn_targetamount_base
MaxValue 9999999999999
MinValue 0
Precision 4
PrecisionSource 2
RequiredLevel None
Type Money

OwnerIdName

Added by: Active Solution Solution

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Added by: Active Solution Solution

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Added by: Active Solution Solution

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunitname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningTeam

Added by: Active Solution Solution

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Added by: Active Solution Solution

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

TransactionCurrencyIdName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

msdyn_msdyn_forecastinstance_msdyn_forecastinstance

Same as the msdyn_msdyn_forecastinstance_msdyn_forecastinstance many-to-one relationship for the msdyn_forecastinstance table/entity.

Property Value
ReferencingEntity msdyn_forecastinstance
ReferencingAttribute msdyn_forecastparentid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName msdyn_msdyn_forecastinstance_msdyn_forecastinstance
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

msdyn_msdyn_forecastdefinition_msdyn_forecastinstance

See the msdyn_msdyn_forecastdefinition_msdyn_forecastinstance one-to-many relationship for the msdyn_forecastdefinition table/entity.

msdyn_msdyn_forecastinstance_msdyn_forecastinstance

See the msdyn_msdyn_forecastinstance_msdyn_forecastinstance one-to-many relationship for the msdyn_forecastinstance table/entity.

msdyn_msdyn_forecastrecurrence_msdyn_forecastinstance

See the msdyn_msdyn_forecastrecurrence_msdyn_forecastinstance one-to-many relationship for the msdyn_forecastrecurrence table/entity.

msdyn_goal_msdyn_forecastinstance

Added by: System Solution Solution

See the msdyn_goal_msdyn_forecastinstance one-to-many relationship for the goal table/entity.

See also

Dataverse table/entity reference
Web API Reference