Fiscal Calendar Period in financialCommon

Represents the period in which financial activity occurred, as defined by a fiscal calendar.

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	"1.0"	string	semantic version number of the entity

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

Parameter	Value	Data type	Explanation
attribute	FiscalCalendarPeriod/(resolvedAttributes)/fiscalCalendarPeriodId	attribute

is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.

Parameter	Value	Data type	Explanation
groupList	attributeGroupReference /core/applicationCommon/foundationCommon /financeCommon/FiscalCalendarPeriod.cdm.json /FiscalCalendarPeriod/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 Fiscal Calendar Period	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 Represents the period in which financial activity occurred, as defined by a fiscal calendar.	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
fiscalCalendarPeriodId	The surrogate key of the record	financialCommon/FiscalCalendarPeriod
fiscalCalendarName	The name of the calendar containing this period	financialCommon/FiscalCalendarPeriod
periodName	The name of the period	financialCommon/FiscalCalendarPeriod
periodOffset	The number of periods this period is offset from the current period for use in computations such as previous period	financialCommon/FiscalCalendarPeriod
yearName	The name of the year containing the period	financialCommon/FiscalCalendarPeriod
yearOffset	The number of years this year is offset from the current year for use in computations such as prior year	financialCommon/FiscalCalendarPeriod
quarter	The name of the quarter containing the period	financialCommon/FiscalCalendarPeriod
quarterOffset	The number of quarters this quarter is offset from the current quarter for use in computations such as same quarter previous year	financialCommon/FiscalCalendarPeriod
month	The month containing the period.	financialCommon/FiscalCalendarPeriod

fiscalCalendarPeriodId

The surrogate key of the record
First included in: financialCommon/FiscalCalendarPeriod (this entity)

Properties

Name	Value
displayName	Fiscal Calendar Period ID
description	The surrogate key of the record
isPrimaryKey	true
dataFormat	string

Traits

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

Parameter	Value	Data type	Explanation
attribute	FiscalCalendarPeriod/(resolvedAttributes)/fiscalCalendarPeriodId	attribute

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 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

fiscalCalendarName

The name of the calendar containing this period
First included in: financialCommon/FiscalCalendarPeriod (this entity)

Properties

Name	Value
displayName	Fiscal Calendar Name
description	The name of the calendar containing this period
dataFormat	string

Traits

List of traits for the fiscalCalendarName 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 Name	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 name of the calendar containing this period	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

periodName

The name of the period
First included in: financialCommon/FiscalCalendarPeriod (this entity)

Properties

Name	Value
displayName	Period Name
description	The name of the period
dataFormat	string

Traits

List of traits for the periodName 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 Period Name	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 name of the period	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

periodOffset

The number of periods this period is offset from the current period for use in computations such as previous period
First included in: financialCommon/FiscalCalendarPeriod (this entity)

Properties

Name	Value
displayName	Period Offset
description	The number of periods this period is offset from the current period for use in computations such as previous period
dataFormat	int32

Traits

List of traits for the periodOffset attribute are listed below.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Period Offset	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 number of periods this period is offset from the current period for use in computations such as previous period	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

yearName

The name of the year containing the period
First included in: financialCommon/FiscalCalendarPeriod (this entity)

Properties

Name	Value
displayName	Year Name
description	The name of the year containing the period
dataFormat	string

Traits

List of traits for the yearName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.calendar.year
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Year Name	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 name of the year containing the period	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

yearOffset

The number of years this year is offset from the current year for use in computations such as prior year
First included in: financialCommon/FiscalCalendarPeriod (this entity)

Properties

Name	Value
displayName	Year Offset
description	The number of years this year is offset from the current year for use in computations such as prior year
dataFormat	int32

Traits

List of traits for the yearOffset attribute are listed below.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Year Offset	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 number of years this year is offset from the current year for use in computations such as prior year	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

quarter

The name of the quarter containing the period
First included in: financialCommon/FiscalCalendarPeriod (this entity)

Properties

Name	Value
displayName	Quarter
description	The name of the quarter containing the period
dataFormat	string

Traits

List of traits for the quarter attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.calendar.quarter
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Quarter	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 name of the quarter containing the period	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

quarterOffset

The number of quarters this quarter is offset from the current quarter for use in computations such as same quarter previous year
First included in: financialCommon/FiscalCalendarPeriod (this entity)

Properties

Name	Value
displayName	Quarter Offset
description	The number of quarters this quarter is offset from the current quarter for use in computations such as same quarter previous year
dataFormat	int32

Traits

List of traits for the quarterOffset attribute are listed below.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Quarter Offset	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 number of quarters this quarter is offset from the current quarter for use in computations such as same quarter previous year	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

month

The month containing the period.
First included in: financialCommon/FiscalCalendarPeriod (this entity)

Properties

Name	Value
displayName	Month
description	The month containing the period.
dataFormat	int32

Traits

List of traits for the month attribute are listed below.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Month	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 month containing the period.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer