OBJECT

ForecastEntity

link GraphQL Schema definition

  • type ForecastEntity {
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Field whose value is summed when computing forecast amounts (typically a
  • # currency field on Opportunity).
  • field: FieldEntity
  • # User who owns the forecast.
  • owner: ClientEntity
  • # Pipeline whose opportunities the forecast aggregates.
  • pipeline: PipelineEntity
  • # Free-text description shown alongside the forecast.
  • description: String
  • # Last date covered by the forecast period.
  • endDate: Date!
  • # Id of the aggregation field.
  • fieldId: ID!
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the owning user.
  • ownerId: ID!
  • # Id of the pipeline.
  • pipelineId: ID!
  • # Forecast configuration including period, breakdown levels, items and quotas.
  • # Stored as a JSON document.
  • settings: BetterForecastSchema!
  • # Field whose values are strictly defined with an enumeration of values.
  • shareMode: ShareModeEnum
  • # Bit flags fine-tuning sharing behavior (e.g. allow editing for shared users).
  • shareModeParams: Int
  • # First date covered by the forecast period.
  • startDate: Date!
  • # Order of forecast levels as a JSON array (e.g. ["Units", "Users"]). Each level
  • # adds a grouping dimension to the breakdown.
  • type: JSONString!
  • # Revision when entity was lastly changed.
  • revision: Int
  • # For multi-level forecasts (a "type" path like Pipeline/Step/Owner), the last
  • # element of the path identifying the current breakdown axis.
  • lastType: ForecastType!
  • # Users granted shared access to this forecast (custom share mode).
  • sharedClients: [ClientEntity!]!
  • # Sales units granted shared access to this forecast (custom share mode).
  • sharedUnits: [SalesUnitEntity!]!
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Arguments
  • # period: [Not documented]
  • targetGoal(period: PeriodOptionParams): Int!
  • }

link Require by