FlexibleHierarchy

Represents the structure and hierarchy of relationships among individuals or entities within an organization or between organizations. This object is available in API version 66.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 setting.

Fields

CurrencyIsoCode

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Three-letter ISO currency code associated with the hierarchy.
Default value: USD
Possible values:
- INR—Indian Rupee
- USD—U.S. Dollar

EffectiveFromDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when this hierarchy becomes effective.

EffectiveToDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date until when this hiearchy remains effective.

HierarchyTypeReferenceId

Type: reference
Properties: Create, Filter, Group, Sort
Description: The hierarchy type associated with the flexible hierarchy.
This field is a relationship field.
Relationship Name: HierarchyTypeReference
Refers To: RelationshipGraphDefinition

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates if the hierarchy is active (true) or not (false).
Default value: false

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: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the record.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The owner of the flexible hierarchy record.
This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User

RootRecord

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The ID of the record that's the root of this hierarchy.

RootRecordObject

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The API name of the object that's the root of this hierarchy.

SourceSystemIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unique identifier of this record in an external system.

SourceSystemName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the external system this record was obtained from.

Status

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Specifies the current state of the hierarchy in its lifecycle.
Possible values:
- Draft
- Invalid
- InValidation
- Valid

ValidationError

Type: textarea
Properties: Create, Nillable, Update
Description: The error message generated while validating the structure of this hierarchy.

Financial Services Cloud Developer Guide