Use this call to update the current fiscal year for the model calendar.

This supports annual rollover and administrative automation when the model needs to move into a new fiscal year.

The year input value has to be a valid fiscal year supported by the model calendar in Anaplan. If successful, this call returns the updated fiscal year with start and end dates associated with current model calendar type. This call returns a 400 bad request message if the input value is out of range or model calendar type doesn't have an available fiscal year, for example, Weeks General.

Note: To use this call, you must be a Workspace Administrator.

Method and endpoint

PUT

/workspaces/{workspaceId}/models/{modelId}/modelCalendar/fiscalYear

Parameters

ParameterDetails
{workspaceId}
  • Required
  • Type: String
  • Description: The workspace ID
  • Example: 8a8196b15b7dbae6015b8694411d13fe
{modelId}
  • Required
  • Type: String
  • Description: the model ID
  • Example: 75A40874E6B64FA3AE074327899685

Curl example

curl -X PUT 'https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/modelCalendar/fiscalYear' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data-raw '{
   "year": "{fiscal year}"
}'

Response

Response headers

Content-Type: application/json

Response 200 body

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/objects/modelCalendar"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "modelCalendar": {
       "fiscalYear": {
           "year": "FY21",
           "startDate": "2021-01-01",
           "endDate": "2021-12-31"
       }
   }
}

Example: Out of range error

Input value for year

{
   "year": "FY40"
}

Response

{
   "status": {
       "code": 400,
       "message": "Specified year is out of range: 2040"
   }
}

Group model versions

View these endpoints for more details: