Accounting Period Statuses

GET /accounting/period-status

Group: Accounting › Accounting Period Status · Operation ID: accountingPeriodStatuses

Returns a list of accounting period statuses, one per (entity, book, period). To read one with its close checklist, use GET accounting/period-status/:id.

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`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
accountingPeriodId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
bookId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
periodName — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
fiscalYear — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
fiscalQuarter — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
startDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
endDate — 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
reopenedByCascade — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
postable — 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, periodName, fiscalYear, fiscalQuarter, startDate, endDate, status, postable, lastModifiedDate
Selectable: id, accountingPeriodId, entityId, entityName, bookId, bookName, periodName, fiscalYear, fiscalQuarter, startDate, endDate, status, reopeningReason, reopenedByCascade, postable, postableReason, lastModifiedDate

Response

200 Success

Under data, an array of accountingPeriodStatusesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for this entity-book period status row. This identifies the (entity, book, period) combination, not the shared accounting period.
`accountingPeriodId`	string or null	no	The identifier of the underlying accounting period, shared by every entity that uses this fiscal calendar. See id on GET accounting/accounting-periods/:id.
`entityId`	string or null	no	The identifier of the legal entity this status belongs to. See id on GET base/entities. Absent only when the entity-book link is broken.
`entityName`	string or null	no	The name of the legal entity this status belongs to.
`bookId`	string or null	no	The identifier of the accounting book this status belongs to. A period is opened and closed per book. See id on GET accounting/books/:id.
`bookName`	string or null	no	The name of the accounting book this status belongs to.
`periodName`	string or null	no	The display name of the period as its fiscal calendar defines it, for example 'Jan 2026'. The format varies by calendar, so do not parse it. Match on dates instead.
`fiscalYear`	string or null	no	The fiscal year label this period belongs to, for example 'FY2024'. Set by the calendar, so it need not match the calendar year of startDate.
`fiscalQuarter`	string or null	no	The fiscal quarter label this period belongs to, for example 'Q1 2026'.
`startDate`	string (date) or null	no	The first day of the period, inclusive. Format YYYY-MM-DD. Absent only when the underlying period was deleted.
`endDate`	string (date) or null	no	The last day of the period, inclusive. Format YYYY-MM-DD.
`status`	string	no	The status this entity and book have put the period in. Possible values: 'created' (generated, not yet opened), 'open', 'closed', 'reopened'. Only 'open' and 'reopened' accept postings.
`reopeningReason`	string or null	no	The free-text reason recorded when the period was reopened. Set only when status is 'reopened'.
`reopenedByCascade`	boolean or null	no	Whether this period was reopened as a side effect of reopening a later one, rather than directly.
`postable`	boolean or null	no	Whether the period currently accepts postings for this entity and book, true when its status is 'open' or 'reopened'. This does not account for journal-type-specific locks.
`postableReason`	string or null	no	Why the period does not accept postings, for example 'status is closed'. Empty when it is postable.
`lastModifiedDate`	string (date-time)	no	The date and time this status row last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. It changes when the period is opened, closed or reopened for this entity and book.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error