afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ForecastingItem.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "field_reference"
  ],
  "title": "ForecastingItem - Data API",
  "description": "This object is read-only used for individual forecast amounts. Users see amounts based on their perspectives and forecast roles. The amounts users see include one of these values when forecasting in revenue: AmountWithoutAdjustments, AmountWithoutManagerAdjustment, ForecastAmount, OwnerOnlyAmount. The amounts users see include one of these values when forecasting in quantity: QuantityWithoutAdjustments, QuantityWithoutManagerAdjustment, ForecastQuantity, OwnerOnlyQuantity. Available in API version 26.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AmountWithoutAdjustments": {
      "type": "double",
      "properties": "Filter, Sort, Nillable",
      "description": "The sum of a person’s owned revenue opportunities and the person's subordinates’ and child territories’ opportunities, without adjustments. Subordinates include everyone reporting up to a person in the role-based forecast hierarchy. This amount is visible only on reports."
    },
    "AmountWithoutManagerAdjustment": {
      "type": "double",
      "properties": "Filter, Sort, Nillable",
      "description": "The forecast number as seen by the forecast owner. This number is the sum of the owner’s revenue opportunities and the owner’s subordinates’ and child territories’ opportunities, including adjustments made by the forecast owner on the owner's or subordinates’ and child territories’ forecasts. It doesn’t include adjustments made by forecast managers above the owner in the forecast hierarchy."
    },
    "AmountWithoutOwnerAdjustment": {
      "type": "double",
      "properties": "Filter, Sort, Nillable",
      "description": "The forecast amount as seen by the forecast owner without the owner's adjustment. This amount is the sum of the subordinate's and child territories’ opportunities, including adjustments made by their manager or by the subordinate themselves, plus the rollup of the owner's own opportunities. It doesn’t include adjustments made by the forecast owner."
    },
    "ForecastAmount": {
      "type": "double",
      "properties": "Filter, Sort, Nillable",
      "description": "The revenue forecast from the forecast manager’s perspective and the sum of the owner’s and subordinates’ and child territories’ opportunities, including all forecast adjustments."
    },
    "ForecastCategoryName": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "A forecast category is the category within the sales cycle to which an opportunity is assigned based on its opportunity stage. The standard forecast categories are Pipeline, Best Case, Commit, Omitted (not included in forecasts), and Closed. Salesforce admins can add a Most Likely category and can customize the forecast category names in single category rollups. Change the forecast category name only. Changing a forecast category’s API name can have unintended results."
    },
    "ForecastQuantity": {
      "type": "double",
      "properties": "Filter, Sort, Nillable",
      "description": "The quantity forecast from the forecast manager’s perspective and the sum of the owner’s and subordinates’ opportunities, including all forecast adjustments. This field is available in API version 28 and later."
    },
    "ForecastingGroupItemId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "If a forecast group is assigned to the forecast type, the ID of the group value that the forecast total belongs to. This field is a relationship field. Available in API version 60.0 and later.",
      "relationship_name": "ForecastingGroupItem",
      "relationship_type": "Lookup",
      "refers_to": "ForecastingGroupItem"
    },
    "ForecastingItemCategory": {
      "type": "picklist",
      "properties": "Filter, Group, Sort",
      "description": "This field indicates which type of forecast rollup the forecasting item belongs to. Depending on whether your organization uses individual forecast category rollups or cumulative forecast rollups, you have these possible values for the ForecastingItemCategory field. Individual forecast category rollups: PipelineOnly - Rollup from Pipeline opportunities only. BestCaseOnly - Rollup from Best Case opportunities only. Adjustable. MostLikelyOnly - Rollup from Most Likely opportunities only. Adjustable. CommitOnly - Rollup from Commit opportunities only. Adjustable. Cumulative forecast rollups: OpenPipeline - Rollup from Pipeline + Best Case + Most Likely + Commit opportunities. BestCaseForecast - Rollup from Best Case + Most Likely + Commit + Closed opportunities. Adjustable. MostLikelyForecast - Rollup from Most Likely + Commit + Closed opportunities. Adjustable. CommitForecast - Rollup from Commit + Closed opportunities. Adjustable. Either cumulative or individual forecast category rollups: ClosedOnly - Rollup from Closed opportunities only. The ForecastingItemCategory field differs from the ForecastCategoryName field. The ForecastCategoryName field represents the forecast category of the underlying opportunities rolling up to forecast amounts. In organizations using cumulative forecast rollups, the ForecastCategoryName field can be null because the cumulative forecast amounts include opportunities from multiple forecast categories. The new ForecastingItemCategory field represents the type of rollup a forecast amount or adjustment is from. In organizations using individual forecast category columns, it contains the individual forecast rollup categories. In organizations using cumulative forecast rollups, it contains the cumulative rollup categories."
    },
    "ForecastingTypeId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the related ForecastingType."
    },
    "HasAdjustment": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "A flag that indicates the forecasting item includes a manager adjustment. This flag is true only when the item includes an adjustment and the user performing the query has read access to the adjustment."
    },
    "HasOwnerAdjustment": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "A flag that indicates the forecasting item includes an owner adjustment. This flag is true only when the item includes an adjustment and the user performing the query has read access to the adjustment. Available in API version 33.0 and later."
    },
    "IsAmount": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "True indicates that the adjustment is made in a revenue amount. If false, then IsQuantity must be true. This field is available in API version 28.0 and later."
    },
    "IsQuantity": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "True indicates that the adjustment is made in a quantity amount. If false, then IsAmount must be true. This field is available in API version 28.0 and later."
    },
    "IsUpToDate": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "A flag indicating whether a specific forecasting item reflects current information. For example, if users are making adjustments that are in process, the item isn’t up to date."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the forecast owner."
    },
    "OwnerOnlyAmount": {
      "type": "double",
      "properties": "Filter, Sort, Nillable",
      "description": "The sum of a person’s revenue opportunities, without adjustments."
    },
    "OwnerOnlyQuantity": {
      "type": "double",
      "properties": "Filter, Sort, Nillable",
      "description": "The sum of a person’s quantity opportunities, without adjustments. This field is available in API version 28.0 and later."
    },
    "ParentForecastingItemId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the ForecastingItem that the current item rolls up to."
    },
    "PeriodId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Period ID for the forecast."
    },
    "ProductFamily": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The product family of the forecast item. This field is available in API version 29.0 and later. Read only."
    },
    "QuantityWithoutAdjustments": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of a person’s owned quantity opportunities and also his or her subordinates’ opportunities, without adjustments. Subordinates include everyone reporting up to a person in the forecast hierarchy. This field is available in API version 28.0 and later."
    },
    "QuantityWithoutManagerAdjustment": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The forecast number as seen by the forecast owner. This number is the sum of the owner’s quantity opportunities and subordinates’ opportunities, including adjustments made on the subordinates’ forecasts. It doesn’t include adjustments made by forecast managers above the owner in the forecast hierarchy. This field is available in API version 28 and later."
    },
    "QuantityWithoutOwnerAdjustment": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The forecast quantity as seen by the forecast owner without the owner's adjustment. This number is the sum of the subordinate's opportunities, including adjustments made by their manager or by the subordinate themselves, plus the rollup of the owner's own opportunities. It doesn’t include adjustments made by the forecast owner. This field is available in API version 38.0 and later."
    },
    "SubordinateOverrides": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "The total number of adjustments made to a forecast down the hierarchical chain. For example, User A has a forecast without adjustments. If User A adjusts User B’s forecast, User A’s SubordinateOverrides value is 1. Then if User B adjusts User C’s forecast, User A’s SubordinateOverrides value is 2. If User A removes his adjustment from User B’s forecast, User A’s SubordinateOverrides value is 1. This field is available in API version 38.0 and later."
    },
    "Territory2Id": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the territory to forecast on. Available in API version 43.0 and later."
    }
  },
  "special_access_rules": "As of Spring ’20 and later, only standard users with the View All Forecasts or Allow Forecasting permission or delegated forecast manager status can access this object.",
  "usage": "Use this object to obtain individual forecast amounts, either with or without adjustments, based on a user’s perspective and forecast role. The ForecastingItem object is visible to all users, but only forecast managers and users above them in the forecast hierarchy can read or write ForecastingAdjustment records.\n\nBeginning with API version 30.0, organizations can have more than one forecasting type\n    enabled. The\n\nForecastingQuota\n\nForecastingAdjustment\n\nForecastingOwnerAdjustment\n\nForecastingItem\n\nForecastingFact\n\nobjects can all have records with different\n\nForecastingTypeId\n\nvalues. Use the ForecastingType object to determine the\n    ID for each forecast type and then filter\n\nForecastingQuota\n\nForecastingAdjustment\n\nForecastingItem\n\nForecastingFact\n\nrecords as\n    necessary.",
  "field_reference": {
    "AmountWithoutAdjustments": {
      "field_label": "Amount Without Adjustments",
      "type": "currency",
      "precision": "18",
      "scale": "0"
    },
    "AmountWithoutManagerAdjustment": {
      "field_label": "Amount Without Manager Adjustment",
      "type": "currency",
      "precision": "18",
      "scale": "0"
    },
    "AmountWithoutOwnerAdjustment": {
      "field_label": "Amount Without Owner Adjustments",
      "type": "currency",
      "precision": "18",
      "scale": "0"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "ForecastAmount": {
      "field_label": "Forecast Amount",
      "type": "currency",
      "precision": "18",
      "scale": "0"
    },
    "ForecastCategoryName": {
      "field_label": "Forecast Category",
      "type": "picklist",
      "length": "255"
    },
    "ForecastQuantity": {
      "field_label": "Forecast Quantity",
      "type": "double",
      "precision": "12",
      "scale": "2"
    },
    "ForecastingGroupItemId": {
      "field_label": "Forecasting Group Item ID",
      "type": "reference",
      "length": "18"
    },
    "ForecastingItemCategory": {
      "field_label": "Forecasting Item Category",
      "type": "picklist",
      "length": "255"
    },
    "ForecastingTypeId": {
      "field_label": "Forecasting Type ID",
      "type": "reference",
      "length": "18"
    },
    "HasAdjustment": {
      "field_label": "Has Adjustment",
      "type": "boolean"
    },
    "HasOwnerAdjustment": {
      "field_label": "Has Owner Adjustment",
      "type": "boolean"
    },
    "Id": {
      "field_label": "Forecasting Item ID",
      "type": "id",
      "length": "18"
    },
    "IsAmount": {
      "field_label": "Is Amount",
      "type": "boolean"
    },
    "IsQuantity": {
      "field_label": "Is Quantity",
      "type": "boolean"
    },
    "IsUpToDate": {
      "field_label": "Is up to date",
      "type": "boolean"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "OwnerOnlyAmount": {
      "field_label": "Owner Only Amount",
      "type": "currency",
      "precision": "18",
      "scale": "0"
    },
    "OwnerOnlyQuantity": {
      "field_label": "Owner Only Quantity",
      "type": "double",
      "precision": "12",
      "scale": "2"
    },
    "ParentForecastingItemId": {
      "field_label": "Forecasting Item ID",
      "type": "reference",
      "length": "18"
    },
    "PeriodId": {
      "field_label": "Period ID",
      "type": "reference",
      "length": "18"
    },
    "ProductFamily": {
      "field_label": "Product Family",
      "type": "picklist",
      "length": "255"
    },
    "QuantityWithoutAdjustments": {
      "field_label": "Quantity Without Adjustments",
      "type": "double",
      "precision": "12",
      "scale": "2"
    },
    "QuantityWithoutManagerAdjustment": {
      "field_label": "Quantity Without Manager Adjustment",
      "type": "double",
      "precision": "12",
      "scale": "2"
    },
    "QuantityWithoutOwnerAdjustment": {
      "field_label": "Quantity Without Owner Adjustment",
      "type": "double",
      "precision": "12",
      "scale": "2"
    },
    "SubordinateOverrides": {
      "field_label": "Subordinate Overrides",
      "type": "int",
      "digits": "9"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Territory2Id": {
      "field_label": "Territory ID",
      "type": "reference",
      "length": "18"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "precision",
    "scale",
    "length",
    "digits"
  ]
}