Zoho: Get Fiscal Year Settings
Zoho fiscalYear.getFiscalYear: arguments, response, policy and SDK examples.
← Fiscal year operations · Get started
Operation zoho.getfiscalyear
Provider route: GET /crm/v8/settings/fiscal_year. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["getFiscalYear"]>[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.getFiscalYear(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.get_fiscal_year(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “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 Get Fiscal Year Settings — response body |
Referenced models: Get Fiscal Year Settings — response body
Schemas
Section titled “Schemas”Get Fiscal Year Settings — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response body containing the fiscal year settings configured for the organization. Additional keys: not allowed |
fiscal_year | Model | Required within parent | Expand Get Fiscal Year Settings — response body — fiscal year |
Referenced models: Get Fiscal Year Settings — response body — fiscal year
Get Fiscal Year Settings — response body — fiscal year
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the fiscal year settings configured for the organization, including the calendar type, start month, structure, and surplus week information. Additional keys: not allowed |
calendar_type | string | Required within parent | Represents the calendar type configured for the fiscal year. Maximum length: 255 |
display_based_on | string | Required within parent | Represents whether the fiscal year label is based on the start month or end month of the fiscal period. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the fiscal year configuration. Format: int64 Maximum length: 255 |
interval_display_option | JSON | Required within parent | |
interval_display_option (anyOf 1) | string | Alternative | Represents the display format configured for fiscal periods. Maximum length: 255 |
interval_display_option (anyOf 2) | null | Alternative | Represents the display format configured for fiscal periods. Maximum length: 255 |
past_surplus_weeks | null | Required within parent | Represents the surplus week configurations from past fiscal years. |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | string | Alternative | Represents the start date of the custom fiscal year. Maximum length: 255 |
start_date (anyOf 2) | null | Alternative | Represents the start date of the custom fiscal year. Maximum length: 255 |
start_month | string | Required within parent | Represents the start month of the fiscal year. Maximum length: 255 |
structure | JSON | Required within parent | |
structure (anyOf 1) | string | Alternative | Represents the week distribution structure configured for the custom fiscal year. Maximum length: 255 |
structure (anyOf 2) | null | Alternative | Represents the week distribution structure configured for the custom fiscal year. Maximum length: 255 |
surplus_week | Model | Required within parent | Expand Get Fiscal Year Settings — response body — fiscal year surplus week |
Referenced models: Get Fiscal Year Settings — response body — fiscal year surplus week
Get Fiscal Year Settings — response body — fiscal year surplus week
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the surplus week configuration, including the quarter, period, and year in which the surplus week is placed. Additional keys: not allowed |
$ (anyOf 1).period | JSON | Required within parent | |
$ (anyOf 1).period (anyOf 1) | integer | Alternative | Represents the period within the quarter in which the surplus week falls. Format: int32 |
$ (anyOf 1).period (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).quarter | JSON | Required within parent | |
$ (anyOf 1).quarter (anyOf 1) | integer | Alternative | Represents the quarter in which the surplus week falls. Format: int32 |
$ (anyOf 1).quarter (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).year | JSON | Required within parent | |
$ (anyOf 1).year (anyOf 1) | integer | Alternative | Represents the year for which the surplus week is configured. Format: int32 |
$ (anyOf 1).year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2) | null | Alternative | Represents the surplus week configuration, including the quarter, period, and year in which the surplus week is placed. Additional keys: not allowed |
$ (anyOf 2).period | JSON | Required within parent | |
$ (anyOf 2).period (anyOf 1) | integer | Alternative | Represents the period within the quarter in which the surplus week falls. Format: int32 |
$ (anyOf 2).period (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).quarter | JSON | Required within parent | |
$ (anyOf 2).quarter (anyOf 1) | integer | Alternative | Represents the quarter in which the surplus week falls. Format: int32 |
$ (anyOf 2).quarter (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).year | JSON | Required within parent | |
$ (anyOf 2).year (anyOf 1) | integer | Alternative | Represents the year for which the surplus week is configured. Format: int32 |
$ (anyOf 2).year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getfiscalyear. Catalog operation: getFiscalYear. 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.