Topolo Docs Topolo Platform
Open workspace

Books · Journals

28 declared Journals actions with worked requests and responses.

Journals execution

Read the exact action guide for prerequisites, identifier discovery, supported input, effects, captured successful and refused responses, verification and recovery. Synthetic fixture results do not authorize a live mutation or establish a provider outcome.

  • 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.
  • Post a journal: Post a balanced manual journal to the ledger. Optionally schedule its exact reversal for the first day of a later month with autoReverseOn. Refused with unbalanced_journal, period_locked, account_not_found or account_archived; an idempotencyKey replays the same event. Every line is signed base-currency minor units: positive debit, negative credit.
  • Import journals from CSV: Preview or post multiple journals from a line-oriented CSV with journal, date, description, account_code, debit and credit columns plus optional reference and memo. Amounts are major currency units. Lines sharing a journal key form one balanced posting; re-importing the same journal is idempotent.
  • List automatic reversals: List the workspace journal reversal schedules, optionally filtered to pending, completed or cancelled.
  • List recurring journals: List recurring journal schedules, optionally filtered by lifecycle status.
  • Create recurring journal: Create a balanced monthly, quarterly or yearly journal schedule. The hourly worker posts each occurrence exactly once and atomically advances the next date.
  • Get recurring journal: Read one recurring journal schedule and all of its template lines.
  • Update recurring journal: Change an active or paused schedule and replace its future template lines. Posted occurrences stay immutable.
  • Pause recurring journal: Pause an active schedule without changing its next run date.
  • Resume recurring journal: Resume a paused schedule so the hourly worker can post its next due occurrence.
  • Cancel recurring journal: Permanently cancel an active or paused schedule. Posted occurrences remain in the ledger.
  • Get journal: Read one journal event with every line, its account and its debit or credit, which is what reconciles against the ledger.
  • List journal attachments: List the private source documents attached to one posted journal.
  • Attach file to journal: Attach one private file up to 10 MB to a posted journal. HTML, SVG and script content are refused; an idempotency key safely replays an upload.
  • Download journal attachment: Download one private journal attachment as bytes with a forced-download response.
  • Delete journal attachment: Permanently delete one file and its journal attachment metadata. The immutable ledger event is unchanged.
  • Cancel automatic reversal: Cancel a pending automatic reversal while leaving its original journal posted and immutable.
  • Reverse a journal: Post the reversal of a journal: the same lines negated, dated as requested (default the original date). A journal can be reversed once; corrections are reversals, never edits.
  • List journal drafts: List mutable journal drafts in the workspace, most recently updated first. Drafts have not affected the ledger or reports.
  • Create journal draft: Save an incomplete or balanced journal, including an optional automatic reversal date, as an editable draft without posting it to the ledger.
  • Get journal draft: Read one editable journal draft with its ordered lines.
  • Update journal draft: Replace supplied fields, optional automatic reversal date or lines on an editable journal draft. Posted journals remain immutable.
  • Delete journal draft: Discard one unposted journal draft. No ledger event or balance is changed.
  • Post journal draft: Validate and post a complete balanced draft through the journal serializer, atomically schedule its optional automatic reversal, then remove the draft. A stable draft idempotency key prevents a retry creating a duplicate event.
  • List draft attachments: List the private source documents attached to one journal draft.
  • Attach file to journal draft: Attach one private file up to 10 MB to a journal draft. The file follows the draft when it is posted.
  • Download draft attachment: Download one private journal-draft attachment as bytes with a forced-download response.
  • Delete draft attachment: Permanently delete one file and its draft attachment metadata.

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.