akt-cli 0.4.0__tar.gz → 0.5.0__tar.gz

{akt_cli-0.4.0 → akt_cli-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: akt-cli
-Version: 0.4.0
+Version: 0.5.0
 Summary: akt — a CLI toolbox to fully drive an Akaunting accounting instance
 Keywords: akaunting,accounting,cli,invoices,bills,api
 Author: AsyncAlchemist
@@ -171,6 +171,15 @@ akt tax create --name "Sales Tax" --rate 8.25
 akt bank create --name "Business Checking" --number 1001 --currency-code USD
 akt bank list
 
+# Open a book with a prior-period opening balance. The Double-Entry module
+# auto-posts an opening-balance journal entry dated to the account's creation
+# date; --opening-balance-date re-dates it to the period boundary so it lands in
+# the right financial year. Needs a positive --opening-balance.
+akt bank create --name "Business Checking" --number 1001 --currency-code USD \
+    --opening-balance 5000 --opening-balance-date 2024-12-31
+# Re-date the opening entry of an existing account:
+akt bank update 3 --opening-balance-date 2024-12-31
+
 # Invoice with line items (totals computed server-side; number auto-generated)
 akt invoice create --contact 12 \
     --item 'name=Consulting,price=150,quantity=10,item_id=2' \

{akt_cli-0.4.0 → akt_cli-0.5.0}/README.md

@@ -150,6 +150,15 @@ akt tax create --name "Sales Tax" --rate 8.25
 akt bank create --name "Business Checking" --number 1001 --currency-code USD
 akt bank list
 
+# Open a book with a prior-period opening balance. The Double-Entry module
+# auto-posts an opening-balance journal entry dated to the account's creation
+# date; --opening-balance-date re-dates it to the period boundary so it lands in
+# the right financial year. Needs a positive --opening-balance.
+akt bank create --name "Business Checking" --number 1001 --currency-code USD \
+    --opening-balance 5000 --opening-balance-date 2024-12-31
+# Re-date the opening entry of an existing account:
+akt bank update 3 --opening-balance-date 2024-12-31
+
 # Invoice with line items (totals computed server-side; number auto-generated)
 akt invoice create --contact 12 \
     --item 'name=Consulting,price=150,quantity=10,item_id=2' \

{akt_cli-0.4.0 → akt_cli-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "akt-cli"
-version = "0.4.0"
+version = "0.5.0"
 description = "akt — a CLI toolbox to fully drive an Akaunting accounting instance"
 readme = "README.md"
 license = "MIT"

{akt_cli-0.4.0 → akt_cli-0.5.0}/src/akt/coa.py

@@ -74,7 +74,11 @@ def parse_coa(text: str) -> CoaConfig:
         code = int(row["code"])
         name = str(row["name"])
         type_id = int(row["type_id"])
-        mirror = bool(row.get("mirror", True))
+        mirror = row.get("mirror", True)
+        if not isinstance(mirror, bool):
+            raise ValueError(
+                f"account '{name}': 'mirror' must be a boolean (true/false), "
+                f"got {mirror!r} — did you quote it?")
         category = str(row.get("category", name))
         if code in seen_codes:
             raise ValueError(f"duplicate code {code}")

{akt_cli-0.4.0 → akt_cli-0.5.0}/src/akt/commands.py

@@ -56,6 +56,8 @@ def cmd_create(res: Resource, client: Client, ns: Any) -> int:
     else:
         payload = client.post(endpoint, body, type_scope=type_scope)
     data = payload.get("data", payload) if isinstance(payload, dict) else payload
+    if res.post_write:
+        res.post_write(res, client, data, ns)
     emit(data, as_json=True)
     return 0
 
@@ -104,6 +106,8 @@ def cmd_update(res: Resource, client: Client, ns: Any) -> int:
             body["remove_attachment"] = 1
         payload = client.put(path, body, type_scope=type_scope)
     data = payload.get("data", payload) if isinstance(payload, dict) else payload
+    if res.post_write:
+        res.post_write(res, client, data, ns)
     emit(data, as_json=True)
     return 0
 

{akt_cli-0.4.0 → akt_cli-0.5.0}/src/akt/registry.py

@@ -13,6 +13,7 @@ from .resources import (
     build_journal_update,
     build_payment_create,
     build_transfer_create,
+    redate_opening_balance,
     resolve_payment_delete,
     resolve_payment_update,
 )
@@ -101,6 +102,10 @@ BANK = Resource(
         f("type", "Account type", default="bank"),
         f("currency-code", "Currency code", default="USD"),
         f("opening-balance", "Opening balance", default=0),
+        f("opening-balance-date",
+          "Date for the opening-balance journal entry (YYYY-MM-DD). Re-dates the "
+          "entry the Double-Entry module auto-posts; needs a positive opening balance.",
+          dest="opening_balance_date", local=True),
         f("bank-name", "Bank name"),
         f("bank-phone", "Bank phone"),
         f("bank-address", "Bank address"),
@@ -112,6 +117,7 @@ BANK = Resource(
         ("Enabled", "enabled"),
     ],
     help="Bank / cash accounts",
+    post_write=redate_opening_balance,
 )
 
 CATEGORY = Resource(

{akt_cli-0.4.0 → akt_cli-0.5.0}/src/akt/resources.py

@@ -12,6 +12,7 @@ import datetime as _dt
 import json
 import mimetypes
 import os
+import sys
 from dataclasses import dataclass, field
 from typing import Any, Callable
 
@@ -32,6 +33,7 @@ class Field:
     default: Any = None             # default applied on create when omitted
     is_flag: bool = False           # store_true boolean flag
     choices: list[str] | None = None
+    local: bool = False             # CLI flag only; never sent in the request body
 
 
 def f(name: str, help: str = "", **kw) -> Field:
@@ -69,6 +71,10 @@ class Resource:
     # returns (path, type_scope) for update; lets document-linked payments use
     # the nested route (the flat /transactions route 400s on any document_id)
     update_resolver: Callable[["Resource", Client, str, dict], "tuple[str, str | None]"] | None = None
+    # runs after a successful create/update on the /api path, with the returned
+    # record + the argparse namespace; used by bank to re-date the auto-posted
+    # opening-balance journal entry.
+    post_write: Callable[["Resource", Client, dict, Any], None] | None = None
 
     def contact_scope(self) -> str:
         """ACL scope of the contact tied to a document resource."""
@@ -205,6 +211,8 @@ def body_from_fields(res: Resource, ns: Any, *, for_update: bool,
     """
     body: dict[str, Any] = {}
     for fld in res.fields:
+        if fld.local:
+            continue
         val = getattr(ns, fld.dest, None)
         if fld.is_flag:
             # tri-state: only include if explicitly toggled
@@ -733,6 +741,76 @@ def build_journal_update(res: Resource, client: Client, ns: Any, current: dict)
     return body
 
 
+# --------------------------------------------------------------------------
+# opening-balance journal entry re-dating (bank post_write hook)
+# --------------------------------------------------------------------------
+
+def _journal_reput_body(current: dict, *, paid_at: str, journal_number: str) -> dict:
+    """Full journal-entry PUT body that re-dates an existing entry, preserving
+    its ledgers (by id) and amounts. ``journal_number`` is supplied by the caller
+    (the server-created opening-balance entry carries none, but the API requires
+    one)."""
+    body: dict[str, Any] = {
+        "paid_at": paid_at,
+        "journal_number": journal_number,
+        "description": current.get("description"),
+        "basis": current.get("basis") or "accrual",
+        "currency_code": current.get("currency_code") or "USD",
+        "currency_rate": current.get("currency_rate", 1) or 1,
+        "amount": 0,
+        "items": _journal_items_from_current(current),
+    }
+    if current.get("reference"):
+        body["reference"] = current["reference"]
+    return body
+
+
+def _find_opening_balance_je(client: Client, record: dict) -> dict | None:
+    """Locate the opening-balance journal entry the Double-Entry module auto-posts
+    for a bank/cash account. It carries ``reference = "opening-balance:<coa_id>"``
+    and ``description`` ending ``";<account name>"``. The chart-of-accounts API
+    doesn't expose the bank<->coa link, so match on those two fields and, if an
+    account name is duplicated, take the newest by ``created_at``."""
+    name = str(record.get("name") or "")
+    suffix = ";" + name
+    matches = [
+        e for e in client.list("journal-entry", all_pages=True)
+        if str(e.get("reference") or "").startswith("opening-balance:")
+        and str(e.get("description") or "").endswith(suffix)
+    ]
+    if not matches:
+        return None
+    matches.sort(key=lambda e: str(e.get("created_at") or ""), reverse=True)
+    return matches[0]
+
+
+def redate_opening_balance(res: "Resource", client: Client, record: dict, ns: Any) -> None:
+    """post_write hook for bank create/update: re-date the auto-posted
+    opening-balance journal entry to ``--opening-balance-date``.
+
+    The Double-Entry module stamps that entry with the account's created_at and
+    exposes no date field, so we set the balance normally (keeping the Banking
+    register correct) and rewrite the entry's date here. Re-dating via the
+    journal-entry route also rewrites each ledger's issued_at (what reports
+    filter on), and the module's account-update path only touches ledger
+    amounts, so the date sticks across later edits."""
+    date = getattr(ns, "opening_balance_date", None)
+    if not date:
+        return
+    je = _find_opening_balance_je(client, record)
+    if je is None:
+        print(f"note: no opening-balance journal entry found for {res.noun} "
+              f"{record.get('id')}; --opening-balance-date had no effect "
+              f"(opening balance is 0, or the Double-Entry module / owners-"
+              f"contribution account is not configured)", file=sys.stderr)
+        return
+    number = je.get("journal_number") or _next_journal_number(client)
+    body = _journal_reput_body(je, paid_at=_normalize_date(date), journal_number=number)
+    client.put(f"journal-entry/{je['id']}", body)
+    print(f"note: re-dated opening-balance journal entry {je['id']} to {date}",
+          file=sys.stderr)
+
+
 # --------------------------------------------------------------------------
 # chart-of-accounts (double-entry) — web-surface CRUD body builder
 # --------------------------------------------------------------------------