FlexHierNodeSummary

Represents rollup data for a hierarchy node, including direct, child, and total aggregate values. This object is available in API version 67.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

This is a standard object and is available only when you turn on the Flexible Hierarchies Summary Rollup setting.

Fields

ChildAggregateCurrencyValue

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Child aggregate value in the currency format.

ChildAggregateNumberValue

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: Child aggregate value in the number format.

ChildAggregateValue

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Aggregated value of all child nodes, excluding the node's individual contribution.

FlexibleHierarchyNodeId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The hierarchy node associated with this summary.

    This field is a relationship field.

  • Relationship Name: FlexibleHierarchyNode
  • Relationship Type: Master-detail
  • Refers To: FlexibleHierarchyNode (the master object)

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The most recent date when a user referenced this record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The most recent date when a user viewed this record.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The name of the hierarchy node summary.

NodeCurrencyValue

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Node value in the currency format.

NodeMeasureType

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The financial measure or category summarized, such as total account balance or total opportunities.

NodeMeasureUnit

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort
  • Description: Unit for the node measure type, such as currency, percentage, or number. For example, if the measure type is total financial balance, the unit is currency.
  • Possible values:
    • Currency
    • Number
    • Percentage

NodeNumberValue

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: Node value in the number format.

NodeValue

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Individual value contributed by the node.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The owner of the flexible hierarchy node summary record.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Refers To: Group, User

TotalCurrencyValue

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total value in the currency format.

TotalNumberValue

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Description: Total value in the number format.

TotalValue

  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Consolidate total for the node, aggregating individual contributions from all child nodes and the node's direct value. For example, Total Financial Balances at a regional level reflects the sum of all branch balances plus assets held directly by the region.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

FlexHierNodeSummaryChangeEvent
Change events are available for the object.
FlexHierNodeSummaryFeed
Feed tracking is available for the object.
FlexHierNodeSummaryHistory
History is available for tracked fields of the object.
FlexHierNodeSummaryOwnerSharingRule
Sharing rules are available for the object.
FlexHierNodeSummaryShare
Sharing is available for the object.