List fiscal years

List every fiscal year the books touch with its dates, how many periods it holds and are locked, whether it has been closed, and the close journal with the profit it moved to retained earnings.

Outcome

List every fiscal year the books touch with its dates, how many periods it holds and are locked, whether it has been closed, and the close journal with the profit it moved to retained earnings.

Before you start

Verify the intended environment, authenticated identity and specifically approved organization context.
The published application permission is periods:read. Discover the exact granted canonical Books workspace and bind it separately from action input.

Discover the target

topolo whoami --json
topolo actions get app_topolo_books.periods.year_ends.list --detail --json
topolo resources topolo-books --json
topolo workspaces list topolo-books --json

Set BOOKS_WORKSPACE_ID to the exact granted workspace returned by discovery.

Request

GET /api/periods/year-ends

Inspect and test this action. Save the reviewed input as payload.json; supply credential/resource context separately.

Input fields

Use an empty input object. Credential and resource context are separate.

Inspect nested fields and the complete input schema.

Effects

Reads the selected Books periods result in the credential-scoped organization and applicable canonical workspace. List every fiscal year the books touch with its dates, how many periods it holds and are locked, whether it has been closed, and the close journal with the profit it moved to retained earnings.

Interpret the response

This result returns a collection, report or verification summary without a stable resource identifier. Retain identifiers already resolved through published discovery; do not treat dates, counts or status flags as new ids.

Inspect the actual response fields and retained identifiers for the selected organization/workspace. List every fiscal year the books touch with its dates, how many periods it holds and are locked, whether it has been closed, and the close journal with the profit it moved to retained earnings. Use the related published read actions when a returned record or ledger outcome needs further inspection; an HTTP 200 does not establish provider delivery or financial agreement.

Inspect the success schema. CLI/MCP add their own transport envelope; CLI --detail requests the full result.

Worked examples

Actual Books route handlers and the exported Worker were exercised against five local SQLite D1 concern databases with all committed migrations, the real posting Durable Object and local R2. Route captures use synthetic verified Auth; Worker captures use synthetic Auth transports. Nexus, Brand, Notify, Pay, Mercury and Xero responses are explicitly simulated at the provider transport boundary. Captures prove local request/response behavior and canonical SDK projection, not live bank access, payment movement, email delivery, provider eligibility, tax compliance, encrypted custody, scheduled execution, deployment or production completion. Fixture identities, credentials, addresses and records authorize no live operation.

Run a reviewed request

Save the input from the selected worked example as payload.json. Validate and inspect the plan before calling the action; refused examples demonstrate errors and are not instructions to execute.

CLI:

topolo actions validate app_topolo_books.periods.year_ends.list --data @payload.json --json
topolo actions plan app_topolo_books.periods.year_ends.list --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.periods.year_ends.list --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --detail --json

MCP tool and arguments for the first successful example:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_books.periods.year_ends.list",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

Successful response · HTTP 200

Input · payload.json:

{}

Captured response · HTTP 200

{
  "fiscalYears": [
    {
      "fiscalYear": 2024,
      "startDate": "2024-01-01",
      "endDate": "2024-12-31",
      "status": "open",
      "closable": true,
      "periods": 1,
      "lockedPeriods": 0,
      "close": null
    },
    {
      "fiscalYear": 2025,
      "startDate": "2025-01-01",
      "endDate": "2025-12-31",
      "status": "open",
      "closable": true,
      "periods": 1,
      "lockedPeriods": 0,
      "close": null
    }
  ]
}

HTTP 200. Inspect the actual response fields and retained identifiers for the selected organization/workspace. List every fiscal year the books touch with its dates, how many periods it holds and are locked, whether it has been closed, and the close journal with the profit it moved to retained earnings. Use the related published read actions when a returned record or ledger outcome needs further inspection; an HTTP 200 does not establish provider delivery or financial agreement.

Refused response · auth_error

Input · payload.json:

{}

Captured response · HTTP 401

{
  "error": "API key validation failed"
}

HTTP 401. SDK error code auth_error. Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

Verify the result

Inspect the actual response fields and retained identifiers for the selected organization/workspace. List every fiscal year the books touch with its dates, how many periods it holds and are locked, whether it has been closed, and the close journal with the profit it moved to retained earnings.
Use the related published read actions when a returned record or ledger outcome needs further inspection; an HTTP 200 does not establish provider delivery or financial agreement.

Errors and recovery

auth_error (HTTP 401): Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

These are observed local refusals. Shared authentication, schema validation and resource authorization can also refuse before the route. Preserve the actual error, details and request id.

Recovery boundary

Repeat a read in the same authorized context; no state is changed.

List accounting periods: List the monthly accounting periods and their lock status, optionally for one fiscal year.