Get the month-by-month shape of the year

Every month in the range (default the financial year to today) with profit-and-loss income and expenses, actual money posted into and out of bank and cash accounts, the profit that leaves, and the cash and bank position at month end carried from before the range. Money in and out are cash movements, so owner funding and other balance-sheet transfers remain visible without being misreported as revenue. Year-end close postings are left out.

Outcome

Before you start

Verify the intended environment, authenticated identity and specifically approved organization context.
The published application permission is ledger: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.reports.monthly_summary.get --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/reports/monthly-summary

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

Input fields

Field	Required	Meaning	Schema and constraints
`from`	Optional	from	{"type":"string","pattern":"^\d{4}-\d{2}-\d{2}$"}
`to`	Optional	to	{"type":"string","pattern":"^\d{4}-\d{2}-\d{2}$"}

Inspect nested fields and the complete input schema.

Effects

Reads the selected Books reports result in the credential-scoped organization and applicable canonical workspace. Every month in the range (default the financial year to today) with profit-and-loss income and expenses, actual money posted into and out of bank and cash accounts, the profit that leaves, and the cash and bank position at month end carried from before the range. Money in and out are cash movements, so owner funding and other balance-sheet transfers remain visible without being misreported as revenue. Year-end close postings are left out.

Interpret the response

Read $.months[].periodKey for the returned report identifier. Empty collections and nullable fields do not discover a target.

Inspect the actual response fields and retained identifiers for the selected organization/workspace. Every month in the range (default the financial year to today) with profit-and-loss income and expenses, actual money posted into and out of bank and cash accounts, the profit that leaves, and the cash and bank position at month end carried from before the range. Money in and out are cash movements, so owner funding and other balance-sheet transfers remain visible without being misreported as revenue. Year-end close postings are left out. 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.reports.monthly_summary.get --data @payload.json --json
topolo actions plan app_topolo_books.reports.monthly_summary.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.reports.monthly_summary.get --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.reports.monthly_summary.get",
    "input": {
      "from": "2026-09-01",
      "to": "2026-09-30"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

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.

Successful response · HTTP 200

Input · payload.json:

{
  "from": "2026-09-01",
  "to": "2026-09-30"
}

Captured response · HTTP 200

{
  "from": "2026-09-01",
  "to": "2026-09-30",
  "currency": "GBP",
  "months": [
    {
      "periodKey": "2026-09",
      "incomeMinor": 0,
      "expensesMinor": 2500,
      "netProfitMinor": -2500,
      "moneyInMinor": 0,
      "moneyOutMinor": 2500,
      "cashMinor": -2500
    }
  ]
}

HTTP 200. Inspect the actual response fields and retained identifiers for the selected organization/workspace. Every month in the range (default the financial year to today) with profit-and-loss income and expenses, actual money posted into and out of bank and cash accounts, the profit that leaves, and the cash and bank position at month end carried from before the range. Money in and out are cash movements, so owner funding and other balance-sheet transfers remain visible without being misreported as revenue. Year-end close postings are left out. 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.

Verify the result

Inspect the actual response fields and retained identifiers for the selected organization/workspace. Every month in the range (default the financial year to today) with profit-and-loss income and expenses, actual money posted into and out of bank and cash accounts, the profit that leaves, and the cash and bank position at month end carried from before the range. Money in and out are cash movements, so owner funding and other balance-sheet transfers remain visible without being misreported as revenue. Year-end close postings are left out.
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.

Get trial balance: Every account holding a balance at the date, each on one side only: debitMinor carries a debit balance, creditMinor a credit balance, and the other is zero. Accounts that net to nothing are left out. totalDebitMinor and totalCreditMinor are the sums of those balances and must agree, which is what balanced reports. These are balances, not turnover: they do not add up everything ever posted to an account, which would count both sides of every entry and count an expense again when a year-end close reverses it.