Get journal draft

Read one editable journal draft with its ordered lines.

Outcome

Read one editable journal draft with its ordered lines.

Before you start

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

Request

GET /api/journal-drafts/{draftId}

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
`draftId`	Required	Exact 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

Reads the selected Books journals result in the credential-scoped organization and applicable canonical workspace. Read one editable journal draft with its ordered lines.

Interpret the response

Read $.draft.id for the returned journal 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 editable journal draft with its ordered lines. 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.journals.drafts.get --data @payload.json --json
topolo actions plan app_topolo_books.journals.drafts.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.journals.drafts.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.journals.drafts.get",
    "input": {
      "draftId": "jd_52ec4f8955f3410e931b83667f29a3c0"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "draftId": "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:

{
  "draftId": "jd_52ec4f8955f3410e931b83667f29a3c0"
}

Captured response · HTTP 200

{
  "draft": {
    "id": "jd_52ec4f8955f3410e931b83667f29a3c0",
    "organization_id": "org_documentation-attachment_muvnpnbr2",
    "workspace_id": "ws_documentation-attachment_muvnpnbr2",
    "posted_on": null,
    "description": "",
    "reference": null,
    "auto_reverse_on": null,
    "override_soft_lock": 0,
    "created_by": "usr_test",
    "created_at": "2026-10-05T19:42:39.449Z",
    "updated_at": "2026-10-05T19:42:39.449Z",
    "notes": "Fixture evidence"
  },
  "lines": []
}

HTTP 200. Inspect the actual response fields and retained identifiers for the selected organization/workspace. Read one editable journal draft with its ordered lines. 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.

Successful response · HTTP 200

Input · payload.json:

{
  "draftId": "jd_ad62470177ad4161ba97a15e8e431989"
}

Captured response · HTTP 200

{
  "draft": {
    "id": "jd_ad62470177ad4161ba97a15e8e431989",
    "organization_id": "org_journal-draft_muvnpsmk5",
    "workspace_id": "ws_journal-draft_muvnpsmk5",
    "posted_on": null,
    "description": "Accrual",
    "reference": null,
    "auto_reverse_on": null,
    "override_soft_lock": 0,
    "created_by": "usr_drafts",
    "created_at": "2026-10-05T19:42:46.324Z",
    "updated_at": "2026-10-05T19:42:46.324Z",
    "notes": null
  },
  "lines": []
}

Refused response · journal_draft_not_found

Input · payload.json:

{
  "draftId": "jd_ad62470177ad4161ba97a15e8e431989"
}

Captured response · HTTP 404

{
  "error": "journal_draft_not_found",
  "message": "Journal draft jd_ad62470177ad4161ba97a15e8e431989 does not exist in this workspace"
}

HTTP 404. SDK error code journal_draft_not_found. Read journals.drafts.list/get in this workspace. A posted or discarded draft no longer exists; follow the retained posted journal id when available.

Verify the result

Inspect the actual response fields and retained identifiers for the selected organization/workspace. Read one editable journal draft with its ordered lines.
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.
journal_draft_not_found (HTTP 404): Read journals.drafts.list/get in this workspace. A posted or discarded draft no longer exists; follow the retained posted journal id when available.

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 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.

Get journal draft

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

Successful response · HTTP 200

Refused response · journal_draft_not_found

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence