Topolo Docs Topolo Platform
Open workspace

Get profit and loss

Profit and loss statement for a date range (default: the current financial year to today), with accrual or cash recognition. compare can add earlier periods or the account budget; a reporting dimension can filter the statement or split its columns by value. Read `columns` for the exact period, budget or dimension represented and `amountsMinor` for each figure in that order. `amountMinor` and `comparativeMinor` remain the first two figures for simpler callers. Amounts are natural-sign base-currency minor units.

Outcome

Profit and loss statement for a date range (default: the current financial year to today), with accrual or cash recognition. compare can add earlier periods or the account budget; a reporting dimension can filter the statement or split its columns by value. Read columns for the exact period, budget or dimension represented and amountsMinor for each figure in that order. amountMinor and comparativeMinor remain the first two figures for simpler callers. Amounts are natural-sign base-currency minor units.

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.profit_and_loss.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/profit-and-loss

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

Input fields

FieldRequiredMeaningSchema and constraints
fromOptionalfrom{"type":"string","pattern":"^\d{4}-\d{2}-\d{2}$"}
toOptionalto{"type":"string","pattern":"^\d{4}-\d{2}-\d{2}$"}
compareOptionalcompare{"type":"string","enum":["none","previous_period","previous_year","budget"]}
comparePeriodsOptionalcompare Periods{"anyOf":[{"type":"integer","minimum":1,"maximum":11},{"type":"string","pattern":"^(?:[1-9]|1[01])$"}]}
basisOptionalbasis{"type":"string","enum":["accrual","cash"]}
dimensionKeyOptionaldimension Key{"type":"string","minLength":1,"maxLength":40}
dimensionValueOptionaldimension Value{"type":"string","minLength":1,"maxLength":60}
dimensionColumnsOptionaldimension Columns{"type":"boolean"}

Inspect nested fields and the complete input schema.

Effects

  • Reads the profit and loss without changing anything. Accrual basis reads the ledger; cash basis recognizes paid document lines and direct cash journals. Budget and reporting-dimension columns remain separate from actuals.

Interpret the response

Read $.sections[].rows[].accountId for the returned ledger_account identifier. Empty collections and nullable fields do not discover a target.

No verification needed for a read. Net profit must equal the current-year earnings line of app_topolo_books.reports.balance_sheet.get at the same end date when the range starts at the financial year.

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.profit_and_loss.get --data @payload.json --json
topolo actions plan app_topolo_books.reports.profit_and_loss.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.reports.profit_and_loss.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.profit_and_loss.get",
    "input": {
      "from": "2026-01-01",
      "to": "2026-03-31",
      "compare": "previous_period"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "from": "2026-04-01",
  "to": "2026-06-30",
  "compare": "previous_year"
}

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-01-01",
  "to": "2026-03-31",
  "compare": "previous_period"
}

Captured response · HTTP 200

