Create public invoice page

Create an opaque, revocable customer-facing page for an approved invoice using the published Brand kit bound to its Books workspace. Repeating the action returns the same active page.

Outcome

Create an opaque, revocable customer-facing page for an approved invoice using the published Brand kit bound to its Books workspace. Repeating the action returns the same active page.

Before you start

Verify the intended environment, authenticated identity and specifically approved organization context.
The published application permission is invoices: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.invoices.public_share.create --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.
documentId: Exact document.id from invoices.list/get or bills.list/get, as appropriate to this action; the displayed invoice number is distinct.

Request

POST /api/invoices/{documentId}/public-share

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
`documentId`	Required	Exact document.id from invoices.list/get or bills.list/get, as appropriate to this action; the displayed invoice number is distinct.	{"type":"string","minLength":1}

Inspect nested fields and the complete input schema.

Effects

Requires the organization-owned published Brand kit bound to the exact Books workspace, then creates one opaque active public-page id for an approved invoice. Repeating the action returns the existing active page and never duplicates it.

Interpret the response

Read $.share.id for the returned invoice_public_share identifier. Empty collections and nullable fields do not discover a target.

Call app_topolo_books.invoices.public_share.get and confirm the returned id and URL match, then open the page and confirm its logo and palette match the returned Brand version.

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.invoices.public_share.create --data @payload.json --json
topolo actions plan app_topolo_books.invoices.public_share.create --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.invoices.public_share.create --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.invoices.public_share.create",
    "input": {
      "documentId": "doc_ad33845b02a34033809b89e71d3c1489"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "documentId": "doc_9f2a"
}

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 201

Input · payload.json:

{
  "documentId": "doc_ad33845b02a34033809b89e71d3c1489"
}

Captured response · HTTP 201

{
  "share": {
    "id": "ish_d2c7e556cf9e4568ac38a232411f0cae",
    "url": "https://books.test/invoice/ish_d2c7e556cf9e4568ac38a232411f0cae",
    "status": "active",
    "viewCount": 0,
    "lastViewedAt": null,
    "createdAt": "2026-10-05T19:42:22.314Z",
    "revokedAt": null,
    "views": []
  },
  "reused": false
}

HTTP 201. Call app_topolo_books.invoices.public_share.get and confirm the returned id and URL match, then open the page and confirm its logo and palette match the returned Brand version.

Verify the result

Call app_topolo_books.invoices.public_share.get and confirm the returned id and URL match, then open the page and confirm its logo and palette match the returned Brand version.

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

Revoke the public page for the same invoice.

List invoices: List invoices newest first. Filter by status, contact or issue date, search the number, reference and notes, and sort by issue date, due date, number, total or status. The response carries the outstanding total for the filtered set.
Revoke public invoice page: Immediately disable the invoice public page and its PDF endpoint without changing the accounting record.