Budget plans in WorksheetHeader(BudgetPlanHeader)

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	BudgetPlanHeader/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Budget plans	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		WorksheetHeader/BudgetPlanHeader
BudgetingOrganization		WorksheetHeader/BudgetPlanHeader
BudgetPlanningProcess		WorksheetHeader/BudgetPlanHeader
BudgetPlanningStage		WorksheetHeader/BudgetPlanHeader
BudgetPlanPreparer		WorksheetHeader/BudgetPlanHeader
BudgetPlanPriority		WorksheetHeader/BudgetPlanHeader
DocumentNumber		WorksheetHeader/BudgetPlanHeader
DocumentStatus		WorksheetHeader/BudgetPlanHeader
IsHistorical		WorksheetHeader/BudgetPlanHeader
Name		WorksheetHeader/BudgetPlanHeader
ParentBudgetPlanHeader		WorksheetHeader/BudgetPlanHeader
PlanningUserGroup		WorksheetHeader/BudgetPlanHeader
Rank		WorksheetHeader/BudgetPlanHeader
WorkflowStatus		WorksheetHeader/BudgetPlanHeader
Currency		WorksheetHeader/BudgetPlanHeader
Layout		WorksheetHeader/BudgetPlanHeader
InUseBy		WorksheetHeader/BudgetPlanHeader
NeedsUpdate		WorksheetHeader/BudgetPlanHeader
Relationship_BudgetingOrganizationRelationshipId		WorksheetHeader/BudgetPlanHeader
Relationship_BudgetPlanningProcessRelationshipId		WorksheetHeader/BudgetPlanHeader
Relationship_BudgetPlanningStageRelationshipId		WorksheetHeader/BudgetPlanHeader
Relationship_BudgetPlanPriorityRelationshipId		WorksheetHeader/BudgetPlanHeader
Relationship_UserGroupRelationshipId		WorksheetHeader/BudgetPlanHeader
Relationship_CurrencyRelationshipId		WorksheetHeader/BudgetPlanHeader
Relationship_LayoutRelationshipId		WorksheetHeader/BudgetPlanHeader

RecId

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	BudgetPlanHeader/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

BudgetingOrganization

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the BudgetingOrganization attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.dataFormat.integer
is.dataFormat.big

BudgetPlanningProcess

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the BudgetPlanningProcess attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.dataFormat.integer
is.dataFormat.big

BudgetPlanningStage

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the BudgetPlanningStage attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.dataFormat.integer
is.dataFormat.big

BudgetPlanPreparer

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the BudgetPlanPreparer attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.dataFormat.integer
is.dataFormat.big

BudgetPlanPriority

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the BudgetPlanPriority attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer
is.dataFormat.big

DocumentNumber

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the DocumentNumber attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

DocumentStatus

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int32

Traits

List of traits for the DocumentStatus attribute are listed below.

is.dataFormat.integer
is.dataFormat.integer

IsHistorical

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
displayName	Is historical
dataFormat	int32
isNullable	true

Traits

List of traits for the IsHistorical attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Is historical	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Name

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the Name attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

ParentBudgetPlanHeader

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
displayName	Parent budget plan
dataFormat	int64
isNullable	true

Traits

List of traits for the ParentBudgetPlanHeader attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Parent budget plan	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

PlanningUserGroup

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PlanningUserGroup attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Rank

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the Rank attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

WorkflowStatus

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int32

Traits

List of traits for the WorkflowStatus attribute are listed below.

is.dataFormat.integer
is.dataFormat.integer

Currency

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the Currency attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.character
is.dataFormat.array

Layout

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the Layout attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.dataFormat.integer
is.dataFormat.big

InUseBy

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
displayName	In use by user
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the InUseBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en In use by user	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

NeedsUpdate

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the NeedsUpdate attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

Relationship_BudgetingOrganizationRelationshipId

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BudgetingOrganizationRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Common/GAB/Main/OMInternalOrganization.cdm.json/OMInternalOrganization RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_BudgetPlanningProcessRelationshipId

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BudgetPlanningProcessRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/Budget/Group/BudgetPlanningProcess.cdm.json/BudgetPlanningProcess RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_BudgetPlanningStageRelationshipId

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BudgetPlanningStageRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/Budget/Group/BudgetPlanningStage.cdm.json/BudgetPlanningStage RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_BudgetPlanPriorityRelationshipId

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BudgetPlanPriorityRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/Budget/Group/BudgetPlanPriority.cdm.json/BudgetPlanPriority RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_UserGroupRelationshipId

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_UserGroupRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/System/SystemAdministration/Main/UserGroupInfo.cdm.json/UserGroupInfo RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_CurrencyRelationshipId

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CurrencyRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Common/Currency/Group/Currency.cdm.json/Currency RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_LayoutRelationshipId

First included in: WorksheetHeader/BudgetPlanHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_LayoutRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/Budget/Group/BudgetPlanLayout.cdm.json/BudgetPlanLayout RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array