INPUT_OBJECT

CreateTargetInput

Field values of a new Target record.

link GraphQL Schema definition

  • input CreateTargetInput {
  • # Name of the target.
  • name: String!
  • # Free-text description shown alongside the target.
  • description: String
  • # Users the target is set on: the assignee of a User target, or the members of a
  • # GroupFromUser target, each of whom gets a user target of their own.
  • targetClientIds: [UUID]
  • # User targets a GroupFromExisting target combines.
  • existingTargetsIds: [UUID]
  • # Sales pipeline (revenue targets) or lead process (lead targets) whose records
  • # count toward the target.
  • pipelineLeadProcessId: UUID
  • # Currency the target value is expressed in.
  • currencyId: UUID!
  • # Field conditions selecting which records count toward the target. Required for
  • # User and GroupFromUser targets unless fromSimulatedTargetId is set. The main box
  • # entity must be LeadOppty for Revenue and LeadQualified targets, and Lead (or
  • # LeadOppty) for LeadCreated targets; any other entity is rejected with
  • # ERROR_PARAMETER_INVALID.
  • filter: FieldFilterParams
  • # Period the target applies to: a calendar or financial year, or one quarter or
  • # month of it.
  • period: TargetsPeriodParams!
  • # User who owns a new target; defaults to the calling user. Not changed by
  • # updateTarget.
  • ownerId: UUID
  • # When true, the target is created active. Only a GroupFromExisting target can be
  • # created active; other targets start as drafts.
  • isActive: Boolean!
  • # Kind of target: User, GroupFromUser (one user target per user in
  • # targetClientIds), GroupFromExisting (combines existingTargetsIds) or Simulated.
  • targetType: TargetTypeEnum!
  • # What the target measures: revenue from won opportunities, or the number of leads
  • # created or qualified.
  • calculationType: TargetCalculationTypeEnum!
  • # Simulated target whose indicators the new User target takes over.
  • fromSimulatedTargetId: UUID
  • # Expected results the Simulated target is built from; required for Simulated
  • # targets.
  • simulatedIndicators: SimulatedTargetIndicatorsParams
  • # Target value of a User target, overriding the value computed from the
  • # indicators.
  • targetValue: Float
  • # Target value of each user of a GroupFromUser target, in the order of
  • # targetClientIds.
  • targetClientTargetValues: [Float]
  • }

link Require by