Summarization of financial activity for a ledger, date, account, and dimension combination
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|
| versionNumber | "0.9" | string | semantic version number of the entity |
is.identifiedBy
names a specifc identity attribute to use with an entity
is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.
| Parameter | Value | Data type | Explanation |
|---|
| groupList | | attributeGroupReference |
|---|
/core/applicationCommon/foundationCommon
/financeCommon/FinanceActivity.cdm.json
/FinanceActivity/hasAttributes
/attributesAddedAtThisScope |
| entity | |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Financial Activity |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Summarization of financial activity for a ledger, date, account, and dimension combination |
| entity | a reference to the constant entity holding the list of localized text |
Attributes
The surrogate key of the record
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | Financial Activity ID |
| description | The surrogate key of the record |
| isPrimaryKey | true |
| dataFormat | string |
Traits
List of traits for the financialActivityId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.identifiedBy
names a specifc identity attribute to use with an entity
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Financial Activity ID |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The surrogate key of the record |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
The category of the main account for this activity, denormalized for reporting
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | Main Account Category Key |
| description | The category of the main account for this activity, denormalized for reporting |
| dataFormat | string |
Traits
List of traits for the mainAccountCategoryKey attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Main Account Category Key |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The category of the main account for this activity, denormalized for reporting |
| entity | a reference to the constant entity holding the list of localized text |
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 | | entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.character
is.dataFormat.array
The main account containing this financial activity
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | Main Account Key |
| description | The main account containing this financial activity |
| dataFormat | string |
Traits
List of traits for the mainAccountKey attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Main Account Key |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The main account containing this financial activity |
| entity | a reference to the constant entity holding the list of localized text |
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 | | entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.character
is.dataFormat.array
The company for which this financial activity occurred
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | Company Key |
| description | The company for which this financial activity occurred |
| dataFormat | string |
Traits
List of traits for the companyKey attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Company Key |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The company for which this financial activity occurred |
| entity | a reference to the constant entity holding the list of localized text |
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 | | entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.character
is.dataFormat.array
The currency in which the source transaction occurred
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | Transaction Currency Key |
| description | The currency in which the source transaction occurred |
| dataFormat | string |
Traits
List of traits for the transactionCurrencyKey attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Transaction Currency Key |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The currency in which the source transaction occurred |
| entity | a reference to the constant entity holding the list of localized text |
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 | | entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.character
is.dataFormat.array
The fiscal period in which the financial activity occurred
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | Fiscal Calendar Period Key |
| description | The fiscal period in which the financial activity occurred |
| dataFormat | string |
Traits
List of traits for the fiscalCalendarPeriodKey attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Fiscal Calendar Period Key |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The fiscal period in which the financial activity occurred |
| entity | a reference to the constant entity holding the list of localized text |
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 | | entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.character
is.dataFormat.array
A denormalization of the full string representing the main account plus additional dimension values
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | Ledger Dimension Display Value |
| description | A denormalization of the full string representing the main account plus additional dimension values |
| dataFormat | string |
Traits
List of traits for the ledgerDimensionDisplayValue attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Ledger Dimension Display Value |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | A denormalization of the full string representing the main account plus additional dimension values |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
A denormalization of the currency code in which the source transaction occurred
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | Transaction Currency Code |
| description | A denormalization of the currency code in which the source transaction occurred |
| dataFormat | string |
Traits
List of traits for the transactionCurrencyCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Transaction Currency Code |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | A denormalization of the currency code in which the source transaction occurred |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.character
is.dataFormat.array
The amount of the financial activity expressed in the accounting currency
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | AccountingCurrencyAmount |
| description | The amount of the financial activity expressed in the accounting currency |
| dataFormat | decimal |
Traits
List of traits for the accountingCurrencyAmount attribute are listed below.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|
| precision | "19" | integer | the total number of significant digits |
| scale | "4" | integer | the number of digits to the right of the decimal place |
means.measurement.currency
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | AccountingCurrencyAmount |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The amount of the financial activity expressed in the accounting currency |
| 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
The date on which the financial activity was recognized
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | AccountingDate |
| description | The date on which the financial activity was recognized |
| dataFormat | date |
Traits
List of traits for the accountingDate attribute are listed below.
is.dataFormat.date
means.measurement.date
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | AccountingDate |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The date on which the financial activity was recognized |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.date
The ledger containing this financial activity
First included in: financialCommon/FinancialActivity (this entity)
Properties
| Name | Value |
|---|
| displayName | Ledger |
| description | The ledger containing this financial activity |
| dataFormat | string |
Traits
List of traits for the ledgerId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | Ledger |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation |
|---|
| localizedDisplayText | | languageTag | displayText |
|---|
| en | The ledger containing this financial activity |
| entity | a reference to the constant entity holding the list of localized text |
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 | | entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.character
is.dataFormat.array