goal EntityType

Entity Set Path
[organization URI]/api/data/v9.0/goals
Base Type
crmbaseentity
Display Name
Goal
Primary Key
goalid
Primary Key Attribute
title
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
actualdecimal Edm.Decimal

Shows the actual value (Decimal type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Decimal.

Display Name: Actual (Decimal)

actualinteger Edm.Int32

Shows the actual value (integer) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount or Count and the amount data type is Integer.

Display Name: Actual (Integer)

actualmoney Edm.Decimal

Shows the actual value (Money type) achieved towards the target as of the last rolled-up date. This field appears when the metric type of the goal is Amount and the amount data type is Money.

Display Name: Actual (Money)

actualmoney_base Edm.Decimal

Shows the actual value (money type) in base currency to track goal results against the target.

Display Name: Actual (Money) (Base)

Read Only
actualstring Edm.String

Actual Value of the goal.

Display Name: Actual

Read Only
amountdatatype Edm.Int32

Data type of the amount.

Display Name: Amount Data Type

Default Options
Value Label
0 Money
1 Decimal
2 Integer
computedtargetasoftodaydecimal Edm.Decimal

Shows the expected amount for actual value (decimal type) against the target goal.

Display Name: Today's Target (Decimal)

Read Only
computedtargetasoftodayinteger Edm.Int32

Shows the expected amount for actual value (integer type) against the target goal as of the current date.

Display Name: Today's Target (Integer)

Read Only
computedtargetasoftodaymoney Edm.Decimal

Shows the expected amount for actual value (money type) against the target goal as of the current date.

Display Name: Today's Target (Money)

Read Only
computedtargetasoftodaymoney_base Edm.Decimal

Shows the expected amount in base currency for actual value (money type) against the target goal as of the current date.

Display Name: Today's Target (Money) (Base)

Read Only
computedtargetasoftodaypercentageachieved Edm.Decimal

Shows the expected value for percentage achieved against the target goal as of the current date.

Display Name: Today's Target (Percentage Achieved)

Read Only
consideronlygoalownersrecords Edm.Boolean

Select whether only the goal owner's records, or all records, should be rolled up for goal results.

Display Name: Record Set for Rollup

Default Options
Value Label
1 Owned by goal owner
0 All
createdon Edm.DateTimeOffset

Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read Only
customrollupfielddecimal Edm.Decimal

Indicates a placeholder rollup field for a decimal value to track a third category of results other than actuals and in-progress results.

Display Name: Custom Rollup Field (Decimal)

customrollupfieldinteger Edm.Int32

Indicates a placeholder rollup field for an integer value to track a third category of results other than actuals and in-progress results.

Display Name: Custom Rollup Field (Integer)

customrollupfieldmoney Edm.Decimal

Indicates a placeholder rollup field for a money value to track a third category of results other than actuals and in-progress results.

Display Name: Custom Rollup Field (Money)

customrollupfieldmoney_base Edm.Decimal

Indicates a placeholder rollup field for a money value in base currency to track a third category of results other than actuals and in-progress results.

Display Name: Custom Rollup Field (Money) (Base)

Read Only
customrollupfieldstring Edm.String

Placeholder rollup field for the goal.

Display Name: Custom Rollup Field

Read Only
depth Edm.Int32

Depth of the goal in the tree.

Display Name: Depth

Read Only
entityimage Edm.Binary

The default image for the entity.

Display Name: Entity Image

entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid

For internal use only.

Display Name: Entity Image Id

Read Only
exchangerate Edm.Decimal

Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.

Display Name: Exchange Rate

Read Only
fiscalperiod Edm.Int32

Select the fiscal period for the goal.

Display Name: Fiscal Period

Default Options
Value Label
1 Quarter 1
2 Quarter 2
3 Quarter 3
4 Quarter 4
101 January
102 February
103 March
104 April
105 May
106 June
107 July
108 August
109 September
110 October
111 November
112 December
201 Semester 1
202 Semester 2
301 Annual
401 P1
402 P2
403 P3
404 P4
405 P5
406 P6
407 P7
408 P8
409 P9
410 P10
411 P11
412 P12
413 P13
fiscalyear Edm.Int32

Select the fiscal year for the goal that's being tracked.

Display Name: Fiscal Year

Default Options
Value Label
2038 FY2038
2037 FY2037
2036 FY2036
2035 FY2035
2034 FY2034
2033 FY2033
2032 FY2032
2031 FY2031
2030 FY2030
2029 FY2029
2028 FY2028
2027 FY2027
2026 FY2026
2025 FY2025
2024 FY2024
2023 FY2023
2022 FY2022
2021 FY2021
2020 FY2020
2019 FY2019
2018 FY2018
2017 FY2017
2016 FY2016
2015 FY2015
2014 FY2014
2013 FY2013
2012 FY2012
2011 FY2011
2010 FY2010
2009 FY2009
2008 FY2008
2007 FY2007
2006 FY2006
2005 FY2005
2004 FY2004
2003 FY2003
2002 FY2002
2001 FY2001
2000 FY2000
1999 FY1999
1998 FY1998
1997 FY1997
1996 FY1996
1995 FY1995
1994 FY1994
1993 FY1993
1992 FY1992
1991 FY1991
1990 FY1990
1989 FY1989
1988 FY1988
1987 FY1987
1986 FY1986
1985 FY1985
1984 FY1984
1983 FY1983
1982 FY1982
1981 FY1981
1980 FY1980
1979 FY1979
1978 FY1978
1977 FY1977
1976 FY1976
1975 FY1975
1974 FY1974
1973 FY1973
1972 FY1972
1971 FY1971
1970 FY1970
goalenddate Edm.DateTimeOffset

Enter the date when the goal ends.

Display Name: To

goalid Edm.Guid

Unique identifier of the goal.

Display Name: Goal

goalstartdate Edm.DateTimeOffset

Enter the date and time when the period for tracking the goal begins.

Display Name: From

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

inprogressdecimal Edm.Decimal

Shows the in-progress value (decimal) against the target. This value could contribute to a goal, but is not counted yet as actual.

Display Name: In-progress (Decimal)

inprogressinteger Edm.Int32

Shows the in-progress value (integer) against the target. This value could contribute to a goal, but is not counted yet as actual.

Display Name: In-progress (Integer)

inprogressmoney Edm.Decimal

Shows the in-progress value (money) against the target. This value could contribute to a goal, but is not counted yet as actual.

Display Name: In-progress (Money)

inprogressmoney_base Edm.Decimal

Shows the in-progress value (money) in base currency to track goal results against the target.

Display Name: In-progress (Money) (Base)

Read Only
inprogressstring Edm.String

In-progress value of the goal.

Display Name: In-Progress

Read Only
isamount Edm.Boolean

Indicates whether the metric type is Count or Amount.

Display Name: Metric Type

Default Options
Value Label
1 Amount
0 Count
isfiscalperiodgoal Edm.Boolean

Select whether the goal period is a fiscal period or custom period.

Display Name: Goal Period Type

Default Options
Value Label
1 Fiscal Period
0 Custom Period
isoverridden Edm.Boolean

Select whether the system rollup fields are updated. If set to Yes, the next system rollup will not update the values of the rollup fields with the system calculated values.

Display Name: Overridden

Default Options
Value Label
1 Yes
0 No
isoverride Edm.Boolean

Indicates whether the values of system rollup fields can be updated.

Display Name: Override

Default Options
Value Label
1 Yes
0 No
lastrolledupdate Edm.DateTimeOffset

Shows the date and time when the goal was last rolled up. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Last Rolled Up Date

modifiedon Edm.DateTimeOffset

Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

percentage Edm.Decimal

Shows the percentage achieved against the target goal.

Display Name: Percentage Achieved

rolluperrorcode Edm.Int32

Error code associated with rollup.

Display Name: Rollup Error Code

rolluponlyfromchildgoals Edm.Boolean

Select whether the data should be rolled up only from the child goals.

Display Name: Roll Up Only from Child Goals

Default Options
Value Label
1 Yes
0 No
statecode Edm.Int32

Shows whether the goal is open, completed, or canceled. Completed and canceled goals are read-only and can't be edited.

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Select the goal's status.

Display Name: Status Reason

Default Options
Value Label
0 Open
1 Closed
2 Discarded
stretchtargetdecimal Edm.Decimal

Select a stretch target (decimal) of the goal to define a higher or difficult level of goal than the usual ones.

Display Name: Stretch Target (Decimal)

stretchtargetinteger Edm.Int32

Select the stretch target (integer) of the goal to define a higher or difficult level of goal than the usual ones.

Display Name: Stretch Target (Integer)

stretchtargetmoney Edm.Decimal

Select stretch target (money) of the goal to define a higher or difficult level of goal than the usual ones.

Display Name: Stretch Target (Money)

stretchtargetmoney_base Edm.Decimal

Shows the stretch target (money) in base currency to indicate a higher or difficult level of goal than the usual ones.

Display Name: Stretch Target (Money) (Base)

Read Only
stretchtargetstring Edm.String

Stretch target value for all data types.

Display Name: Stretched Target

Read Only
targetdecimal Edm.Decimal

Select a goal target of the decimal type to use for tracking data that include partial numbers, such as pounds sold of a product sold by weight.

Display Name: Target (Decimal)

targetinteger Edm.Int32

Select a goal target of the integer type to use for tracking anything countable in whole numbers, such as units sold.

Display Name: Target (Integer)

targetmoney Edm.Decimal

Select a goal target (money) to track a monetary amount such as revenue from a product.

Display Name: Target (Money)

targetmoney_base Edm.Decimal

Shows the goal target of the money type in base currency.

Display Name: Target (Money) (Base)

Read Only
targetstring Edm.String

Target value of the goal.

Display Name: Target

Read Only
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

title Edm.String

Type a title or name that describes the goal.

Display Name: Name

treeid Edm.Guid

Unique identifier of the goal tree.

Display Name: Tree ID

Read Only
utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version number of the goal.

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Shows who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_goalownerid_value goalownerid_systemusergoalownerid_team

Choose the user or team responsible for meeting the goal.

_goalwitherrorid_value goalwitherrorid

Unique identifier of the goal that caused an error in the rollup of the goal hierarchy.

_metricid_value metricid

Choose the metric for the goal. This metric determines how the goal is tracked.

_modifiedby_value modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_ownerid_value ownerid

Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record.

_owningteam_value owningteam

Unique identifier of the team who owns the goal.

_owninguser_value owninguser

Unique identifier for the user who owns the record.

_parentgoalid_value parentgoalid

Choose a parent goal if the current goal is a child goal. This sets up a parent-child relationship for reporting and analytics.

_rollupqueryactualdecimalid_value rollupqueryactualdecimalid

Choose the query that will be used to calculate the actual data for the goal (decimal).

_rollupqueryactualintegerid_value rollupqueryactualintegerid

Choose the query that will be used to calculate the actual data for the goal (integer).

_rollupqueryactualmoneyid_value rollupqueryactualmoneyid

Choose the query that will be used to calculate the actual data for the goal (money).

_rollupquerycustomdecimalid_value rollupquerycustomdecimalid

Choose the query that will be used to calculate data for the custom rollup field (decimal).

_rollupquerycustomintegerid_value rollupquerycustomintegerid

Choose the query that will be used to calculate data for the custom rollup field (integer).

_rollupquerycustommoneyid_value rollupquerycustommoneyid

Choose the query that will be used to calculate data for the custom rollup field (money).

_rollupqueryinprogressdecimalid_value rollupqueryinprogressdecimalid

Choose the query that will be used to calculate data for the in-progress rollup field (decimal).

_rollupqueryinprogressintegerid_value rollupqueryinprogressintegerid

Choose the query that will be used to calculate data for the in-progress rollup field (integer).

_rollupqueryinprogressmoneyid_value rollupqueryinprogressmoneyid

Choose the query that will be used to calculate data for the in-progress rollup field (money).

_transactioncurrencyid_value transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_goal_createdby
createdonbehalfby systemuser lk_goal_createdonbehalfby
goalownerid_systemuser systemuser user_goal_goalowner
goalownerid_team team team_goal_goalowner
goalwitherrorid goal Goal_RollupError_Goal
metricid metric metric_goal
modifiedby systemuser lk_goal_modifiedby
modifiedonbehalfby systemuser lk_goal_modifiedonbehalfby
ownerid principal owner_goal
owningbusinessunit businessunit business_unit_goal
owningteam team team_goal
owninguser systemuser user_goal
parentgoalid goal goal_parent_goal
rollupqueryactualdecimalid goalrollupquery goal_rollupquery_actualdecimal
rollupqueryactualintegerid goalrollupquery goalrollupquery_actualint
rollupqueryactualmoneyid goalrollupquery goal_rollupquery_actualmoney
rollupquerycustomdecimalid goalrollupquery goal_rollupquery_customdecimal
rollupquerycustomintegerid goalrollupquery goal_rollupquery_customint
rollupquerycustommoneyid goalrollupquery goal_rollupquery_custommoney
rollupqueryinprogressdecimalid goalrollupquery goal_rollupquery_inprogressdecimal
rollupqueryinprogressintegerid goalrollupquery goal_rollupquery_inprogressint
rollupqueryinprogressmoneyid goalrollupquery goal_rollupquery_inprogressmoney
transactioncurrencyid transactioncurrency TransactionCurrency_Goal

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
Goal_Annotation annotation objectid_goal
Goal_AsyncOperations asyncoperation regardingobjectid_goal
goal_connections1 connection record1id_goal
goal_connections2 connection record2id_goal
Goal_DuplicateBaseRecord duplicaterecord baserecordid_goal
Goal_DuplicateMatchingRecord duplicaterecord duplicaterecordid_goal
goal_parent_goal goal parentgoalid
goal_principalobjectattributeaccess principalobjectattributeaccess objectid_goal
Goal_ProcessSessions processsession regardingobjectid_goal
Goal_RollupError_Goal goal goalwitherrorid
Goal_SyncErrors syncerror regardingobjectid_goal_syncerror

Operations

The following operations can be used with the goal entity type.

Name Binding
GrantAccess Not Bound
ModifyAccess Not Bound
Recalculate Entity
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the goal entity type.

Name Description
System Solution Internal CRM System Solution

See Also