Create recurring invoice

Outcome

Schedule a complete draft invoice template weekly, monthly, quarterly or annually, with optional end date or occurrence limit, automatic approval and sent-state recording.

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.recurring.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.
• templateDocumentId: Exact source invoice document id used by the recurring schedule; inspect its status and lines first.
• payMerchantId: Resolve this exact identifier through the related published reads for the same organization and workspace; never infer it from a name.
• payPaymentMethodId: Resolve this exact identifier through the related published reads for the same organization and workspace; never infer it from a name.

Request

POST /api/invoices/recurring

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

Input fields

Inspect nested fields and the complete input schema.

Effects

• Creates an active schedule against one complete draft invoice template. The worker creates source-idempotent occurrences and can approve, post, record them as sent and charge a selected Pay-owned saved method.

Interpret the response

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

Call app_topolo_books.invoices.recurring.get and confirm the template, next_run_on, end conditions and automation flags.

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.create --data @payload.json --json
topolo actions plan app_topolo_books.invoices.recurring.create --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.invoices.recurring.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.recurring.create",
    "input": {
      "templateDocumentId": "doc_316ae70e593f41aca4dfa5d264b3bb37",
      "name": "Monthly retainer",
      "cadence": "monthly",
      "startOn": "2026-01-31",
      "endOn": null,
      "maxOccurrences": 2,
      "dueDays": 14,
      "autoApprove": true,
      "autoSend": true,
      "autoCharge": false,
      "payMerchantId": null,
      "payPaymentMethodId": null,
      "prorationNotes": "First period is billed in full."
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "templateDocumentId": "doc_template",
  "name": "Monthly support",
  "cadence": "monthly",
  "startOn": "2026-10-01",
  "endOn": null,
  "maxOccurrences": 12,
  "dueDays": 14,
  "autoApprove": true,
  "autoSend": true,
  "autoCharge": true,
  "payMerchantId": "mrc_books",
  "payPaymentMethodId": "pm_customer_card",
  "prorationNotes": null
}

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:

{
  "templateDocumentId": "doc_316ae70e593f41aca4dfa5d264b3bb37",
  "name": "Monthly retainer",
  "cadence": "monthly",
  "startOn": "2026-01-31",
  "endOn": null,
  "maxOccurrences": 2,
  "dueDays": 14,
  "autoApprove": true,
  "autoSend": true,
  "autoCharge": false,
  "payMerchantId": null,
  "payPaymentMethodId": null,
  "prorationNotes": "First period is billed in full."
}

Captured response · HTTP 201

{
  "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 201. Call app_topolo_books.invoices.recurring.get and confirm the template, next_run_on, end conditions and automation flags.

Verify the result

• Call app_topolo_books.invoices.recurring.get and confirm the template, next_run_on, end conditions and automation flags.

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

Cancel the schedule. Its template and any generated invoices remain.

Related actions

• Get recurring invoice: Read one recurring invoice schedule, its template id, cadence, end conditions, automation, run history and last failure.
• Pause recurring invoice: Pause an active recurring invoice schedule without moving its next invoice date.
• 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.
• Cancel recurring invoice: Permanently cancel an active or paused recurring invoice schedule. Its template and generated invoices remain readable.

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.