List accounting periods

GET/v1/accounting-periods

Coming June to July 2027

This endpoint ships in June to July 2027. The shape shown here can still change before release.

Returns a business's accounting periods and whether each is open or locked.

Periods of one business never overlap. A locked period accepts no postings, automatic or manual. Results use cursor pagination.

Permission: ledger.view
Type: Read-only. Changes nothing.
Auth: API key, MCP token or signed-in session
Capability: list_accounting_periods
CLI: freeinvoiceautomation ledger periods
Available: From June to July 2027

list_accounting_periods

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/accounting-periods \
  --header 'Authorization: Bearer <api-key>'

{
  "data": [
    {
      "id": "0193f6c2-3d4e-7f50-8a61-7c8d9e0f1a21",
      "business_id": "0193f29e-11aa-7c3b-8d2e-5a6b7c8d9e0f",
      "period_start": "2027-05-01",
      "period_end": "2027-05-31",
      "status": "open",
      "locked_by": null,
      "locked_at": null,
      "created_at": "2027-06-07T09:00:00Z",
      "updated_at": "2027-06-07T09:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Authorizations

Authorizationstringrequired

Bearer <api-key>. An API key from Settings > API keys, or an MCP token. See Authentication.

Query Parameters

business_idstring<uuid>

Only periods of this business.

statusenum<string>

Only open or only locked periods.

Available options: open, locked

limitintegerdefault:50

Page size, 1 to 200.

cursorstring

Cursor from the previous page's next_cursor.

Response

200 - application/json

dataobject[]

The periods on this page.

next_cursorstring | null

Cursor for the next page, or null on the last page.

has_moreboolean

Whether another page exists.

Errors

business_out_of_scope

Plus the common errors every call can return. See Errors.

Suggest edits Raise issue

Reverse a journal entryPrevious Lock a periodNext

list_accounting_periods

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/accounting-periods \
  --header 'Authorization: Bearer <api-key>'

{
  "data": [
    {
      "id": "0193f6c2-3d4e-7f50-8a61-7c8d9e0f1a21",
      "business_id": "0193f29e-11aa-7c3b-8d2e-5a6b7c8d9e0f",
      "period_start": "2027-05-01",
      "period_end": "2027-05-31",
      "status": "open",
      "locked_by": null,
      "locked_at": null,
      "created_at": "2027-06-07T09:00:00Z",
      "updated_at": "2027-06-07T09:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}