Get Period Dimensions

GET /api/PeriodDimensions

This request should be used to retrieve information around fiscal periods and fiscal years, hereunder the fiscal period year name, the fiscal period names, and the corresponding date ranges. This would be information that is found under Administration->Fiscal years.

Query parameters

period

possible values : Current or 0 - Current period for filtered engagement(s), LastThree or 1 - Last three period for filtered engagement(s), All or 99(Default option)
engagement

Short Guid of desired engagement Ex - ESXmkya-nEeWMX-7_3fSxA or Guid of desired engagement Ex - 45c31339-96d0-4262-b051-c00f392685c1

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- period_Key integer(int32)
- engagement_Key integer(int32)
- legalEntity_Key integer(int32)
- fiscalYearName string | null
- fiscalYearStart string(date-time) | null
- fiscalYearEnd string(date-time) | null
- period string | null
- periodName string | null
- periodSequence integer(int32)
- periodStart string(date-time) | null
- periodEnd string(date-time) | null
- periodFrequency string | null
- periodStatus string | null
- periodCreatedDate string(date-time) | null
- engagementGuid string(uuid)
- fiscalYearPeriodId integer(int32)
400

Bad Request
404

Not Found
500

Server Error

GET /api/PeriodDimensions

curl \
 -X GET https://analyticsapi.adra.com/balancer/api/PeriodDimensions

Response examples (200)

[
  {
    "period_Key": 42,
    "engagement_Key": 42,
    "legalEntity_Key": 42,
    "fiscalYearName": "string",
    "fiscalYearStart": "2025-05-04T09:42:00+00:00",
    "fiscalYearEnd": "2025-05-04T09:42:00+00:00",
    "period": "string",
    "periodName": "string",
    "periodSequence": 42,
    "periodStart": "2025-05-04T09:42:00+00:00",
    "periodEnd": "2025-05-04T09:42:00+00:00",
    "periodFrequency": "string",
    "periodStatus": "string",
    "periodCreatedDate": "2025-05-04T09:42:00+00:00",
    "engagementGuid": "string",
    "fiscalYearPeriodId": 42
  }
]