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

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "field_reference"
  ],
  "title": "ForecastingSourceDefinition - Data API",
  "description": "Represents the object, measure, date type, and hierarchy that a forecast uses to project sales. This object is available in API version 52.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "CategoryField": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Name of the forecast category that is associated with the forecast type. Possible values are: Opportunity.ForecastCategoryName"
    },
    "DateField": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Field that is used for the forecast type’s date type. For example, the CloseDate field on Opportunity is used for opportunity close date-based forecast types. Possible values are: Opportunity.CloseDate OpportunityLineItem.ServiceDate OpportunityLineItemSchedule.ScheduleDate"
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The developer name of the forecasting source definition. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
    },
    "FamilyField": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Use this field to group forecasts by product family. Possible values are: Product2.Family"
    },
    "Language": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Language of the forecasting source definition. For example, English."
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Controlling label for this forecasting source definition.",
      "required": true
    },
    "MeasureField": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Field that is used for the forecast type’s measure. For example, the Amount field on Opportunity is associated with revenue-based forecast types. Possible values are*: Opportunity.Amount Opportunity.Custom Opportunity.TotalOpportunityQuantity OpportunityLineItem.Custom OpportunityLineItem.Quantity OpportunityLineItem.TotalPrice OpportunityLineItemSchedule.Custom OpportunityLineItemSchedule.Quantity OpportunityLineItemSchedule.Revenue OpportunitySplit.Custom OpportunitySplit.SplitAmount *Where Custom represents the name of the custom field that a forecast type’s measure is based on. Example: Use Megawatts__c to forecast energy consumption."
    },
    "SourceObject": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Object associated with this forecasting source definition. Possible values are: Opportunity OpportunityLineItem OpportunityLineItemSchedule OpportunitySplit Product2"
    },
    "Territory2Field": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "For a territory-based forecast type, indicates the field that is used for territory information. Possible values are: Opportunity.Territory2Id For user role-based forecast types, this value is null."
    },
    "UserField": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Specifies who owns the forecast. Possible values are: Opportunity.OwnerId OpportunitySplit.SplitOwnerId"
    }
  },
  "usage": "Use ForecastingSourceDefinition to define a forecast type’s structure. A forecasting source definition is joined via ForecastingTypeSource to ForecastingType. In this example, a user role-based forecast type called Custom Amount Forecast is based on the Amount and Close Date fields on opportunities.\n\nUse ForecastingSourceDefinition to define a forecast type’s structure. A forecasting source definition is joined via ForecastingTypeSource to ForecastingType.\n\nIn this example, a user role-based forecast type called Custom Amount Forecast is based on the Amount and Close Date fields on opportunities.",
  "field_reference": {
    "CategoryField": {
      "field_label": "Custom Field Definition ID",
      "type": "picklist",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DateField": {
      "field_label": "Custom Field Definition ID",
      "type": "picklist",
      "length": "255"
    },
    "DeveloperName": {
      "field_label": "Name",
      "type": "string",
      "length": "80"
    },
    "FamilyField": {
      "field_label": "Custom Field Definition ID",
      "type": "picklist",
      "length": "255"
    },
    "Id": {
      "field_label": "Forecasting Source Definition ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Master Language",
      "type": "picklist",
      "length": "40"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MasterLabel": {
      "field_label": "Label",
      "type": "string",
      "length": "80"
    },
    "MeasureField": {
      "field_label": "Custom Field Definition ID",
      "type": "picklist",
      "length": "255"
    },
    "SourceObject": {
      "field_label": "Custom Object Definition ID",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Territory2Field": {
      "field_label": "Custom Field Definition ID",
      "type": "picklist",
      "length": "255"
    },
    "UserField": {
      "field_label": "Custom Field Definition ID",
      "type": "picklist",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}