Connect Xero

Start the Xero OAuth connect: returns the Xero authorise URL to open. Tokens are stored in Nexus when Xero redirects back; Books never sees a password.

Outcome

Start the Xero OAuth connect: returns the Xero authorise URL to open. Tokens are stored in Nexus when Xero redirects back; Books never sees a password.

Before you start

Verify the intended environment, authenticated identity and specifically approved organization context.
The published application permission is migrations:write. Discover the exact granted canonical Books workspace and bind it separately from action input.
Approve the actual mutation, accounting inputs and any provider/recipient effects before CLI --confirm or MCP confirm:true. Fixture identifiers and simulated provider responses authorize no live operation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_books.migrations.xero.connect --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

POST /api/migrations/xero/oauth/start

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
`redirectPath`	Optional	redirect Path	{"type":"string","maxLength":200}

Inspect nested fields and the complete input schema.

Effects

Returns a Xero authorise URL for a person to open in a browser. No data moves until they approve and Xero redirects back; the tokens are then stored in Nexus.

Interpret the response

Read $.state for the returned xero_connection identifier. Empty collections and nullable fields do not discover a target.

Call app_topolo_books.migrations.xero.get and confirm connected is true.

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.migrations.xero.connect --data @payload.json --json
topolo actions plan app_topolo_books.migrations.xero.connect --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.migrations.xero.connect --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments for the first successful example:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_books.migrations.xero.connect",
    "input": {
      "redirectPath": "/settings/migration"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "redirectPath": "/settings/migration"
}

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:

{
  "redirectPath": "/settings/migration"
}

Captured response · HTTP 200

{
  "authorizeUrl": "https://login.xero.com/identity/connect/authorize?response_type=code&client_id=xero-client&redirect_uri=https%3A%2F%2Fbooks.test%2Fapi%2Fintegrations%2Fxero%2Foauth%2Fcallback&scope=openid+profile+email+offline_access+accounting.settings.read+accounting.contacts.read+accounting.invoices.read+accounting.banktransactions.read+accounting.payments.read+accounting.manualjournals.read+accounting.reports.trialbalance.read+accounting.reports.balancesheet.read+accounting.attachments.read&state=zfOFUqfz8IAviY_5aGraS9isgFUn_Gt4VlwbP6EKBHA&code_challenge=RDozaqsdqWUAx_IWhhVlgrgcPNK3o7RrGsGciJLBAC8&code_challenge_method=S256",
  "state": "zfOFUqfz8IAviY_5aGraS9isgFUn_Gt4VlwbP6EKBHA"
}

HTTP 200. Call app_topolo_books.migrations.xero.get and confirm connected is true.

Verify the result

Call app_topolo_books.migrations.xero.get and confirm connected is true.

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

Disconnect to revoke the stored Xero tokens.

Xero migration status: Whether Xero is connected to this workspace, which organisation is selected, the organisations granted, and the last import.
Choose the Xero organisation: When the Xero login granted more than one organisation, pick the one to import from.
Import from Xero: Pull the chart of accounts, tax rates, contacts, sales invoices, supplier bills, payments, bank history, manual journals and attachments from the connected Xero organisation. Books posts imported documents before rebuilding ledger history from each bank transaction account, retaining coding already delivered by a live feed. Transactions before the conversion date remain represented by the opening position. Manual journals preserve adjustments such as accruals, depreciation and reclassifications without requesting Xero Advanced general-ledger data. Attachments stay linked to the journal they support and are keyed by their Xero attachment id. The default dryRun preview reports counts without writing; dryRun false imports. Re-running skips or refreshes records by source identity instead of duplicating them.
Disconnect Xero: Revoke the stored Xero tokens in Nexus. Imported records stay.