The System Period Information (sys_period_information) Data Block is an Open-Source Data Block and may be edited.
The System Period Information (sys_period_information) Data Block defines a set of periods using period codes and their respective details, such as the display name, number of years, months, and quarters for each period. Each period is categorized based on its duration, such as month-to-date, quarter-to-date, year-to-date, prior years, or prior quarters. This Data Block is used to manage the calculation and display of time periods for various financial or reporting purposes. This Data Block is open-source and may be edited as needed.
- Period Codes: These codes represent different time periods, such as
QTD(Quarter to Date),MTD(Month to Date),YTD(Year to Date), and more. - DisplayName: A human-readable description of the period (e.g., “Quarter to Date”, “Prior Calendar Year 1”).
- Years, Months, Quarters: Specifies how many years, months, or quarters each period spans. Empty fields represent periods where that particular unit is not relevant.
Examples: #
"QTD": Represents “Quarter to Date” and doesn’t specify a particular number of years, months, or quarters."PQ1": Represents “Prior Quarter 1” and spans 1 quarter."PY2": Represents “Prior Calendar Year 2” and spans 2 years."6MT": Represents “6 Months” and spans 6 months.
The System Period Information (sys_period_information) Data Block may be used as a helper Data Block when calculating date ranges for these periods based on provided reference dates (like AsofDate or InceptionDate). This data block aids in mapping period codes to time ranges.
General Info #
The following table shows the default fields of the Data Block.
| Field | Value |
|---|---|
| Name | sys_period_information |
| Block Category | Transform |
| Block Type | None |
| Data Category | None |
| Output Type | Data Table |
| Editable | True |
Dependencies #
None
Columns #
None
Example Definition #
{
"QTD": {
"DisplayName": "Quarter to Date",
"Years": "",
"Months": "",
"Quarters": ""
},
"MTD": {
"DisplayName": "Month to Date",
"Years": "",
"Months": "",
"Quarters": ""
},
"YTD": {
"DisplayName": "Year to Date",
"Years": "",
"Months": "",
"Quarters": ""
},
"MRQ": {
"DisplayName": "Most recent quarter",
"Years": "",
"Months": "",
"Quarters": ""
},
"PQ1": {
"DisplayName": "Prior Quarter 1",
"Years": "",
"Months": "",
"Quarters": 1.0
},
"PQ2": {
"DisplayName": "Prior Quarter 2",
"Years": "",
"Months": "",
"Quarters": 2.0
},
"PQ3": {
"DisplayName": "Prior Quarter 3",
"Years": "",
"Months": "",
"Quarters": 3.0
},
"PQ4": {
"DisplayName": "Prior Quarter 4",
"Years": "",
"Months": "",
"Quarters": 4.0
},
"PY1": {
"DisplayName": "Prior Calendar Year 1",
"Years": 1.0,
"Months": "",
"Quarters": ""
},
"PY2": {
"DisplayName": "Prior Calendar Year 2",
"Years": 2.0,
"Months": "",
"Quarters": ""
},
"PY3": {
"DisplayName": "Prior Calendar Year 3",
"Years": 3.0,
"Months": "",
"Quarters": ""
},
"PY4": {
"DisplayName": "Prior Calendar Year 4",
"Years": 4.0,
"Months": "",
"Quarters": ""
},
"PY5": {
"DisplayName": "Prior Calendar Year 5",
"Years": 5.0,
"Months": "",
"Quarters": ""
},
"PY6": {
"DisplayName": "Prior Calendar Year 6",
"Years": 6.0,
"Months": "",
"Quarters": ""
},
"PY7": {
"DisplayName": "Prior Calendar Year 7",
"Years": 7.0,
"Months": "",
"Quarters": ""
},
"PY8": {
"DisplayName": "Prior Calendar Year 8",
"Years": 8.0,
"Months": "",
"Quarters": ""
},
"PY9": {
"DisplayName": "Prior Calendar Year 9",
"Years": 9.0,
"Months": "",
"Quarters": ""
},
"PY10": {
"DisplayName": "Prior Calendar Year 10",
"Years": 10.0,
"Months": "",
"Quarters": ""
},
"1MT": {
"DisplayName": "1 Month",
"Years": "",
"Months": 1.0,
"Quarters": ""
},
"3MT": {
"DisplayName": "3 Months",
"Years": "",
"Months": 3.0,
"Quarters": ""
},
"6MT": {
"DisplayName": "6 Months",
"Years": "",
"Months": 6.0,
"Quarters": ""
},
"9MT": {
"DisplayName": "9 Months",
"Years": "",
"Months": 9.0,
"Quarters": ""
},
"12MT": {
"DisplayName": "1 Year",
"Years": "",
"Months": 12.0,
"Quarters": ""
},
"2YC": {
"DisplayName": "2 Year - Cumulative",
"Years": 2.0,
"Months": "",
"Quarters": ""
},
"3YC": {
"DisplayName": "3 Year - Cumulative",
"Years": 3.0,
"Months": "",
"Quarters": ""
},
"4YC": {
"DisplayName": "4 Year - Cumulative",
"Years": 4.0,
"Months": "",
"Quarters": ""
},
"5YC": {
"DisplayName": "5 Year - Cumulative",
"Years": 5.0,
"Months": "",
"Quarters": ""
},
"6YC": {
"DisplayName": "6 Year - Cumulative",
"Years": 6.0,
"Months": "",
"Quarters": ""
},
"7YC": {
"DisplayName": "7 Year - Cumulative",
"Years": 7.0,
"Months": "",
"Quarters": ""
},
"8YC": {
"DisplayName": "8 Year - Cumulative",
"Years": 8.0,
"Months": "",
"Quarters": ""
},
"9YC": {
"DisplayName": "9 Year - Cumulative",
"Years": 9.0,
"Months": "",
"Quarters": ""
},
"10YC": {
"DisplayName": "10 Year - Cumulative",
"Years": 10.0,
"Months": "",
"Quarters": ""
},
"12YC": {
"DisplayName": "12 Year - Cumulative",
"Years": 12.0,
"Months": "",
"Quarters": ""
},
"15YC": {
"DisplayName": "15 Year - Cumulative",
"Years": 15.0,
"Months": "",
"Quarters": ""
},
"20YC": {
"DisplayName": "20 Year - Cumulative",
"Years": 20.0,
"Months": "",
"Quarters": ""
},
"25YC": {
"DisplayName": "25 Year - Cumulative",
"Years": 25.0,
"Months": "",
"Quarters": ""
},
"30YC": {
"DisplayName": "30 Year - Cumulative",
"Years": 30.0,
"Months": "",
"Quarters": ""
},
"ITD": {
"DisplayName": "Inception to Date - Cumulative",
"Years": "",
"Months": "",
"Quarters": ""
},
"2YA": {
"DisplayName": "2 Year - Annualized",
"Years": 2.0,
"Months": "",
"Quarters": ""
},
"3YA": {
"DisplayName": "3 Year - Annualized",
"Years": 3.0,
"Months": "",
"Quarters": ""
},
"4YA": {
"DisplayName": "4 Year - Annualized",
"Years": 4.0,
"Months": "",
"Quarters": ""
},
"5YA": {
"DisplayName": "5 Year - Annualized",
"Years": 5.0,
"Months": "",
"Quarters": ""
},
"6YA": {
"DisplayName": "6 Year - Annualized",
"Years": 6.0,
"Months": "",
"Quarters": ""
},
"7YA": {
"DisplayName": "7 Year - Annualized",
"Years": 7.0,
"Months": "",
"Quarters": ""
},
"8YA": {
"DisplayName": "8 Year - Annualized",
"Years": 8.0,
"Months": "",
"Quarters": ""
},
"9YA": {
"DisplayName": "9 Year - Annualized",
"Years": 9.0,
"Months": "",
"Quarters": ""
},
"10YA": {
"DisplayName": "10 Year - Annualized",
"Years": 10.0,
"Months": "",
"Quarters": ""
},
"12YA": {
"DisplayName": "12 Year - Annualized",
"Years": 12.0,
"Months": "",
"Quarters": ""
},
"15YA": {
"DisplayName": "15 Year - Annualized",
"Years": 15.0,
"Months": "",
"Quarters": ""
},
"20YA": {
"DisplayName": "20 Year - Annualized",
"Years": 20.0,
"Months": "",
"Quarters": ""
},
"25YA": {
"DisplayName": "25 Year - Annualized",
"Years": 25.0,
"Months": "",
"Quarters": ""
},
"30YA": {
"DisplayName": "30 Year - Annualized",
"Years": 30.0,
"Months": "",
"Quarters": ""
},
"ITDA": {
"DisplayName": "Inception to Date - Annualized",
"Years": "",
"Months": "",
"Quarters": ""
},
"FYTD": {
"DisplayName": "Fiscal Year to Date",
"Years": "",
"Months": "",
"Quarters": ""
},
"MRFQ": {
"DisplayName": "Most Recent Fiscal Quarter",
"Years": "",
"Months": "",
"Quarters": ""
},
"PFQ1": {
"DisplayName": "Prior Fiscal Quarter 1",
"Years": "",
"Months": "",
"Quarters": 1.0
},
"PFQ2": {
"DisplayName": "Prior Fiscal Quarter 2",
"Years": "",
"Months": "",
"Quarters": 2.0
},
"PFQ3": {
"DisplayName": "Prior Fiscal Quarter 3",
"Years": "",
"Months": "",
"Quarters": 3.0
},
"PFQ4": {
"DisplayName": "Prior Fiscal Quarter 4",
"Years": "",
"Months": "",
"Quarters": 4.0
},
"PFY1": {
"DisplayName": "Prior Fiscal Year 1",
"Years": 1.0,
"Months": "",
"Quarters": ""
},
"PFY2": {
"DisplayName": "Prior Fiscal Year 2",
"Years": 2.0,
"Months": "",
"Quarters": ""
},
"PFY3": {
"DisplayName": "Prior Fiscal Year 3",
"Years": 3.0,
"Months": "",
"Quarters": ""
},
"PFY4": {
"DisplayName": "Prior Fiscal Year 4",
"Years": 4.0,
"Months": "",
"Quarters": ""
},
"PFY5": {
"DisplayName": "Prior Fiscal Year 5",
"Years": 5.0,
"Months": "",
"Quarters": ""
},
"PFY6": {
"DisplayName": "Prior Fiscal Year 6",
"Years": 6.0,
"Months": "",
"Quarters": ""
},
"PFY7": {
"DisplayName": "Prior Fiscal Year 7",
"Years": 7.0,
"Months": "",
"Quarters": ""
},
"PFY8": {
"DisplayName": "Prior Fiscal Year 8",
"Years": 8.0,
"Months": "",
"Quarters": ""
},
"PFY9": {
"DisplayName": "Prior Fiscal Year 9",
"Years": 9.0,
"Months": "",
"Quarters": ""
},
"PFY10": {
"DisplayName": "Prior Fiscal Year 10",
"Years": 10.0,
"Months": "",
"Quarters": ""
},
"MRM": {
"DisplayName": "Most Recent Calendar Month",
"Years": "",
"Months": "",
"Quarters": ""
},
"PM1": {
"DisplayName": "Prior Calendar Month 1",
"Years": "",
"Months": 1,
"Quarters": ""
},
"PM2": {
"DisplayName": "Prior Calendar Month 2",
"Years": "",
"Months": 2,
"Quarters": ""
},
"PM3": {
"DisplayName": "Prior Calendar Month 3",
"Years": "",
"Months": 3,
"Quarters": ""
},
"MRY": {
"DisplayName": "Most Recent Calendar Year",
"Years": "",
"Months": "",
"Quarters": ""
}
}Example Request #
The following code shows an example request using the default values of the Data Block.
{}Example Response #
The following code shows an example response using the default values of the Data Block. The default data source is the Assette Snowflake Demo Instance. The response may be shortened for brevity.
{
"QTD": {
"DisplayName": "Quarter to Date",
"Years": "",
"Months": "",
"Quarters": ""
},
"MTD": {
"DisplayName": "Month to Date",
"Years": "",
"Months": "",
"Quarters": ""
},
"YTD": {
"DisplayName": "Year to Date",
"Years": "",
"Months": "",
"Quarters": ""
},
"errors": [],
"success": true,
"logs": []
}