OBJECT

ForecastEntity

Sales forecast that sums an amount over the opportunities of a pipeline for a period, broken down by levels such as sales units and users.

link GraphQL Schema definition

  • type ForecastEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • 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 whose opportunities the forecast aggregates.
  • pipelineId: ID!
  • # Forecast configuration as a JSON object conforming to the BetterForecastSchema
  • # type: currency, period (year + quarter/month), breakdown levels (type), items
  • # and quotas, and column layout. Validated on write. Full structure:
  • # https://api-doc.coevera.com/latest/graphql/space/betterforecastschema.doc.html
  • # This payload conforms to the `BetterForecastSchema` JSON Schema:
  • # https://api-doc.coevera.com/schemas/BetterForecastSchema.json
  • settings: BetterForecastSchema!
  • # Who besides the owner can access the forecast. Updating it to AllEdit shares the
  • # forecast with the users and sales units it covers (see sharedClients and
  • # sharedUnits) and stores the mode as Standard.
  • shareMode: ShareModeEnum
  • # Legacy additional sharing options; kept with the record but no longer applied.
  • 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!]!
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Goal value to reach within the selected period; when the period covers only part
  • # of the target or forecast period, only the matching months count.
  • #
  • # Arguments
  • # period: Period to compute the goal for; the whole period when
  • # omitted.
  • targetGoal(period: PeriodOptionParams): Int!
  • }

link Require by