OBJECT
TargetEntity

GraphQL Schema definition

type TargetEntity {
#   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 
#   Currency the target value is expressed in. Required when calculation_type is a 
#   currency-based metric.
currency: CurrencyEntity 
#   User who owns the target.
owner: ClientEntity 
#   User the target is set on (the assignee). Required for User-type targets; null 
#   for group targets.
targetClient: ClientEntity 
#   Field whose values are strictly defined with an enumeration of values.
calculationType: TargetCalculationTypeEnum 
#   Id of the target currency.
currencyId: ID 
#   Free-text description shown alongside the target.
description: String 
#   When true, the target is currently being tracked; when false, the target is a 
#   draft or has been deactivated.
isActive: Boolean! 
#   Name of the entity and its default text representation.
name: String! 
#   Id of the owning user.
ownerId: ID! 
#   First date of the active target period. Set when is_active is true; recomputed 
#   from settings.period when activated.
periodFrom: Date 
#   Last date of the active target period.
periodTo: Date 
#   Target configuration: period (year, quarter/month etc.), value, fragment 
#   breakdown and indicator inputs. Stored as a JSON document.
settings: TargetsSettings! 
#   Id of the assignee user.
targetClientId: ID 
#   Field whose values are strictly defined with an enumeration of values.
type: TargetTypeEnum 
#   Revision when entity was lastly changed.
revision: Int 
#   Target value the user committed to for the current period.
target: Float 
#   Start date of the target period, derived from period_type and period_year.
virtualPeriodFrom: Date 
#   End date of the target period, derived from period_type and period_year.
virtualPeriodTo: Date 
#   Whole days remaining until the target period ends, or zero once the period is 
#   past.
daysLeft: Int! 
#   Progress state of the target: NotStarted before the period begins, InProgress 
#   during the period, Completed or Failed once the period has ended depending on 
#   whether the committed target was reached.
status: TargetStatusEnum 
#   Date the target was marked as finished. Empty until the target is closed.
finishedDate: Date 
#   Projected end-of-period value extrapolated from progress to date. Used to 
#   compare against the committed target.
estimatedTarget: Float 
#   Calendar year the target period belongs to (e.g. 2026).
periodYear: Int! 
#   Granularity of the target period (Yearly, Quarterly, Monthly, Weekly, ...). 
#   Combined with period_year to determine virtual_period_from / virtual_period_to.
periodType: TargetsPeriodTypeEnum! 
#   Returns if current target has any non-deleted parent group target.
hasParentGroupTarget: Boolean! 
#   User-level child targets that aggregate into this group target.
# 
# Arguments
#   filter: Filter Target relations by target Target attributes.
#   filterEdge: Filter TargetRelation relations by edge (relation) 
#   TargetRelation attributes.
#   orderBy: Order Target relations by target Target attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
childTargets(
filter: TargetFilterInput,
filterEdge: TargetRelationFilterInput,
orderBy: [TargetOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): TargetRelationEntityConnection 
#   When the target period is split into shorter fragments (e.g. a yearly target 
#   broken into monthly fragments), the fragment granularity (Monthly, Quarterly, 
#   ...).
periodFragmentType: TargetsPeriodFragmentTypeEnum! 
#   Zero-based position of the current fragment within the parent period (e.g. 
#   fragment index 2 for the 3rd month in a yearly target split into monthly 
#   fragments).
periodFragmentIndex: Int! 
#   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! 
currentIndicators: TargetsIndicators! 
# Arguments
#   includeChildIds: [Not documented]
currentMetrics(includeChildIds: [UUID]): [TargetsCurrentMetrics]! 
# Arguments
#   includeChildIds: [Not documented]
currentTargetValue(includeChildIds: [UUID]): Float! 
# Arguments
#   metric: [Not documented]
#   granularity: [Not documented]
#   includeChildIds: [Not documented]
chartData(
metric: TargetsMetricEnum!,
granularity: TargetsChartGranularityEnum!,
includeChildIds: [UUID]
): [TargetsUserChartData!]! 
#   If group target -> null else period of target!
absolutePeriod: TargetsAbsolutePeriod 
#   Returns if period.type and period.year can be updated - Child of inactive group 
#   is dependent on the group
canUpdatePeriodTypeAndYear: Boolean! 
#   Returns if period.fragment_type can be updated - Child of inactive group is 
#   dependent on the group!
canUpdatePeriodFragmentType: Boolean! 
#   Returns if settings.filter and settings.pipeline_lead_process_id can be changed 
#   - Child of inactive group is dependent on the group
canChangeFilterSettings: Boolean! 
#   Indicate if target_client can be changed.
canChangeTargetClient: Boolean! 
simulatedIndicators: SimulatedTargetIndicators! 
}
TargetEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
