Skip to content

feat(filtering): company/vendor/customer filters on related records #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Warkanlock merged 1 commit into from
Apr 22, 2026
+486 −69
Merged

feat(filtering): company/vendor/customer filters on related records #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 55 additions & 5 deletions src/dualentry_cli/commands/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ def _build_filter_params(
status: str | None = None,
start_date: str | None = None,
end_date: str | None = None,
**extra,
) -> dict:
"""Build filter query params, omitting None values."""
params: dict = {}
Expand All @@ -67,6 +68,7 @@ def _build_filter_params(
params["start_date"] = start_date
if end_date:
params["end_date"] = end_date
params.update({key: value for key, value in extra.items() if value is not None})
return params


Expand Down Expand Up @@ -123,11 +125,16 @@ def make_resource_app(
has_delete: bool = False,
has_number: bool = False,
has_post: bool = False,
filters: set[str] | None = None,
template: dict | None = None,
validate_fn: Callable[[Path], None] | None = None,
checks: list[Callable] | None = None,
online_checks: list[Callable] | None = None,
) -> typer.Typer:
"""Create a Typer app for a standard CRUD resource."""
import inspect

app = typer.Typer(help=f"Manage {name}", no_args_is_help=True, cls=HelpfulGroup)
enabled_filters = filters or set()

@app.command("list")
def list_cmd(
Expand All @@ -138,15 +145,39 @@ def list_cmd(
status: str | None = Status,
start_date: str | None = StartDate,
end_date: str | None = EndDate,
company: str | None = typer.Option(None, "--company", "-c", help="Filter by company ID"),
customer: str | None = typer.Option(None, "--customer", help="Filter by customer ID"),
vendor: str | None = typer.Option(None, "--vendor", help="Filter by vendor ID"),
output: str = Format,
):
from dualentry_cli.main import get_client

client = get_client()
_do_list(client, path, resource, limit, offset, all_pages, output, search=search, status=status, start_date=start_date, end_date=end_date)
_do_list(
client,
path,
resource,
limit,
offset,
all_pages,
output,
search=search,
status=status,
start_date=start_date,
end_date=end_date,
company_id=company if isinstance(company, str) else None,
customer_id=customer if isinstance(customer, str) else None,
vendor_id=vendor if isinstance(vendor, str) else None,
)

list_cmd.__doc__ = f"List {name}."

all_filters = {"company", "customer", "vendor"}
remove = all_filters - enabled_filters
if remove:
sig = inspect.signature(list_cmd)
list_cmd.__signature__ = sig.replace(parameters=[p for p in sig.parameters.values() if p.name not in remove])

if has_number:

@app.command("get")
Expand Down Expand Up @@ -263,15 +294,34 @@ def delete_cmd(

delete_cmd.__doc__ = f"Delete a {resource}."

if validate_fn is not None:
if checks:

@app.command("validate")
def validate_cmd(
file: Path = typer.Option(..., "--file", "-f", help="JSON file to validate"),
online: bool = typer.Option(False, "--online", help="Also run checks that require API access"),
):
validate_fn(file)
payload = _load_json_file(file)
errors: list[str] = []
client = None
if online:
from dualentry_cli.main import get_client

client = get_client()
all_checks = list(checks)
if online and online_checks:
all_checks.extend(online_checks)
for check in all_checks:
if errors:
break
errors.extend(check(payload, client=client))
if errors:
for err in errors:
typer.secho(f" \u2717 {err}", fg=typer.colors.RED, err=True)
raise typer.Exit(code=1)
typer.secho(" \u2713 Valid", fg=typer.colors.GREEN)

validate_cmd.__doc__ = f"Validate a {resource} payload (client-side)."
validate_cmd.__doc__ = f"Validate a {resource} payload."

if has_post:

Expand Down
105 changes: 60 additions & 45 deletions src/dualentry_cli/commands/ije_extras.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@

from __future__ import annotations

from pathlib import Path

import typer

from dualentry_cli.commands import _load_json_file
from decimal import Decimal, InvalidOperation

IJE_TEMPLATE = {
"date": "2026-01-01",
Expand Down Expand Up @@ -55,47 +51,66 @@
}


def validate_ije(file: Path) -> None:
from decimal import Decimal, InvalidOperation
# ── Checks ─────────────────────────────────────────────────────────
# Each check: (payload, client=None) -> list[str]
# Return error strings. Empty list = pass.

payload = _load_json_file(file)
errors: list[str] = []

def check_items_present(payload: dict, client=None) -> list[str]:
items = payload.get("items")
if not items or not isinstance(items, list):
errors.append("Payload must contain a non-empty 'items' array.")
else:
company_ids = set()
total_debits = Decimal(0)
total_credits = Decimal(0)

for i, item in enumerate(items):
cid = item.get("company_id")
if cid is not None:
company_ids.add(cid)

try:
debit = Decimal(str(item.get("debit", "0")))
credit = Decimal(str(item.get("credit", "0")))
except (InvalidOperation, TypeError):
errors.append(f"Item {i}: invalid debit/credit value.")
continue

total_debits += debit
total_credits += credit

if not errors:
if len(company_ids) < 2:
errors.append("Intercompany journal entries require lines across at least two distinct companies.")

total_debits = total_debits.quantize(Decimal("0.01"))
total_credits = total_credits.quantize(Decimal("0.01"))
if total_debits != total_credits:
errors.append(f"Total debits ({total_debits}) must equal total credits ({total_credits}).")

if errors:
for err in errors:
typer.secho(f" \u2717 {err}", fg=typer.colors.RED, err=True)
raise typer.Exit(code=1)

typer.secho(" \u2713 Valid", fg=typer.colors.GREEN)
return ["Payload must contain a non-empty 'items' array."]
return []


def check_amounts_valid(payload: dict, client=None) -> list[str]:
errors = []
for i, item in enumerate(payload.get("items", [])):
try:
Decimal(str(item.get("debit", "0")))
Decimal(str(item.get("credit", "0")))
except (InvalidOperation, TypeError):
errors.append(f"Item {i}: invalid debit/credit value.")
return errors


def check_debits_equal_credits(payload: dict, client=None) -> list[str]:
total_debits = Decimal(0)
total_credits = Decimal(0)
for item in payload.get("items", []):
total_debits += Decimal(str(item.get("debit", "0")))
total_credits += Decimal(str(item.get("credit", "0")))
total_debits = total_debits.quantize(Decimal("0.01"))
total_credits = total_credits.quantize(Decimal("0.01"))
if total_debits != total_credits:
return [f"Total debits ({total_debits}) must equal total credits ({total_credits})."]
return []


def check_multi_company(payload: dict, client=None) -> list[str]:
company_ids = {item.get("company_id") for item in payload.get("items", []) if item.get("company_id") is not None}
if len(company_ids) < 2:
return ["Intercompany journal entries require lines across at least two distinct companies."]
return []


def check_company_access(payload: dict, client=None) -> list[str]:
if client is None:
return []
company_ids = {item.get("company_id") for item in payload.get("items", []) if item.get("company_id") is not None}
if not company_ids:
return []
data = client.get("/companies/", params={"limit": 100})
accessible = {c["id"] for c in data.get("items", [])}
unknown = company_ids - accessible
if unknown:
return [f"Company IDs not accessible: {', '.join(str(c) for c in sorted(unknown))}"]
return []


# ── Offline checks run in order; later checks assume earlier ones passed.
IJE_OFFLINE_CHECKS = [check_items_present, check_amounts_valid, check_debits_equal_credits, check_multi_company]
IJE_ONLINE_CHECKS = [check_company_access]

IJE_CHECKS = IJE_OFFLINE_CHECKS
IJE_ONLINE_EXTRA_CHECKS = IJE_ONLINE_CHECKS
43 changes: 24 additions & 19 deletions src/dualentry_cli/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
from dualentry_cli.cli import HelpfulGroup
from dualentry_cli.commands import make_resource_app
from dualentry_cli.commands.accounts import app as accounts_app
from dualentry_cli.commands.ije_extras import IJE_TEMPLATE, validate_ije
from dualentry_cli.commands.ije_extras import IJE_CHECKS, IJE_ONLINE_EXTRA_CHECKS, IJE_TEMPLATE
from dualentry_cli.config import Config

app = typer.Typer(name="dualentry", help="DualEntry accounting CLI", no_args_is_help=True, cls=HelpfulGroup)
Expand All @@ -18,33 +18,36 @@
app.add_typer(config_app, name="config")

# Custom-formatted resources (use factory - output.py handles formatting via resource name)
app.add_typer(make_resource_app("invoices", "invoice", "invoices", has_number=True), name="invoices")
app.add_typer(make_resource_app("bills", "bill", "bills", has_number=True), name="bills")
app.add_typer(make_resource_app("invoices", "invoice", "invoices", has_number=True, filters={"customer", "company"}), name="invoices")
app.add_typer(make_resource_app("bills", "bill", "bills", has_number=True, filters={"vendor", "company"}), name="bills")
app.add_typer(accounts_app, name="accounts") # Accounts has custom filtering (no status/date filters)

# Money-in
app.add_typer(make_resource_app("sales orders", "sales-order", "sales-orders", has_number=True), name="sales-orders")
app.add_typer(make_resource_app("customer payments", "customer-payment", "customer-payments", has_number=True), name="customer-payments")
app.add_typer(make_resource_app("customer credits", "customer-credit", "customer-credits", has_number=True), name="customer-credits")
app.add_typer(make_resource_app("customer prepayments", "customer-prepayment", "customer-prepayments", has_number=True), name="customer-prepayments")
app.add_typer(make_resource_app("sales orders", "sales-order", "sales-orders", has_number=True, filters={"customer", "company"}), name="sales-orders")
app.add_typer(make_resource_app("customer payments", "customer-payment", "customer-payments", has_number=True, filters={"customer", "company"}), name="customer-payments")
app.add_typer(make_resource_app("customer credits", "customer-credit", "customer-credits", has_number=True, filters={"customer", "company"}), name="customer-credits")
app.add_typer(
make_resource_app("customer prepayment applications", "customer-prepayment-application", "customer-prepayment-applications", has_number=True),
make_resource_app("customer prepayments", "customer-prepayment", "customer-prepayments", has_number=True, filters={"customer", "company"}), name="customer-prepayments"
)
app.add_typer(
make_resource_app("customer prepayment applications", "customer-prepayment-application", "customer-prepayment-applications", has_number=True, filters={"customer", "company"}),
name="customer-prepayment-applications",
)
app.add_typer(make_resource_app("customer deposits", "customer-deposit", "customer-deposits", has_number=True), name="customer-deposits")
app.add_typer(make_resource_app("customer refunds", "customer-refund", "customer-refunds", has_number=True), name="customer-refunds")
app.add_typer(make_resource_app("cash sales", "cash-sale", "cash-sales", has_number=True), name="cash-sales")
app.add_typer(make_resource_app("customer deposits", "customer-deposit", "customer-deposits", has_number=True, filters={"customer", "company"}), name="customer-deposits")
app.add_typer(make_resource_app("customer refunds", "customer-refund", "customer-refunds", has_number=True, filters={"customer", "company"}), name="customer-refunds")
app.add_typer(make_resource_app("cash sales", "cash-sale", "cash-sales", has_number=True, filters={"customer", "company"}), name="cash-sales")

# Money-out
app.add_typer(make_resource_app("purchase orders", "purchase-order", "purchase-orders", has_number=True), name="purchase-orders")
app.add_typer(make_resource_app("vendor payments", "vendor-payment", "vendor-payments", has_number=True), name="vendor-payments")
app.add_typer(make_resource_app("vendor credits", "vendor-credit", "vendor-credits", has_number=True), name="vendor-credits")
app.add_typer(make_resource_app("vendor prepayments", "vendor-prepayment", "vendor-prepayments", has_number=True), name="vendor-prepayments")
app.add_typer(make_resource_app("purchase orders", "purchase-order", "purchase-orders", has_number=True, filters={"vendor", "company"}), name="purchase-orders")
app.add_typer(make_resource_app("vendor payments", "vendor-payment", "vendor-payments", has_number=True, filters={"vendor", "company"}), name="vendor-payments")
app.add_typer(make_resource_app("vendor credits", "vendor-credit", "vendor-credits", has_number=True, filters={"vendor", "company"}), name="vendor-credits")
app.add_typer(make_resource_app("vendor prepayments", "vendor-prepayment", "vendor-prepayments", has_number=True, filters={"vendor", "company"}), name="vendor-prepayments")
app.add_typer(
make_resource_app("vendor prepayment applications", "vendor-prepayment-application", "vendor-prepayment-applications", has_number=True), name="vendor-prepayment-applications"
make_resource_app("vendor prepayment applications", "vendor-prepayment-application", "vendor-prepayment-applications", has_number=True, filters={"vendor", "company"}),
name="vendor-prepayment-applications",
)
app.add_typer(make_resource_app("vendor refunds", "vendor-refund", "vendor-refunds", has_number=True), name="vendor-refunds")
app.add_typer(make_resource_app("direct expenses", "direct-expense", "direct-expenses", has_number=True), name="direct-expenses")
app.add_typer(make_resource_app("vendor refunds", "vendor-refund", "vendor-refunds", has_number=True, filters={"vendor", "company"}), name="vendor-refunds")
app.add_typer(make_resource_app("direct expenses", "direct-expense", "direct-expenses", has_number=True, filters={"vendor", "company"}), name="direct-expenses")

# Accounting
app.add_typer(make_resource_app("journal entries", "journal-entry", "journal-entries", has_number=True), name="journal-entries")
Expand Down Expand Up @@ -77,8 +80,10 @@
"intercompany-journal-entries",
has_number=True,
has_post=True,
filters={"company"},
template=IJE_TEMPLATE,
validate_fn=validate_ije,
checks=IJE_CHECKS,
online_checks=IJE_ONLINE_EXTRA_CHECKS,
),
name="intercompany-journal-entries",
)
Expand Down
Loading
Loading