Zoho: Fiscal year schemas

← Fiscal year operations · All 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]+)?$

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 — 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

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request payload to switch the organization from a standard fiscal year to a custom fiscal year. When `start_month` is provided alongside `start_date`, its value must match the month component of `start_date`. Additional keys: not allowed
calendar_type	string	Required within parent	Specify the calendar type used to switch to a custom fiscal year. Possible values: `custom`. One of: custom Maximum length: 10
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	Required within parent	Specify the display format for the custom fiscal year intervals. Possible values: `year`, `quarter`. One of: year, quarter Maximum length: 7
start_date	string	Required within parent	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	Required within parent	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.

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 / calendar_type: gregorian, display based on: start month, end month

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request payload to switch the organization from a custom fiscal year to a standard fiscal year. Additional keys: not allowed
calendar_type	string	Required within parent	Specify the calendar type used to switch to a standard fiscal year. Possible values: `gregorian`. One of: gregorian Maximum length: 10
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	Optional	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 — 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

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, 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

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the surplus week configuration to apply for a custom fiscal year. Send `null` to clear the configured surplus week, or send a complete object with the quarter, period, and year to set a new surplus week.
$ (anyOf 1)	null	Alternative	Clears any existing surplus week configuration for the custom fiscal year.
$ (anyOf 2)	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 surplus week period, quarter, year

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 period, quarter, year

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

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

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 — 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 — 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