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
  • # Relation to single entity instance. Target entity is re-used and not deleted
  • # on de-association.
  • #
  • # Examples:
  • #
  • # Opportunity.owner -> Client, the Client is reused for many opportunities.
  • #
  • # Account.picture -> CloudObject, the CloudObject can be reused on many accounts.
  • #
  • field: FieldEntity
  • owner: ClientEntity
  • # Relation to single entity instance. Target entity is re-used and not deleted
  • # on de-association.
  • #
  • # Examples:
  • #
  • # Opportunity.owner -> Client, the Client is reused for many opportunities.
  • #
  • # Account.picture -> CloudObject, the CloudObject can be reused on many accounts.
  • #
  • pipeline: PipelineEntity
  • # Multi-line text input field.
  • description: String
  • # Date information.
  • endDate: Date!
  • # Relation to single entity instance.
  • fieldId: ID!
  • # Name of the entity and its default text representation.
  • name: String!
  • # Relation to single entity instance.
  • ownerId: ID!
  • # Relation to single entity instance.
  • pipelineId: ID!
  • # Field containing json.
  • settings: BetterForecastSchema!
  • # Field whose values are strictly defined with an enumeration of values.
  • shareMode: ShareModeEnum
  • # Bit Flag field, with limited combination of integer values.
  • #
  • # Options:
  • # ShareToUnitManagers = 1 (0b01)
  • # ShareToIncludedUsers = 2 (0b10)
  • shareModeParams: Int
  • # Date information.
  • startDate: Date!
  • # Field whose values are strictly defined with an enumeration of values.
  • type: ForecastTypeEnum!
  • # Revision when entity was lastly changed.
  • revision: Int
  • sharedClients: [ClientEntity!]!
  • 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!
  • }