Topolo Docs Topolo Platform
Open workspace

Delete journal draft

Discard one unposted journal draft. No ledger event or balance is changed.

Outcome

Discard one unposted journal draft. No ledger event or balance is changed.

Before you start

  • Verify the intended environment, authenticated identity and specifically approved organization context.
  • The published application permission is journals: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.journals.drafts.delete --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.
  • draftId: Exact draft.id from journals.drafts.list/get. Posting or discarding removes the mutable draft.

Request

DELETE /api/journal-drafts/{draftId}

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

Input fields

FieldRequiredMeaningSchema and constraints
draftIdRequiredExact draft.id from journals.drafts.list/get. Posting or discarding removes the mutable draft.{"type":"string","minLength":1}

Inspect nested fields and the complete input schema.

Effects

  • Permanently removes an unposted draft and its draft lines. Posted ledger data is unchanged.

Interpret the response

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

Call app_topolo_books.journals.drafts.get and confirm journal_draft_not_found.

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.journals.drafts.delete --data @payload.json --json
topolo actions plan app_topolo_books.journals.drafts.delete --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.journals.drafts.delete --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.journals.drafts.delete",
    "input": {
      "draftId": "jd_9a337c24f65c4d7ea15e66e30ce5ee52"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "draftId": "jd_7f3c1b"
}

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:

{
  "draftId": "jd_9a337c24f65c4d7ea15e66e30ce5ee52"
}

Captured response · HTTP 200

{
  "deleted": true,
  "draftId": "jd_9a337c24f65c4d7ea15e66e30ce5ee52"
}

HTTP 200. Call app_topolo_books.journals.drafts.get and confirm journal_draft_not_found.

Successful response · HTTP 200

Input · payload.json:

{
  "draftId": "jd_07c8138638154c9bb12e56184a8235a4"
}

Captured response · HTTP 200

{
  "deleted": true,
  "draftId": "jd_07c8138638154c9bb12e56184a8235a4"
}

HTTP 200. Call app_topolo_books.journals.drafts.get and confirm journal_draft_not_found.

Verify the result

  • Call app_topolo_books.journals.drafts.get and confirm journal_draft_not_found.

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

The draft must be recreated. Export or read it before deletion if its contents are needed.

  • Get journal draft: Read one editable journal draft with its ordered lines.
  • List journals: List posted journal events, filtered by date range or period, searched across description, reference and journal type, and sorted by sequence, posted date, description or amount. Newest first unless you say otherwise.

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.