Get recurring invoice

Read one recurring invoice schedule, its template id, cadence, end conditions, automation, run history and last failure.

Outcome

Read one recurring invoice schedule, its template id, cadence, end conditions, automation, run history and last failure.

Before you start

Verify the intended environment, authenticated identity and specifically approved organization context.
The published application permission is invoices: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.invoices.recurring.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.
scheduleId: Exact recurring schedule.id from the corresponding published recurring journal or invoice reads.

Request

GET /api/invoices/recurring/{scheduleId}

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
`scheduleId`	Required	Exact recurring schedule.id from the corresponding published recurring journal or invoice reads.	{"type":"string","minLength":1}

Inspect nested fields and the complete input schema.

Effects

Reads the selected Books invoices result in the credential-scoped organization and applicable canonical workspace. Read one recurring invoice schedule, its template id, cadence, end conditions, automation, run history and last failure.

Interpret the response

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

Inspect the actual response fields and retained identifiers for the selected organization/workspace. Read one recurring invoice schedule, its template id, cadence, end conditions, automation, run history and last failure. 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.invoices.recurring.get --data @payload.json --json
topolo actions plan app_topolo_books.invoices.recurring.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.invoices.recurring.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.invoices.recurring.get",
    "input": {
      "scheduleId": "rinv_51de49a227f14e97bfd8047e0052c834"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "scheduleId": "synthetic_books_unresolved"
}

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:

{
  "scheduleId": "rinv_51de49a227f14e97bfd8047e0052c834"
}

Captured response · HTTP 200

{
  "schedule": {
    "id": "rinv_51de49a227f14e97bfd8047e0052c834",
    "organization_id": "org_recurring-route_muvnpdnp14",
    "workspace_id": "ws_recurring-route_muvnpdnp14",
    "template_document_id": "doc_316ae70e593f41aca4dfa5d264b3bb37",
    "name": "Monthly retainer",
    "cadence": "monthly",
    "start_on": "2026-01-31",
    "end_on": null,
    "max_occurrences": 2,
    "due_days": 14,
    "next_run_on": "2026-01-31",
    "status": "active",
    "auto_approve": 1,
    "auto_send": 1,
    "auto_charge": 0,
    "pay_merchant_id": null,
    "pay_payment_method_id": null,
    "proration_notes": "First period is billed in full.",
    "last_run_on": null,
    "last_document_id": null,
    "run_count": 0,
    "attempts": 0,
    "last_error": null,
    "created_at": "2026-10-05T19:42:26.931Z",
    "updated_at": "2026-10-05T19:42:26.931Z"
  }
}

HTTP 200. Inspect the actual response fields and retained identifiers for the selected organization/workspace. Read one recurring invoice schedule, its template id, cadence, end conditions, automation, run history and last failure. 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.

Refused response · recurring_invoice_not_found

Input · payload.json:

{
  "scheduleId": "missing"
}

Captured response · HTTP 404

{
  "error": "recurring_invoice_not_found",
  "message": "Recurring invoice missing does not exist in this workspace"
}

HTTP 404. SDK error code recurring_invoice_not_found. Discover invoices.recurring.list in this workspace and retain schedule.id.

Verify the result

Inspect the actual response fields and retained identifiers for the selected organization/workspace. Read one recurring invoice schedule, its template id, cadence, end conditions, automation, run history and last failure.
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.
recurring_invoice_not_found (HTTP 404): Discover invoices.recurring.list in this workspace and retain schedule.id.

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.

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.

Get recurring invoice

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Run a reviewed request

Refused response · auth_error

Successful response · HTTP 200

Refused response · recurring_invoice_not_found

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence