summaryrefslogtreecommitdiffstats
path: root/firefly_cli/commands/account.py
blob: 0e86b2bf88b6dbc33188869d44127fabdbb5d9da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Copyright (C) 2026 Danilo M. <danix@danix.xyz>  GPL-2.0-only
from firefly_cli import registry, output
from firefly_cli.errors import FireflyError

# v1 scope: the everyday types. Liabilities need extra required fields
# (liability_type/direction/amount); add when needed.
_CREATE_TYPES = ("asset", "expense", "revenue")

def _list_args(p):
    p.add_argument("--type", help="filter: asset, expense, revenue, liability, ...")

@registry.command("account list", help="list accounts", args=_list_args)
def cmd_list(args, ctx):
    params = {"type": args.type} if getattr(args, "type", None) else None
    resp = ctx.client.request("GET", "/api/v1/accounts", params=params)
    output.emit(output.unwrap(resp), human=ctx.human)
    return 0

def _create_args(p):
    p.add_argument("name", help="account name (must be unique)")
    p.add_argument("--type", required=True,
                   help="asset, expense, or revenue")
    p.add_argument("--opening-balance", dest="opening_balance", default=None,
                   help="initial balance (asset accounts); dated today")
    p.add_argument("--currency", default=None, help="currency code, e.g. EUR")

@registry.command("account create", help="create an account", args=_create_args)
def cmd_create(args, ctx):
    if args.type not in _CREATE_TYPES:
        raise FireflyError(
            f'Unsupported account type "{args.type}". '
            f'Use one of: {", ".join(_CREATE_TYPES)}.')
    body = {"name": args.name, "type": args.type}
    if args.type == "asset":
        body["account_role"] = "defaultAsset"
    if args.opening_balance is not None:
        from datetime import date as _date
        body["opening_balance"] = str(args.opening_balance)
        body["opening_balance_date"] = _date.today().isoformat()
    if args.currency:
        body["currency_code"] = args.currency
    resp = ctx.client.request("POST", "/api/v1/accounts", body=body)
    output.emit(output.unwrap(resp), human=ctx.human)
    return 0

def _name_arg(p):
    p.add_argument("account", help="account name or id")

@registry.command("account get", help="show one account", args=_name_arg)
def cmd_get(args, ctx):
    acc = ctx.resolver.account(args.account)
    output.emit(acc, human=ctx.human)
    return 0

@registry.command("account balance", help="show account balance", args=_name_arg)
def cmd_balance(args, ctx):
    acc = ctx.resolver.account(args.account)
    output.emit({"id": acc["id"], "name": acc.get("name"),
                 "current_balance": acc.get("current_balance")}, human=ctx.human)
    return 0