Zoho: Update Fiscal Year Settings

← Fiscal year operations · Get started

Operation zoho.updatefiscalyear

Provider route: PUT /crm/v8/settings/fiscal_year. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["fiscalYear"]["updateFiscalYear"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.fiscalYear.updateFiscalYear(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.fiscal_year.update_fiscal_year(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Optional	Expand Update Fiscal Year Settings — request body — body

Referenced models: Update Fiscal Year Settings — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Update Fiscal Year Settings — response body

Referenced models: Update Fiscal Year Settings — response body

Schemas

3 more schemas are linked from the tables above, on the schema pages.

Update Fiscal Year Settings — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for a successful fiscal year settings update. Additional keys: not allowed
fiscal_year	Model	Required within parent	Expand Update Fiscal Year Settings — response body — fiscal year

Referenced models: Update Fiscal Year Settings — response body — fiscal year

Update Fiscal Year Settings — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for updating the fiscal year settings of the Zoho CRM organization. Additional keys: not allowed
fiscal_year	Model	Required within parent	Expand Update Fiscal Year Settings — request body — body fiscal year Root key of the API (Required)

Referenced models: Update Fiscal Year Settings — request body — body fiscal year

Update Fiscal Year Settings — response body — fiscal year

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for a successful fiscal year settings update, including the status code, message, and updated record details. Additional keys: not allowed
code	string	Required within parent	Represents the status code of the operation. Possible values: `SUCCESS`. Known values: SUCCESS
details	Model	Required within parent	Expand Update Fiscal Year Settings — response body — fiscal year details
message	string	Required within parent	Represents the status message of the operation. Maximum length: 255
status	string	Required within parent	Represents the status of the response. Possible values: `success`. Known values: success

Referenced models: Update Fiscal Year Settings — response body — fiscal year details

Update Fiscal Year Settings — request body — body fiscal year

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the fiscal year settings to update. Use one of the supported request structures based on the type of fiscal year update being performed.
$ (anyOf 1)	Model	Alternative	Expand Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month — Display Based On Fiscal Year Update
$ (anyOf 2)	Model	Alternative	Expand Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month — Standard Fiscal Year Update
$ (anyOf 3)	Model	Alternative	Expand Update Fiscal Year Settings — request body — body / fiscal_year / calendar_type: gregorian, display based on: start month, end month
$ (anyOf 4)	Model	Alternative	Expand Update Fiscal Year Settings — request body — body / fiscal_year / calendar_type: custom, display based on: start month, end month, interval display option: year, quarter, structure: 4-4-5, 4-5-4, 5-4-4, 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3
$ (anyOf 5)	Model	Alternative	Expand Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month, interval display option: year, quarter, structure: 4-4-5, 4-5-4, 5-4-4, 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3

Referenced models: Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month, interval display option: year, quarter, structure: 4-4-5, 4-5-4, 5-4-4, 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3, Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month — Display Based On Fiscal Year Update, Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month — Standard Fiscal Year Update, Update Fiscal Year Settings — request body — body / fiscal_year / calendar_type: custom, display based on: start month, end month, interval display option: year, quarter, structure: 4-4-5, 4-5-4, 5-4-4, 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3, Update Fiscal Year Settings — request body — body / fiscal_year / calendar_type: gregorian, display based on: start month, end month

Update Fiscal Year Settings — response body — fiscal year details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the updated fiscal year configuration, including its unique identifier. Additional keys: not allowed
id	string	Required within parent	Represents the unique identifier of the updated fiscal year configuration. Format: int64 Maximum length: 255

Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month, interval display option: year, quarter, structure: 4-4-5, 4-5-4, 5-4-4, 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request payload to update selected settings of an existing custom fiscal year. When `start_month` is provided alongside `start_date`, its value must match the month component of `start_date`. Minimum fields: 1 Additional keys: not allowed
display_based_on	string	Optional	Specify whether the custom fiscal year label is based on the start month or the end month of the fiscal period. When set to `end_month`, the `start_date` cannot fall in January or February. Possible values: `start_month`, `end_month`. One of: start_month, end_month Maximum length: 20
interval_display_option	string	Optional	Specify the display format for the custom fiscal year intervals. Possible values: `year`, `quarter`. One of: year, quarter Maximum length: 7
start_date	string	Optional	Specify the start date of the custom fiscal year. This field can be configured only for the current year. Format: date Maximum length: 10
start_month	string	Optional	Specify the start month of the fiscal year. Possible values: `JANUARY`, `FEBRUARY`, `MARCH`, `APRIL`, `MAY`, `JUNE`, `JULY`, `AUGUST`, `SEPTEMBER`, `OCTOBER`, `NOVEMBER`, `DECEMBER`. Specify the start month of the fiscal year. This field is optional. When provided, its value must match the month component of the configured start_date. One of: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER Maximum length: 20
structure	string	Optional	Specify the week distribution structure for the custom fiscal year. Possible values: `4-4-5`, `4-5-4`, `5-4-4`, `3-3-3-4`, `3-3-4-3`, `3-4-3-3`, `4-3-3-3`. One of: 4-4-5, 4-5-4, 5-4-4, 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3 Maximum length: 10
surplus_week	Model	Optional	Expand Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month, interval display option: year, quarter, structure: 4-4-5, 4-5-4, 5-4-4, 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3 surplus week Specify the surplus week configuration for the custom fiscal year. Send `null` to clear the configured surplus week.
$ (anyOf 1)	JSON	Alternative
$ (anyOf 2)	JSON	Alternative
$ (anyOf 3)	JSON	Alternative
$ (anyOf 4)	JSON	Alternative

Referenced models: Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month, interval display option: year, quarter, structure: 4-4-5, 4-5-4, 5-4-4, 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3 surplus week

Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month — Display Based On Fiscal Year Update

Field	Type	Presence	Description and constraints
$	object	Root	Represents a request to update only the fiscal year display option for an existing standard or custom fiscal year. Additional keys: not allowed
display_based_on	string	Required within parent	Specify whether the fiscal year label is based on the start month or the end month of the fiscal period. Possible values: `start_month`, `end_month`. One of: start_month, end_month Maximum length: 20

Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month — Standard Fiscal Year Update

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request payload to update standard fiscal year settings. When `display_based_on` is set to `end_month`, the `start_month` cannot be `JANUARY`. Additional keys: not allowed
display_based_on	string	Optional	Specify whether the fiscal year label is based on the start month or the end month of the fiscal period. When set to `end_month`, the `start_month` cannot be `JANUARY`. Possible values: `start_month`, `end_month`. One of: start_month, end_month Maximum length: 20
start_month	string	Required within parent	Specify the start month of the fiscal year. Possible values: `JANUARY`, `FEBRUARY`, `MARCH`, `APRIL`, `MAY`, `JUNE`, `JULY`, `AUGUST`, `SEPTEMBER`, `OCTOBER`, `NOVEMBER`, `DECEMBER`. One of: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER Maximum length: 20

Update Fiscal Year Settings — request body — body / fiscal_year / display_based_on: start month, end month, interval display option: year, quarter, structure: 4-4-5, 4-5-4, 5-4-4, 3-3-3-4, 3-3-4-3, 3-4-3-3, 4-3-3-3 surplus week period, quarter, year

Field	Type	Presence	Description and constraints
$	object	Root	Represents the surplus week configuration values, including the quarter, period, and year in which the surplus week is placed. Additional keys: not allowed
period	integer	Required within parent	Specify the fiscal period within the quarter that contains the surplus week. Format: int32
quarter	integer	Required within parent	Specify the fiscal quarter that contains the surplus week. Format: int32
year	integer	Required within parent	Specify the year in which the surplus week is configured. You can configure this only for the current year and the following year. Format: int32

Policy, approvals and errors

SDK function policy ID: zoho.updatefiscalyear. Catalog operation: updateFiscalYear. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source