Use Case Library

Copy verified Kick CLI scripts for reporting, transaction review, data export, and integrations. Every command matches the current CLI surface.

How to Use This Library

Each use case includes:

• The complete script you can copy and run
• Read or write label so you know whether the workflow changes data
• How to customize it for your needs
• What it outputs so you know what to expect

All scripts assume you have installed and authenticated the CLI. Replace <workspace-id>, entity ids, ledger ids, and dates with your client context.

Set a token for scripts:

export KICK_PAT=kick_pat_...

---

Workflow Scripts by Use Case

Monthly Reporting

Transaction Management

Reconciliation and Cleanup

Data Analysis

Integration Scripts

Advanced Scripting

---

Quick Command Reference

List workspaces (read)

kick workspaces list

Set default workspace (write: stores local profile default)

kick workspaces use <workspace-id>

List entities in a workspace (read)

kick workspaces list --include-entities --output json

Find transactions in a date range (read)

kick --workspace <workspace-id> transactions find --since 2026-01-01 --until 2026-01-31 --limit 25

Export transactions as JSON (read)

kick --workspace <workspace-id> transactions find --since 2026-01-01 --until 2026-01-31 --fields id,date,amount,counterparty,category --output json

Profit and loss (read)

kick --workspace <workspace-id> reports profit-loss --entity 123 --ledger-id <ledger-uuid> --start-date 2026-01-01 --end-date 2026-01-31 --cycle month --output json

Balance sheet (read)

kick --workspace <workspace-id> reports balance-sheet --entity 123 --ledger-id <ledger-uuid> --start-date 2026-01-01 --end-date 2026-01-31 --output json

Trial balance (read)

kick --workspace <workspace-id> reports trial-balance --entity 123 --ledger-id <ledger-uuid> --start-date 2026-01-01 --end-date 2026-01-31 --output json

Resolve a ledger id for an entity (read)

kick --workspace <workspace-id> accounting ledgers get --entity-id 123 --output json

Inspect recent activity (read)

kick --workspace <workspace-id> activity list --resource-type transaction --limit 10 --output json

---

Have a workflow you'd like to automate? Share it with us and we'll add it to this library at [e-mail]