List accounting period statuses

Operation ID: accountingPeriodStatuses

Group: Accounting › Accounting Period Status

Open in the interactive reference

GET /accounting/period-status

Read-only: Reads and returns; changes nothing.

Lists accounting period statuses. Each item is one period for one legal entity and one accounting book.

To read an item with its period-close checklist, use GET accounting/period-status/:id.

Parameters

Name In Type Required Description
Api-Version header string · 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

Response

200 Success

Under data, an array of accountingPeriodStatusesRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for this entity-book period status row. This identifies the (entity, book, period) combination, not the shared accounting period.
accountingPeriodId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) 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 | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) 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 | null no no no The name of the legal entity this status belongs to.
bookId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) 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 | null no no no The name of the accounting book this status belongs to.
periodName string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes 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 | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes 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 | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The fiscal quarter label this period belongs to, for example 'Q1 2026'.
startDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The first day of the period, inclusive. Format YYYY-MM-DD. Absent only when the underlying period was deleted.
endDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The last day of the period, inclusive. Format YYYY-MM-DD.
status string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes 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 | null no no no The free-text reason recorded when the period was reopened. Set only when status is 'reopened'.
reopenedByCascade boolean | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) no Whether this period was reopened as a side effect of reopening a later one, rather than directly.
postable boolean | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes 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 | null no no no Why the period does not accept postings, for example 'status is closed'. Empty when it is postable.
lastModifiedDate date-time no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes 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. 
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "accountingPeriodId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "entityName": "<entityName>",
      "bookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bookName": "<bookName>",
      "periodName": "<periodName>",
      "fiscalYear": "<fiscalYear>",
      "fiscalQuarter": "<fiscalQuarter>",
      "startDate": "2026-01-15",
      "endDate": "2026-01-15",
      "status": "<status>",
      "reopeningReason": "<reopeningReason>",
      "reopenedByCascade": true,
      "postable": true,
      "postableReason": "<postableReason>",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses