Fiscal Calendars

GET /accounting/fiscal-calendars

Group: Accounting › Fiscal Calendars · Operation ID: fiscalCalendars

Returns a list of fiscal calendars. To read one with its fiscal years and assigned entities, use GET accounting/fiscal-calendars/:id.

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
periodFormat — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
fiscalYearsCount — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
anchorDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, calendarName, periodFormat, status, fiscalYearsCount, anchorDate, lastModifiedDate
Selectable: id, calendarName, description, periodFormat, status, fiscalYearsCount, anchorDate, lastModifiedDate

200 Success

Under data, an array of fiscalCalendarsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the fiscal calendar.
`calendarName`	string	no	The name of the fiscal calendar, unique within the tenant.
`description`	string or null	no	A description of the fiscal calendar. Absent when none has been set.
`periodFormat`	string	no	How the fiscal calendar divides a fiscal year into periods. Possible values: 'calendarMonths' (twelve monthly periods), '4-4-5', '4-5-4', '5-4-4' (retail quarters of thirteen weeks, split into periods of that many weeks).
`status`	string or null	no	The lifecycle status of the fiscal calendar. Possible values: 'new', 'active', 'deactivated'. Absent when none has been set.
`fiscalYearsCount`	number or null	no	The number of distinct fiscal years on this calendar. Absent until the first fiscal year exists.
`anchorDate`	string (date) or null	no	The anchor reference date, set only for retail calendars (a '4-4-5', '4-5-4' or '5-4-4' periodFormat). It is the last day of the month before the first period starts. Format YYYY-MM-DD. Absent on a calendarMonths calendar.
`lastModifiedDate`	string (date-time)	no	The date and time the fiscal calendar last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.