Get Fiscal Calendar

GET /accounting/fiscal-calendars/{id}

Group: Accounting › Fiscal Calendars · Operation ID: getFiscalCalendar

Returns the fiscal calendar with the given identifier, including the fiscal years it spans and the legal entities it is assigned to.

Open in the interactive reference

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 path string yes The unique identifier for the fiscal calendar to return.

Response

200 Success

Under data (getFiscalCalendarOutput):

Field Type Required Description
id string yes The unique identifier for the fiscal calendar.
calendarName string yes The name of the fiscal calendar, unique within the tenant.
description string no A description of the fiscal calendar. Absent when none has been set.
periodFormat string yes 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 no The lifecycle status of the fiscal calendar. Possible values: 'new', 'active', 'deactivated'. Absent when none has been set.
fiscalYearsCount number no The number of distinct fiscal years on this calendar. Absent until the first fiscal year exists.
fiscalYears array of string no The distinct fiscal years this calendar spans, taken from its accounting periods, in no guaranteed order. Each is a free-text label such as 'FY2024'. An empty array when the calendar has no fiscal years yet.
assignedEntities array of string no The names, not the identifiers, of the legal entities this calendar is assigned to, in no guaranteed order. An empty array when it is assigned to none.
anchorDate string (date) 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) yes The date and time the fiscal calendar last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses