Topolo Docs Topolo Platform
Open workspace

Get the current UK VAT position

Read the current VAT reporting period, the amount estimated in box 5 so far, whether it is payable, reclaimable or nil, and the statutory filing and payment deadline. The reporting cadence is anchored to the active effective-dated VAT scheme.

Outcome

Read the current VAT reporting period, the amount estimated in box 5 so far, whether it is payable, reclaimable or nil, and the statutory filing and payment deadline. The reporting cadence is anchored to the active effective-dated VAT scheme.

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.vat_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/vat-summary

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

Input fields

FieldRequiredMeaningSchema and constraints
asOfOptionalas Of{"type":"string","pattern":"^\d{4}-\d{2}-\d{2}$"}

Inspect nested fields and the complete input schema.

Effects

  • Reads the active VAT scheme and current box 5 estimate without changing schemes, documents, payments or ledger entries.

Interpret the response

Read $.period.from for the returned vat_return_period identifier. Empty collections and nullable fields do not discover a target.

Call app_topolo_books.reports.vat_return.get with the returned period.from and period.calculatedTo and compare box 5 with amountMinor.

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.vat_summary.get --data @payload.json --json
topolo actions plan app_topolo_books.reports.vat_summary.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.reports.vat_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.vat_summary.get",
    "input": {
      "asOf": "2026-09-08"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "asOf": "2026-09-08"
}

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:

{
  "asOf": "2026-09-08"
}

Captured response · HTTP 200

{
  "configured": true,
  "asOf": "2026-09-08",
  "currency": "GBP",
  "period": {
    "from": "2026-01-01",
    "to": "2026-12-31",
    "calculatedTo": "2026-09-08",
    "dueDate": "2027-02-28",
    "scheme": "annual"
  },
  "amountMinor": 0,
  "direction": "nil",
  "warnings": []
}

HTTP 200. Call app_topolo_books.reports.vat_return.get with the returned period.from and period.calculatedTo and compare box 5 with amountMinor.

Refused response · forbidden

Input · payload.json:

{
  "asOf": "2026-09-08"
}

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

  • Call app_topolo_books.reports.vat_return.get with the returned period.from and period.calculatedTo and compare box 5 with amountMinor.

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

This action is read-only.

  • Get UK VAT return preview: Compute the nine UK VAT return boxes from posted invoices and bills for a date range, applying effective-dated standard, cash accounting, flat-rate or annual-accounting schemes and returning source-line drill-down.
  • List UK VAT schemes: List effective-dated UK VAT scheme history, optionally including archived records.
  • 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.