Budget control configuration in Group(BudgetControlConfiguration)

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	BudgetControlConfiguration/(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 control configuration	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Group/BudgetControlConfiguration
DefaultBudgetCycleTimeSpan		Group/BudgetControlConfiguration
DefaultInterval		Group/BudgetControlConfiguration
DefaultResponsibleUser		Group/BudgetControlConfiguration
DefaultThresholdPercent		Group/BudgetControlConfiguration
DimensionHierarchyAccountStructure		Group/BudgetControlConfiguration
IncludeCarryforwardAmounts		Group/BudgetControlConfiguration
InUseBy		Group/BudgetControlConfiguration
InUseSinceDateTime		Group/BudgetControlConfiguration
IsActive		Group/BudgetControlConfiguration
PrimaryLedger		Group/BudgetControlConfiguration
SubtractActualExpenditures		Group/BudgetControlConfiguration
SubtractDraftEncumbranceReductions		Group/BudgetControlConfiguration
SubtractDraftEncumbrances		Group/BudgetControlConfiguration
SubtractDraftPreencumbrances		Group/BudgetControlConfiguration
SubtractEncumbrances		Group/BudgetControlConfiguration
SubtractPreencumbrances		Group/BudgetControlConfiguration
SubtractUnpostedActualExpenditures		Group/BudgetControlConfiguration
SumAmendments		Group/BudgetControlConfiguration
SumDraftAmendments		Group/BudgetControlConfiguration
SumDraftTransfersIn		Group/BudgetControlConfiguration
SumDraftTransfersOut		Group/BudgetControlConfiguration
SumOriginalBudget		Group/BudgetControlConfiguration
SumPreliminaryBudget		Group/BudgetControlConfiguration
SumTransfers		Group/BudgetControlConfiguration
UseApportionedAmount		Group/BudgetControlConfiguration
WarnOnOverBudgetThreshold		Group/BudgetControlConfiguration
MaintainCarryforwardAmounts		Group/BudgetControlConfiguration
Relationship_BudgetCycleTimeSpanRelationshipId		Group/BudgetControlConfiguration
Relationship_DimensionHierarchyRelationshipId		Group/BudgetControlConfiguration
Relationship_LedgerRelationshipId		Group/BudgetControlConfiguration

RecId

First included in: Group/BudgetControlConfiguration (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	BudgetControlConfiguration/(resolvedAttributes)/RecId	attribute

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

DefaultBudgetCycleTimeSpan

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Budget cycle time span
dataFormat	int64
isNullable	true

Traits

List of traits for the DefaultBudgetCycleTimeSpan 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 Budget cycle time span	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

DefaultInterval

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the DefaultInterval attribute are listed below.

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

is.dataFormat.integer

DefaultResponsibleUser

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the DefaultResponsibleUser 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

DefaultThresholdPercent

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Budget threshold
dataFormat	decimal
isNullable	true

Traits

List of traits for the DefaultThresholdPercent attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

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 Budget threshold	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

DimensionHierarchyAccountStructure

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Account structure
dataFormat	int64

Traits

List of traits for the DimensionHierarchyAccountStructure attribute are listed below.

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

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

is.dataFormat.integer
is.dataFormat.big

IncludeCarryforwardAmounts

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Include carry-forward amounts
dataFormat	int32
isNullable	true

Traits

List of traits for the IncludeCarryforwardAmounts 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 Include carry-forward amounts	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

InUseBy

First included in: Group/BudgetControlConfiguration (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

InUseSinceDateTime

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	In use since
dataFormat	date
isNullable	true

Traits

List of traits for the InUseSinceDateTime attribute are listed below.

is.dataFormat.date
means.measurement.date
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 since	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.date

IsActive

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Active
dataFormat	int32
isNullable	true

Traits

List of traits for the IsActive 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 Active	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

PrimaryLedger

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the PrimaryLedger attribute are listed below.

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

SubtractActualExpenditures

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Actual expenditures
dataFormat	int32
isNullable	true

Traits

List of traits for the SubtractActualExpenditures 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 Actual expenditures	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SubtractDraftEncumbranceReductions

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Reduction to budget reservations for unconfirmed encumbrances
dataFormat	int32
isNullable	true

Traits

List of traits for the SubtractDraftEncumbranceReductions 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 Reduction to budget reservations for unconfirmed encumbrances	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SubtractDraftEncumbrances

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Budget reservations for unconfirmed encumbrances
dataFormat	int32
isNullable	true

Traits

List of traits for the SubtractDraftEncumbrances 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 Budget reservations for unconfirmed encumbrances	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SubtractDraftPreencumbrances

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Budget reservations for unconfirmed pre-encumbrances
dataFormat	int32
isNullable	true

Traits

List of traits for the SubtractDraftPreencumbrances 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 Budget reservations for unconfirmed pre-encumbrances	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SubtractEncumbrances

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Budget reservations for encumbrances
dataFormat	int32
isNullable	true

Traits

List of traits for the SubtractEncumbrances 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 Budget reservations for encumbrances	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SubtractPreencumbrances

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Budget reservations for pre-encumbrances
dataFormat	int32
isNullable	true

Traits

List of traits for the SubtractPreencumbrances 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 Budget reservations for pre-encumbrances	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SubtractUnpostedActualExpenditures

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Unposted actual expenditures
dataFormat	int32
isNullable	true

Traits

List of traits for the SubtractUnpostedActualExpenditures 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 Unposted actual expenditures	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SumAmendments

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Budget revisions
dataFormat	int32
isNullable	true

Traits

List of traits for the SumAmendments 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 Budget revisions	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SumDraftAmendments

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Draft budget revisions
dataFormat	int32
isNullable	true

Traits

List of traits for the SumDraftAmendments 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 Draft budget revisions	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SumDraftTransfersIn

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Draft budget transfers in
dataFormat	int32
isNullable	true

Traits

List of traits for the SumDraftTransfersIn 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 Draft budget transfers in	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SumDraftTransfersOut

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Draft budget transfers out
dataFormat	int32
isNullable	true

Traits

List of traits for the SumDraftTransfersOut 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 Draft budget transfers out	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SumOriginalBudget

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Original budget
dataFormat	int32
isNullable	true

Traits

List of traits for the SumOriginalBudget 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 Original budget	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SumPreliminaryBudget

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Preliminary budget
dataFormat	int32
isNullable	true

Traits

List of traits for the SumPreliminaryBudget 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 Preliminary budget	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SumTransfers

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Budget transfers
dataFormat	int32
isNullable	true

Traits

List of traits for the SumTransfers 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 Budget transfers	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

UseApportionedAmount

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Use only apportioned amount
dataFormat	int32
isNullable	true

Traits

List of traits for the UseApportionedAmount 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 Use only apportioned amount	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

WarnOnOverBudgetThreshold

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Display a message when exceeding budget threshold
dataFormat	int32
isNullable	true

Traits

List of traits for the WarnOnOverBudgetThreshold 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 Display a message when exceeding budget threshold	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

MaintainCarryforwardAmounts

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
displayName	Maintain carry-forward status for documents
dataFormat	int32
isNullable	true

Traits

List of traits for the MaintainCarryforwardAmounts 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 Maintain carry-forward status for documents	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Relationship_BudgetCycleTimeSpanRelationshipId

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_BudgetCycleTimeSpanRelationshipId 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/BudgetCycleTimeSpan.cdm.json/BudgetCycleTimeSpan RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_DimensionHierarchyRelationshipId

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_DimensionHierarchyRelationshipId 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/FinancialDimensions/Group/DimensionHierarchy.cdm.json/DimensionHierarchy RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_LedgerRelationshipId

First included in: Group/BudgetControlConfiguration (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_LedgerRelationshipId 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/Ledger/Main/Ledger.cdm.json/Ledger RecId	entity	a reference to the constant entity holding the list of entity references

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