{
  "from": "2026-01-01",
  "to": "2026-03-31",
  "currency": "USD",
  "basis": "accrual",
  "compare": "previous_period",
  "comparePeriods": 1,
  "comparative": {
    "from": "2025-10-01",
    "to": "2025-12-31"
  },
  "dimension": null,
  "columns": [
    {
      "key": "period",
      "label": "2026-01-01 to 2026-03-31",
      "from": "2026-01-01",
      "to": "2026-03-31",
      "kind": "actual"
    },
    {
      "key": "previous_1",
      "label": "2025-10-01 to 2025-12-31",
      "from": "2025-10-01",
      "to": "2025-12-31",
      "kind": "comparison"
    }
  ],
  "sections": [
    {
      "key": "revenue",
      "rows": [
        {
          "accountId": "acc_bced67613b2b41729ac391e0090e979d",
          "computed": null,
          "code": "4000",
          "name": "Sales",
          "subtype": "revenue",
          "amountsMinor": [
            9000,
            0
          ],
          "amountMinor": 9000,
          "comparativeMinor": 0
        }
      ],
      "totalsMinor": [
        9000,
        0
      ],
      "totalMinor": 9000,
      "comparativeTotalMinor": 0
    },
    {
      "key": "cost_of_sales",
      "rows": [],
      "totalsMinor": [
        0,
        0
      ],
      "totalMinor": 0,
      "comparativeTotalMinor": 0
    },
    {
      "key": "operating_expenses",
      "rows": [],
      "totalsMinor": [
        0,
        0
      ],
      "totalMinor": 0,
      "comparativeTotalMinor": 0
    },
    {
      "key": "other_income",
      "rows": [],
      "totalsMinor": [
        0,
        0
      ],
      "totalMinor": 0,
      "comparativeTotalMinor": 0
    },
    {
      "key": "other_expenses",
      "rows": [],
      "totalsMinor": [
        0,
        0
      ],
      "totalMinor": 0,
      "comparativeTotalMinor": 0
    },
    {
      "key": "tax",
      "rows": [],
      "totalsMinor": [
        0,
        0
      ],
      "totalMinor": 0,
      "comparativeTotalMinor": 0
    }
  ],
  "summary": {
    "revenue": {
      "amountsMinor": [
        9000,
        0
      ],
      "amountMinor": 9000,
      "comparativeMinor": 0
    },
    "costOfSales": {
      "amountsMinor": [
        0,
        0
      ],
      "amountMinor": 0,
      "comparativeMinor": 0
    },
    "grossProfit": {
      "amountsMinor": [
        9000,
        0
      ],
      "amountMinor": 9000,
      "comparativeMinor": 0
    },
    "operatingExpenses": {
      "amountsMinor": [
        0,
        0
      ],
      "amountMinor": 0,
      "comparativeMinor": 0
    },
    "operatingProfit": {
      "amountsMinor": [
        9000,
        0
      ],
      "amountMinor": 9000,
      "comparativeMinor": 0
    },
    "otherIncome": {
      "amountsMinor": [
        0,
        0
      ],
      "amountMinor": 0,
      "comparativeMinor": 0
    },
    "otherExpenses": {
      "amountsMinor": [
        0,
        0
      ],
      "amountMinor": 0,
      "comparativeMinor": 0
    },
    "profitBeforeTax": {
      "amountsMinor": [
        9000,
        0
      ],
      "amountMinor": 9000,
      "comparativeMinor": 0
    },
    "tax": {
      "amountsMinor": [
        0,
        0
      ],
      "amountMinor": 0,
      "comparativeMinor": 0
    },
    "netProfit": {
      "amountsMinor": [
        9000,
        0
      ],
      "amountMinor": 9000,
      "comparativeMinor": 0
    }
  }
}

HTTP 200. No verification needed for a read. Net profit must equal the current-year earnings line of app_topolo_books.reports.balance_sheet.get at the same end date when the range starts at the financial year.

Refused response · forbidden

Input · payload.json:

{}

Captured response · HTTP 403

{
  "error": "forbidden"
}

HTTP 403. SDK error code forbidden. The credential lacks permission or the resource is outside its scope. Compare the published action permission and discovered workspace binding; obtain the appropriate authorization before another call.

Verify the result

  • No verification needed for a read. Net profit must equal the current-year earnings line of app_topolo_books.reports.balance_sheet.get at the same end date when the range starts at the financial year.

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.
  • forbidden (HTTP 403): The credential lacks permission or the resource is outside its scope. Compare the published action permission and discovered workspace binding; obtain the appropriate authorization before another call.

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 account ledger lines: General ledger detail for one account: lines in posting order, paged with limit and offset. openingBalanceMinor is the balance immediately before the returned page, including both activity before the requested range and earlier lines in that range.
  • Get balance sheet: Balance sheet at a date (default today): current and non-current assets and liabilities, equity with current-year and prior-years earnings computed from the ledger, and a balanced flag. compare adds the previous month or the previous year beside every figure. Amounts are natural-sign base-currency minor units. compare adds earlier columns, each stepping back again: previous_month by a month, previous_year by twelve. comparePeriods says how many, 1 to 11, and needs compare set. Read columns for the date each column is drawn at and amountsMinor for the figures in that order
  • 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.

Evidence

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.