> For the complete documentation index, see [llms.txt](https://docs.kick.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kick.co/ai/cli/cli-use-case-library.md).

# Use Case Library

#### 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](/ai/developer-tools/cli/install-the-kick-cli.md) the CLI. Replace `<workspace-id>`, entity ids, ledger ids, and dates with your client context.

Set a token for scripts:

```bash
export KICK_PAT=kick_pat_...
```

***

### Workflow Scripts by Use Case

<table data-view="cards"><thead><tr><th data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="/pages/Bt0dZtinhGbcuj9m33oh">/pages/Bt0dZtinhGbcuj9m33oh</a></td></tr><tr><td><a href="/pages/6QXixcv8B6TR5NFMZsNc">/pages/6QXixcv8B6TR5NFMZsNc</a></td></tr><tr><td><a href="/pages/lrI0QxMMLj6Y5qEw2upP">/pages/lrI0QxMMLj6Y5qEw2upP</a></td></tr><tr><td><a href="/pages/1v3vNAhzZBjreZGCBTo7">/pages/1v3vNAhzZBjreZGCBTo7</a></td></tr><tr><td><a href="/pages/j9GuZiYISQY5b9Mt1HzH">/pages/j9GuZiYISQY5b9Mt1HzH</a></td></tr><tr><td><a href="/pages/XrPZ05MQMQsGnKwcclwt">/pages/XrPZ05MQMQsGnKwcclwt</a></td></tr></tbody></table>

***

#### Quick Command Reference

<details>

<summary><strong>List workspaces</strong> (read)</summary>

```bash
kick workspaces list
```

</details>

<details>

<summary><strong>Set default workspace</strong> (write: stores local profile default)</summary>

```bash
kick workspaces use <workspace-id>
```

</details>

<details>

<summary><strong>List entities in a workspace</strong> (read)</summary>

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

</details>

<details>

<summary><strong>Find transactions in a date range</strong> (read)</summary>

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

</details>

<details>

<summary><strong>Export transactions as JSON</strong> (read)</summary>

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

</details>

<details>

<summary><strong>Profit and loss</strong> (read)</summary>

```bash
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
```

</details>

<details>

<summary><strong>Balance sheet</strong> (read)</summary>

```bash
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
```

</details>

<details>

<summary><strong>Trial balance</strong> (read)</summary>

```bash
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
```

</details>

<details>

<summary><strong>Resolve a ledger id for an entity</strong> (read)</summary>

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

</details>

<details>

<summary><strong>Inspect recent activity</strong> (read)</summary>

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

</details>

***

**Have a workflow you'd like to automate?** Share it with us and we'll add it to this library at <support@kick.co>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kick.co/ai/cli/cli-use-case-library.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
