> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dualentry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DualEntry CLI Reference

> Every DualEntry CLI command by task: what each command does, arguments, flags, and copyable examples, from install and login to bank matching and webhooks.

This reference documents every command and flag in the DualEntry CLI (`dualentry`), grouped by what you're trying to do. Each entry shows the command, what it does, its arguments and flags, and copyable examples. Every command exits with code `0` on success, `1` when it runs but fails (for example, an API error or a missing login), and `2` when the command line itself is wrong. To install the CLI and run a first command step by step, see the [CLI quickstart](https://docs.dualentry.com/developers/guides/cli/quickstart.md).

The entries below are current as of dualentry-cli v0.1.21. Run `dualentry <command> --help` to check the version you have installed.

## Set up the CLI

These commands install, upgrade, and remove the CLI, connect it to your DualEntry organization, and check its configuration and connection. This section also covers the global flags every command accepts.

### Install the CLI

Install the CLI on macOS or Linux with Homebrew, `uv`, or an install script. The `uv` method requires Python 3.11 or later. The install script downloads a standalone `dualentry` binary into `/usr/local/bin` (set `INSTALL_DIR` to choose another directory), so it doesn't need Python; it supports macOS and Linux on x86-64, and macOS on Apple silicon.

```bash Install with Homebrew theme={null}
brew install dualentry/tap/dualentry
```

```bash Install with uv theme={null}
uv tool install git+https://github.com/dualentry/dualentry-cli.git
```

```bash Install with the install script theme={null}
curl -fsSL https://raw.githubusercontent.com/dualentry/dualentry-cli/main/install.sh | sh
```

Once the CLI is installed, [log in](#log-in) to connect it to your DualEntry organization.

### Upgrade the CLI

Upgrade the CLI with the same method you installed it with. The CLI checks for a newer release once a day and, while one is available, prints a notice with the upgrade command each time it runs.

```bash Upgrade with Homebrew theme={null}
brew upgrade dualentry
```

```bash Upgrade with uv theme={null}
uv tool upgrade dualentry-cli
```

```bash Upgrade with the install script theme={null}
curl -fsSL https://raw.githubusercontent.com/dualentry/dualentry-cli/main/install.sh | sh
```

### Uninstall the CLI

Uninstall the CLI with the same method you installed it with. Before uninstalling, run `dualentry auth logout` to remove your stored credentials. To remove the CLI's configuration as well, delete the `~/.dualentry` directory.

```bash Uninstall with Homebrew theme={null}
brew uninstall dualentry
```

```bash Uninstall with uv theme={null}
uv tool uninstall dualentry-cli
```

```bash Uninstall an install-script copy theme={null}
sudo rm /usr/local/bin/dualentry
```

### Log in

dualentry auth login

&#x20;

[\[--api-url \<api-url>\]](#cli-auth-login-api-url)

Opens your browser to sign in to DualEntry, then stores the resulting API key in your operating system's keychain under the service name `dualentry-cli` and prints the signed-in email and organization ID. On a machine with no usable keychain, the key is stored in `~/.dualentry/tokens.json` instead, so treat that file as a credential on shared hosts.

For CI/CD and other headless environments, skip `auth login` and set the `X_API_KEY` environment variable to an API key. When it's set, it takes precedence over a stored login.

Flags:

* `--api-url` (string, optional): API base URL to use instead of the default.

```bash Log in through your browser theme={null}
dualentry auth login
```

```bash Authenticate with an API key instead, for CI/CD theme={null}
export X_API_KEY="YOUR_API_KEY"
```

### Check your sign-in status

dualentry auth status

Prints the API URL, your email, and your organization ID, or says that you're authenticated through `X_API_KEY`. Exits with code `1` and prints `Not logged in. Run: dualentry auth login` when there's no credential.

```bash Check which organization you're signed in to theme={null}
dualentry auth status
```

### Log out

dualentry auth logout

Removes the stored API key from your keychain.

```bash Log out theme={null}
dualentry auth logout
```

### View your configuration

dualentry config show

Prints the API URL, the output format setting, and the signed-in user and organization. The CLI keeps these settings in `~/.dualentry/config.toml`.

```bash Show the current configuration theme={null}
dualentry config show
```

### Use a different API host

dualentry config set-url

&#x20;

[\<url>](#cli-config-set-url-url)

Saves a custom API base URL to your config file. Every organization, sandbox or production, uses `https://api.dualentry.com`, and the API key you sign in with decides which one you work against. Change the URL only to point the CLI at a different host entirely. The `DUALENTRY_API_URL` environment variable, when set, overrides the saved URL.

Arguments:

* `URL` (string, required): Custom API base URL.

```bash Save a custom API host theme={null}
dualentry config set-url https://your-custom-host.example.com
```

```bash Override the host for one session theme={null}
export DUALENTRY_API_URL=https://your-custom-host.example.com
```

### Check that the API is reachable

dualentry health

Prints the API URL, the API's status, and its server time. Exits with code `1` if the API can't be reached.

```bash Check API connectivity theme={null}
dualentry health
```

### Use global flags

dualentry

&#x20;

[\[flags\]](#cli-global-flags)

&#x20;

\<command>

Global flags go before the command name and apply to the whole invocation.

With `--retry`, the CLI retries a request that fails with status `429`, `502`, `503`, or `504`, a `409` that carries a `Retry-After` header, or a network error or timeout. It waits one, two, and then four seconds between attempts, or the number of seconds in the response's `Retry-After` header, capped at 60. Every request that creates or changes data carries an `Idempotency-Key` header, so a retried write isn't applied twice. File uploads are the exception: they go out without the header, so the CLI retries an upload only after a `429`, which means the files weren't stored.

Flags:

* `--version`, `-v` (boolean, optional): Print the CLI version and exit.
* `--retry` (boolean, optional): Retry failed requests with exponential backoff, as described above.
* `--install-completion` (boolean, optional): Install tab completion for your current shell.
* `--show-completion` (boolean, optional): Print the completion script for your current shell, to copy it or customize the installation.
* `--help` (boolean, optional): Show help for the CLI, or for any command or subcommand when placed after it.

```bash Retry rate-limited requests during a large export theme={null}
dualentry --retry invoices list --all --format json
```

```bash Install tab completion for your shell theme={null}
dualentry --install-completion
```

```bash Print the installed version theme={null}
dualentry --version
```

## Work with records

Most commands are resource commands: one per record type, such as `invoices`, `bills`, or `customers`. Every resource command has the same subcommands, so the entries below cover all of them, with `<resource>` standing in for the command name. The [table at the end of this section](#commands-for-each-record-type) shows which subcommands and `list` filters each resource supports.

Most transaction records, such as invoices, bills, and journal entries, have a record number, shown in the `#` column of `list` output, and an internal ID, shown in the `ID` column with a type prefix such as `IN-12`. Master data, such as customers and vendors, has only an ID.

### List records

dualentry \<resource> list

&#x20;

[\[flags\]](#cli-resource-list-flags)

Returns one page of records as a table, or every page with `--all`. The filters each resource accepts vary; passing one it doesn't support is a usage error that names the ones it does. `--status` takes `draft`, `posted`, or `archived` on transaction records.

`--all` fetches pages of 100 records until it reaches the end, ignoring `--limit` but starting from `--offset`. It stops after 1,000 pages (100,000 records) and prints a command that resumes where it stopped. With `--format json`, the output is an object of the form `{"items": [...], "count": N}`, where `count` is the total number of matching records, not the number returned.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--search`, `-s` (string, optional): Text to search for.
* `--status` (string, optional): Return only records with this status: `draft`, `posted`, or `archived`.
* `--start-date` (string, optional): Start of the date range to return, in `YYYY-MM-DD` format.
* `--end-date` (string, optional): End of the date range to return, in `YYYY-MM-DD` format.
* `--company`, `-c` (string, optional): Return only records for this company ID.
* `--customer` (string, optional): Return only records for this customer ID.
* `--vendor` (string, optional): Return only records for this vendor ID.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List posted invoices for September theme={null}
dualentry invoices list --status posted --start-date 2026-09-01 --end-date 2026-09-30
```

```bash List one vendor's bills theme={null}
dualentry bills list --vendor 318
```

```bash Search customers by name theme={null}
dualentry customers list --search acme
```

```bash Export every journal entry as JSON theme={null}
dualentry journal-entries list --all --format json > journal-entries.json
```

### Retrieve a record

dualentry \<resource> get

&#x20;

[\<number-or-id>](#cli-resource-get-value)

&#x20;

[\[-o, --format \<format>\]](#cli-resource-get-format)

Prints one record as a detail view, or as JSON with `--format json`. On resources with record numbers, `get` looks the value up as a record number first and, if no record has that number, as an internal ID. `get-number` and `get-id` look it up only one way, which is safer in scripts. These subcommands accept a display prefix, so `IN-5821` and `5821` work the same. The prefix is dropped before the lookup, so `JE-0042` means record number or ID 42, not the [record code](https://docs.dualentry.com/accountants/platform-configuration/organization-settings/record-numbering-reference.md) `JE-0042` shown in the **Record code** column. The CLI does not look records up by record code. To resolve a code such as `JE-0042`, use [Accounting Intelligence](https://docs.dualentry.com/accountants/ai-automation/accounting-intelligence/record-identifiers.md) or the DualEntry MCP server. On resources without record numbers, `get` takes the ID.

Arguments:

* `VALUE` (string, required): Record number (the `#` column) or ID, for example `IN-5821`.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry \<resource> get-number

&#x20;

[\<number>](#cli-resource-get-number-number)

&#x20;

[\[-o, --format \<format>\]](#cli-resource-get-number-format)

Arguments:

* `NUMBER` (string, required): Record number, shown in the `#` column.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry \<resource> get-id

&#x20;

[\<record-id>](#cli-resource-get-id-record-id)

&#x20;

[\[-o, --format \<format>\]](#cli-resource-get-id-format)

Arguments:

* `RECORD_ID` (string, required): Record ID (for example `IN-5821` or `5821`).

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Retrieve an invoice by record number theme={null}
dualentry invoices get 1043
```

```bash Retrieve a journal entry by its ID theme={null}
dualentry journal-entries get-id JE-1619031
```

```bash Retrieve a customer as JSON theme={null}
dualentry customers get 318 --format json
```

### Create a record

dualentry \<resource> create

&#x20;

[--file \<file>](#cli-resource-create-file)

&#x20;

[\[-o, --format \<format>\]](#cli-resource-create-format)

Creates a record from a JSON file and prints it. The file's shape is the request body of the matching endpoint in the [API reference](https://docs.dualentry.com/developers/api/resources-v2.md); no subcommand accepts record fields as flags.

Flags:

* `--file`, `-f` (path, required): JSON file with record data.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Create an invoice from a file theme={null}
dualentry invoices create --file invoice.json
```

```bash Create a customer and print it as JSON theme={null}
dualentry customers create --file customer.json --format json
```

### Update a record

dualentry \<resource> update

&#x20;

[\<record-id>](#cli-resource-update-record-id)

&#x20;

[--file \<file>](#cli-resource-update-file)

&#x20;

[\[-o, --format \<format>\]](#cli-resource-update-format)

Replaces a record with the contents of a JSON file, which the CLI sends as the body of a `PUT` request. Pass the record number on resources that have one, including recurring records, and the ID otherwise. Unlike `get`, `update` doesn't strip a display prefix, so pass the bare value.

Arguments:

* `RECORD_ID` (string, required): Record ID.

Flags:

* `--file`, `-f` (path, required): JSON file with update data.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Update an invoice theme={null}
dualentry invoices update 1043 --file invoice.json
```

### Delete a record

dualentry \<resource> delete

&#x20;

[\<record-id>](#cli-resource-delete-record-id)

Deletes a record without asking for confirmation. Only custom fields, product tax codes, and recurring records can be deleted; on recurring records, pass the record number, and deleting one removes its schedule.

Arguments:

* `RECORD_ID` (string, required): Record ID.

```bash Delete a recurring invoice schedule theme={null}
dualentry recurring invoices delete 318
```

```bash Delete a custom field theme={null}
dualentry custom-fields delete 42
```

### Attach files to a record

dualentry \<resource> add-attachments

&#x20;

[\<number>](#cli-resource-add-attachments-number)

&#x20;

[--file \<file>](#cli-resource-add-attachments-file)

&#x20;

[\[-o, --format \<format>\]](#cli-resource-add-attachments-format)

Uploads one or more files to a record and keeps the files already attached to it. Pass the record number from the `#` column, not the prefixed ID such as `IN-12`. Each file must be 10 MiB or smaller and not empty. The CLI checks every file before it uploads any of them, so one bad file doesn't leave the others half-attached. The output lists every attachment on the record with its ID, file name, and size; with `--format json`, it prints the whole record.

`add-attachments` is available on `invoices`, `bills`, `sales-orders`, `customer-prepayments`, `customer-prepayment-applications`, `customer-deposits`, `customer-refunds`, `cash-sales`, `purchase-orders`, `vendor-payments`, `vendor-refunds`, `direct-expenses`, and `journal-entries`. To attach files to a statistical journal, see [Attach files to a statistical journal](#attach-files-to-a-statistical-journal).

Arguments:

* `NUMBER` (string, required): Record number, shown in the `#` column.

Flags:

* `--file`, `-f` (path, required, repeatable): File to attach, up to 10 MiB. Repeat the flag to attach more than one file.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry invoices replace-attachments

&#x20;

[\<number>](#cli-invoices-replace-attachments-number)

&#x20;

[--file \<file>](#cli-invoices-replace-attachments-file)

&#x20;

[\[-o, --format \<format>\]](#cli-invoices-replace-attachments-format)

Replaces every attachment on an invoice with the files you pass. The invoice's current attachments are deleted. The same file checks and output apply as for `add-attachments`. Only invoices support this subcommand.

Arguments:

* `NUMBER` (string, required): Record number, shown in the `#` column.

Flags:

* `--file`, `-f` (path, required, repeatable): File to attach, up to 10 MiB. Repeat the flag to attach more than one file.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Attach a receipt and an approval to a bill theme={null}
dualentry bills add-attachments 1042 -f receipt.pdf -f approval.eml
```

```bash Replace an invoice's attachments with a signed copy theme={null}
dualentry invoices replace-attachments 318 -f signed-invoice.pdf
```

### Commands for each record type

The tables below list every resource command, grouped by area, with the subcommands it supports and the filters its `list` subcommand accepts.

**Receivables**

| Command | Subcommands | `list` filters |
| - | - | - |
| `invoices` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments`, `replace-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |
| `sales-orders` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |
| `customer-payments` | `list`, `get`, `get-number`, `get-id`, `create`, `update` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |
| `customer-credits` | `list`, `get`, `get-number`, `get-id`, `create`, `update` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |
| `customer-prepayments` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |
| `customer-prepayment-applications` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |
| `customer-deposits` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |
| `customer-refunds` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |
| `cash-sales` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |

**Payables**

| Command | Subcommands | `list` filters |
| - | - | - |
| `bills` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--vendor` |
| `purchase-orders` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--vendor` |
| `vendor-payments` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--vendor` |
| `vendor-credits` | `list`, `get`, `get-number`, `get-id`, `create`, `update` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--vendor` |
| `vendor-prepayments` | `list`, `get`, `get-number`, `get-id`, `create`, `update` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--vendor` |
| `vendor-prepayment-applications` | `list`, `get`, `get-number`, `get-id`, `create`, `update` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--vendor` |
| `vendor-refunds` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--vendor` |
| `direct-expenses` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--vendor` |

**Accounting**

| Command | Subcommands | `list` filters |
| - | - | - |
| `journal-entries` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `add-attachments` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer`, `--vendor` |
| `intercompany-journal-entries` | `list`, `get`, `get-number`, `get-id`, `create`, `update`, `validate`, `post`, `template` | `--search`, `--status`, `--start-date`, `--end-date`, `--company` |
| `bank-transfers` | `list`, `get`, `get-number`, `get-id`, `create`, `update` | `--search`, `--status`, `--start-date`, `--end-date`, `--company` |
| `fixed-assets` | `list`, `get`, `get-number`, `get-id`, `create`, `update` | `--search`, `--status`, `--company`, `--customer`, `--vendor` |
| `depreciation-books` | `list`, `get` | None |
| `paper-checks` | `list`, `get` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer`, `--vendor` |
| `inbox` | `list` | `--search` |

**Master data**

| Command | Subcommands | `list` filters |
| - | - | - |
| `customers` | `list`, `get`, `create`, `update` | `--search`, `--status`, `--company` |
| `vendors` | `list`, `get`, `create`, `update` | `--search`, `--status`, `--start-date`, `--end-date`, `--company` |
| `companies` | `list`, `get` | `--search` |
| `classifications` | `list`, `get`, `create`, `update` | `--search` |
| `classifications-lines` | `list` | `--search`, `--classification`, `--id`, `--name`, `--active`, `--inactive` (see [List classification lines](#list-classification-lines)) |
| `custom-fields` | `list`, `get`, `create`, `update`, `delete` | `--search` |
| `product-tax-codes` | `list`, `get`, `create`, `update`, `delete` | `--search` |
| `vat-rates` | `list`, `get` | None |
| `gst-tax-rates` | `list`, `get` | `--country`, `--treatment`, `--active`, `--inactive`, `--updated-after`, `--updated-before` (see [List GST tax rates](#list-gst-tax-rates)) |

**Recurring records, contracts, budgets, and workflows**

| Command | Subcommands | `list` filters |
| - | - | - |
| `recurring invoices` | `list`, `get`, `create`, `update`, `delete` | `--search`, `--company` |
| `recurring bills` | `list`, `get`, `create`, `update`, `delete` | `--search`, `--company` |
| `recurring journal-entries` | `list`, `get`, `create`, `update`, `delete` | `--search`, `--company` |
| `contracts` | `list`, `get`, `create`, `update` | `--search`, `--status`, `--start-date`, `--end-date`, `--company`, `--customer` |
| `budgets` | `list`, `get` | `--search`, `--status`, `--company` |
| `workflows` | `list`, `get` | `--search`, `--company` |

## Intercompany journal entries

Intercompany journal entries have three extra subcommands for drafting an entry from a file, checking it, and posting it. Use the [record subcommands](#work-with-records) to list, retrieve, create, and update them.

### Generate an entry template

dualentry intercompany-journal-entries template

&#x20;

[\[-o, --output \<file>\]](#cli-intercompany-journal-entries-template-output)

Prints a sample intercompany journal entry as JSON, or writes it to a file. On this subcommand, `-o` is short for `--output`.

Flags:

* `--output`, `-o` (path, optional): File to write the template to, instead of standard output.

```bash Write a template to a file theme={null}
dualentry intercompany-journal-entries template --output ije.json
```

### Validate an entry

dualentry intercompany-journal-entries validate

&#x20;

[--file \<file>](#cli-intercompany-journal-entries-validate-file)

&#x20;

[\[--online\]](#cli-intercompany-journal-entries-validate-online)

Checks a JSON file in order and stops at the first failure: the `items` array isn't empty, every debit and credit is a valid amount, total debits equal total credits, and the lines span at least two companies. `--online` also confirms you can access every `company_id` in the file. Prints `✓ Valid`, or the problem and exits with code `1`.

Flags:

* `--file`, `-f` (path, required): JSON file to validate.
* `--online` (boolean, optional): Also run checks that require API access.

```bash Validate a file offline theme={null}
dualentry intercompany-journal-entries validate --file ije.json
```

```bash Validate a file and check company access theme={null}
dualentry intercompany-journal-entries validate --file ije.json --online
```

### Post a draft entry

dualentry intercompany-journal-entries post

&#x20;

[\<number>](#cli-intercompany-journal-entries-post-number)

&#x20;

[\[-o, --format \<format>\]](#cli-intercompany-journal-entries-post-format)

Posts a draft intercompany journal entry. If the entry isn't a draft, prints its current status and exits with code `1` without changing it.

Arguments:

* `NUMBER` (string, required): Record number of the draft to post.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Create an entry as a draft, then post it theme={null}
dualentry intercompany-journal-entries create --file ije.json
dualentry intercompany-journal-entries post 204
```

## Accounts and statistical journals

The `accounts` commands look up accounts in your chart of accounts, and the `statistical-journals` commands list, create, update, and attach files to statistical journal entries.

### List accounts

dualentry accounts list

&#x20;

[\[flags\]](#cli-accounts-list-flags)

Lists the accounts in your chart of accounts.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--search`, `-s` (string, optional): Text to search for.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Search accounts theme={null}
dualentry accounts list --search revenue
```

### Retrieve an account

dualentry accounts get

&#x20;

[\<account-id>](#cli-accounts-get-account-id)

&#x20;

[\[-o, --format \<format>\]](#cli-accounts-get-format)

Prints one account, looked up by account number.

Arguments:

* `ACCOUNT_ID` (integer, required): Account number.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Retrieve an account by number theme={null}
dualentry accounts get 4000
```

### List statistical journals

dualentry statistical-journals list

&#x20;

[\[flags\]](#cli-statistical-journals-list-flags)

Lists statistical journals. Date filters take `YYYY-MM-DD` values, `--updated-after` and `--updated-before` take ISO 8601 timestamps, and the number and account filters take comma-separated lists. You can repeat `--number`, `--account-id`, and `--line-account-id`, so `--number 1,2 --number 3` matches all three. An empty value for any of those three is a usage error rather than a filter that matches everything.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--search`, `-s` (string, optional): Text to search for.
* `--status` (string, optional): Return only records with this status: `draft`, `posted`, or `archived`.
* `--company`, `-c` (string, optional): Return only records for this company ID.
* `--date-start` (string, optional): Start of the journal date range to return, in `YYYY-MM-DD` format.
* `--date-end` (string, optional): End of the journal date range to return, in `YYYY-MM-DD` format.
* `--period-start` (string, optional): Earliest period start date to return, in `YYYY-MM-DD` format.
* `--period-end` (string, optional): Latest period end date to return, in `YYYY-MM-DD` format.
* `--number` (comma-separated integers, optional, repeatable): Return only journals with these record numbers.
* `--account-id` (comma-separated integers, optional, repeatable): Return only journals for these account IDs.
* `--account-number` (string, optional): Return only journals for these account numbers, separated by commas.
* `--line-account-id` (comma-separated integers, optional, repeatable): Return only journals with lines on these account IDs.
* `--line-account-number` (string, optional): Return only journals with lines on these account numbers, separated by commas.
* `--updated-after` (string, optional): Return only journals updated after this time, as an ISO 8601 timestamp.
* `--updated-before` (string, optional): Return only journals updated before this time, as an ISO 8601 timestamp.
* `--ordering` (string, optional): API field to sort by. Prefix it with `-` to sort in descending order.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List journals for September theme={null}
dualentry statistical-journals list --date-start 2026-09-01 --date-end 2026-09-30
```

```bash List journals that touch two accounts theme={null}
dualentry statistical-journals list --account-number 4000,4100
```

### Retrieve, create, or update a statistical journal

dualentry statistical-journals get

&#x20;

[\<value>](#cli-statistical-journals-get-value)

&#x20;

[\[-o, --format \<format>\]](#cli-statistical-journals-get-format)

Work with a single statistical journal. `get` accepts the record number with or without its `SJ-` prefix, and `create` and `update` read the journal from a JSON file.

Get a statistical journal by number.

Arguments:

* `VALUE` (string, required): Record number (the `#` column) or prefixed number, for example `SJ-3`.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry statistical-journals create

&#x20;

[--file \<file>](#cli-statistical-journals-create-file)

&#x20;

[\[-o, --format \<format>\]](#cli-statistical-journals-create-format)

Create a statistical journal from a JSON file.

Flags:

* `--file`, `-f` (path, required): JSON file with record data.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry statistical-journals update

&#x20;

[\<number>](#cli-statistical-journals-update-number)

&#x20;

[--file \<file>](#cli-statistical-journals-update-file)

&#x20;

[\[-o, --format \<format>\]](#cli-statistical-journals-update-format)

Update a statistical journal.

Arguments:

* `NUMBER` (string, required): Record number of the journal to update.

Flags:

* `--file`, `-f` (path, required): JSON file with update data.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Retrieve a statistical journal theme={null}
dualentry statistical-journals get SJ-3
```

```bash Create a statistical journal theme={null}
dualentry statistical-journals create --file statistical-journal.json
```

```bash Update a statistical journal theme={null}
dualentry statistical-journals update 3 --file statistical-journal.json
```

### Attach files to a statistical journal

dualentry statistical-journals add-attachments

&#x20;

[\<number>](#cli-statistical-journals-add-attachments-number)

&#x20;

[--file \<file>](#cli-statistical-journals-add-attachments-file)

&#x20;

[\[-o, --format \<format>\]](#cli-statistical-journals-add-attachments-format)

Uploads one or more files to a statistical journal and keeps the files already attached to it. Pass `--file` once per file. It works like [`add-attachments` on other records](#attach-files-to-a-record): each file must be 10 MiB or smaller, every file is checked before any is uploaded, and the output lists the journal's attachments. The record number can carry its `SJ-` prefix, but no other prefix.

Arguments:

* `NUMBER` (string, required): Record number of the journal, for example `3` or `SJ-3`.

Flags:

* `--file`, `-f` (path, required, repeatable): File to attach, up to 10 MiB. Repeat the flag to attach more than one file.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Attach two files theme={null}
dualentry statistical-journals add-attachments 3 --file headcount.csv --file approval.pdf
```

## Classification lines and GST tax rates

These read-only commands look up the IDs that transaction line items reference. The `classifications-lines` command lists the values each classification offers, and the `gst-tax-rates` commands find the `gst_tax_rate_id` for a line.

### List classification lines

dualentry classifications-lines list

&#x20;

[\[flags\]](#cli-classifications-lines-list-flags)

Lists classification lines across every classification, with the classification each line belongs to and whether it's active. `--classification` and `--id` take comma-separated IDs and can be repeated. An empty value is a usage error rather than a filter that matches everything. Without `--active` or `--inactive`, the list includes both.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--search`, `-s` (string, optional): Text to search for.
* `--classification` (comma-separated integers, optional, repeatable): Return only lines in these classifications, by classification ID.
* `--id` (comma-separated integers, optional, repeatable): Return only the lines with these IDs.
* `--name` (string, optional): Return only lines whose name contains this text, ignoring case.
* `--active` / `--inactive` (boolean, optional): Return only active lines, or only inactive ones.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List the active lines in two classifications theme={null}
dualentry classifications-lines list --classification 4,7 --active
```

```bash Find a line by name theme={null}
dualentry classifications-lines list --name marketing
```

### List GST tax rates

dualentry gst-tax-rates list

&#x20;

[\[flags\]](#cli-gst-tax-rates-list-flags)

Lists the GST tax rates available to your organization: GST for Australia, New Zealand, Singapore, India, and Canada, and SST for Malaysia. Use a rate's ID as `gst_tax_rate_id` on a transaction line item. The table shows each rate as a percentage, and adds the province or state to the country for regional rates, for example `CA (ON)`. With `--format json`, rates appear as the API returns them, as fractions such as `0.100000` for 10%.

`--country` and `--treatment` accept values in any case, and a value outside the list is a usage error that names the valid ones. `--updated-after` and `--updated-before` take an ISO 8601 timestamp with a time zone, such as `2026-10-01T00:00:00Z`.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--country` (string, optional, repeatable): Return only rates for this country: `AU`, `NZ`, `SG`, `IN`, `CA`, or `MY`. Repeat the flag to match more than one country.
* `--treatment` (string, optional): Return only rates with this tax treatment: `STANDARD`, `ZERO_RATED`, `EXEMPT`, `IMPORT_GST`, `REVERSE_CHARGE`, `SELF_ASSESSED`, or `OUT_OF_SCOPE`.
* `--active` / `--inactive` (boolean, optional): Return only active rates, or only inactive ones. Without either flag, the list includes both.
* `--updated-after` (string, optional): Return only rates updated at or after this time.
* `--updated-before` (string, optional): Return only rates updated at or before this time.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List active standard rates for Australia and New Zealand theme={null}
dualentry gst-tax-rates list --country AU --country NZ --treatment standard --active
```

```bash List rates changed since October theme={null}
dualentry gst-tax-rates list --updated-after 2026-10-01T00:00:00Z
```

### Retrieve a GST tax rate

dualentry gst-tax-rates get

&#x20;

[\<rate-id>](#cli-gst-tax-rates-get-rate-id)

&#x20;

[\[-o, --format \<format>\]](#cli-gst-tax-rates-get-format)

Prints one GST tax rate with its treatment, validity dates, and whether it's active. Some rates are made up of parts, such as CGST and SGST in India or GST and PST in Canada. For these, the command also shows a table of the components with each one's rate and region.

Arguments:

* `RATE_ID` (integer, required): GST tax rate ID.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Retrieve a GST tax rate theme={null}
dualentry gst-tax-rates get 12
```

## Bank matching

The `bank-match` commands reconcile bank-feed transactions against DualEntry transactions.

### Check matching progress

dualentry bank-match status-counts

&#x20;

[\[-o, --format \<format>\]](#cli-bank-match-status-counts-format)

Shows how many bank-feed rows sit in each pipeline stage. Matching is still running while `unprocessed`, `awaiting_ai`, or `ai_in_progress` is above zero.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Check matching progress theme={null}
dualentry bank-match status-counts
```

### List bank-feed transactions

dualentry bank-match bank-transactions list

&#x20;

[\[flags\]](#cli-bank-match-bank-transactions-list-flags)

Lists bank-feed transactions, or prints one by ID. Expired rows are hidden unless you pass `--include-expired`.

List bank-feed transactions.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--financial-account-id` (integer, optional): Return only transactions for this connected bank or credit-card account ID.
* `--matching-status` (string, optional): Matching stage to filter by, such as `unprocessed`, `ai_suggested`, `matched`, `no_match`, or `excluded`.
* `--date-from` (datetime, optional): Earliest transaction date to return, in `YYYY-MM-DD` format.
* `--date-to` (datetime, optional): Latest transaction date to return, in `YYYY-MM-DD` format.
* `--is-posted`, `--not-posted` (boolean, optional): `--is-posted` returns only posted transactions and `--not-posted` only pending ones. Omit both to return all transactions.
* `--include-expired` (boolean, optional): Include expired bank-feed rows, which are hidden by default.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry bank-match bank-transactions get

&#x20;

[\<financial-transaction-id>](#cli-bank-match-bank-transactions-get-financial-transaction-id)

&#x20;

[\[-o, --format \<format>\]](#cli-bank-match-bank-transactions-get-format)

Get one bank-feed transaction by ID.

Arguments:

* `FINANCIAL_TRANSACTION_ID` (integer, required): Bank-feed transaction ID from `bank-match bank-transactions list`.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List unprocessed rows since September 1 theme={null}
dualentry bank-match bank-transactions list --matching-status unprocessed --date-from 2026-09-01
```

```bash Show one bank-feed transaction theme={null}
dualentry bank-match bank-transactions get 42
```

### Review suggested matches

dualentry bank-match suggestions list

&#x20;

[\[flags\]](#cli-bank-match-suggestions-list-flags)

Lists the matches DualEntry suggests for bank-feed rows, or prints one suggestion by ID.

List bank-match suggestions.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--financial-transaction-id` (integer, optional): Return only suggestions for this bank-feed row ID.
* `--suggestion-type` (string, optional): Kind of suggestion: `match` to pair with an existing transaction, or `create` to draft a new one.
* `--highest-ranked` (boolean, optional): Return only the top-ranked suggestion for each bank-feed row, which is what the DualEntry app shows by default.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry bank-match suggestions get

&#x20;

[\<suggestion-id>](#cli-bank-match-suggestions-get-suggestion-id)

&#x20;

[\[-o, --format \<format>\]](#cli-bank-match-suggestions-get-format)

Get one bank-match suggestion by ID.

Arguments:

* `SUGGESTION_ID` (integer, required): Suggestion ID from `bank-match suggestions list`.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Show the top suggestion for one bank-feed row theme={null}
dualentry bank-match suggestions list --financial-transaction-id 42 --highest-ranked
```

### Confirm a match

dualentry bank-match match

&#x20;

[\[flags\]](#cli-bank-match-match-flags)

Confirms a match between a bank-feed row and DualEntry transactions. Pass `--financial-transaction-id` with exactly one of `--transaction-id` or `--entry-id` for a one-to-one or partial match, or a file for one-to-one and many-to-many matches. A file can't be combined with the ID flags.

Flags:

* `--file`, `-f` (path, optional): JSON file with the full match request, for one-to-one or many-to-many matches. Can't be combined with the ID flags.
* `--financial-transaction-id` (integer, optional): Bank-feed row ID to match one-to-one. Required when you don't pass `--file`.
* `--transaction-id` (integer, optional): DualEntry transaction ID to pair with in a one-to-one match. Pass this or `--entry-id`, not both.
* `--entry-id` (integer, optional): DualEntry entry ID for a partial match. Pass this or `--transaction-id`, not both.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Match one bank-feed row to one transaction theme={null}
dualentry bank-match match --financial-transaction-id 42 --transaction-id 100
```

```bash Confirm a many-to-many match from a file theme={null}
dualentry bank-match match --file match.json
```

### Undo a match

dualentry bank-match unmatch

&#x20;

[\[flags\]](#cli-bank-match-unmatch-flags)

Undoes a confirmed match. Pass exactly one of the two flags; unmatching any member dissolves the whole match group.

Flags:

* `--financial-transaction-id` (integer, optional): Bank-feed row ID in the match group to undo. Pass this or `--match-group-id`.
* `--match-group-id` (integer, optional): Match group ID from a prior match response. Pass this or `--financial-transaction-id`.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Undo a match group theme={null}
dualentry bank-match unmatch --match-group-id 7
```

### Generate a match file

dualentry bank-match template

&#x20;

[\[-o, --output \<file>\]](#cli-bank-match-template-output)

&#x20;

[\[-t, --type \<type>\]](#cli-bank-match-template-type)

Prints a sample match file for `bank-match match --file`, or writes it to a file. On this subcommand, `-o` is short for `--output`.

Flags:

* `--output`, `-o` (path, optional): File to write the template to, instead of standard output.
* `--type`, `-t` (string, default `1:1`): Template type: `1:1`, `m:n`, or `partial`.

```bash Write a many-to-many match template theme={null}
dualentry bank-match template --type m:n --output match.json
```

## Bank connections

The `bank-connections` commands register bank connections, their accounts, and their transactions through the API, for organizations that send bank data to DualEntry themselves.

### List bank connections

dualentry bank-connections list

&#x20;

[\[flags\]](#cli-bank-connections-list-flags)

Lists your bank connections, or prints one by ID.

List bank connections.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--updated-after` (datetime, optional): Return only connections updated at or after this time, as an ISO 8601 timestamp.
* `--updated-before` (datetime, optional): Return only connections updated at or before this time, as an ISO 8601 timestamp.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry bank-connections get

&#x20;

[\<connection-id>](#cli-bank-connections-get-connection-id)

&#x20;

[\[-o, --format \<format>\]](#cli-bank-connections-get-format)

Get one bank connection by ID.

Arguments:

* `CONNECTION_ID` (integer, required): DualEntry bank connection ID.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List connections changed since September 1 theme={null}
dualentry bank-connections list --updated-after 2026-09-01T00:00:00
```

```bash Show one connection theme={null}
dualentry bank-connections get 42
```

### Register a bank connection

dualentry bank-connections create

&#x20;

[--file \<file>](#cli-bank-connections-create-file)

&#x20;

[\[-o, --format \<format>\]](#cli-bank-connections-create-format)

Registers a bank connection, and optionally its accounts, from a JSON file.

Flags:

* `--file`, `-f` (path, required): JSON file with the connection to register.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Register a connection from a file theme={null}
dualentry bank-connections create --file connection.json
```

### Unregister a bank connection

dualentry bank-connections delete

&#x20;

[\<connection-id>](#cli-bank-connections-delete-connection-id)

Unregisters a bank connection.

Arguments:

* `CONNECTION_ID` (integer, required): DualEntry bank connection ID to unregister.

```bash Unregister a connection theme={null}
dualentry bank-connections delete 42
```

### Register accounts on a connection

dualentry bank-connections accounts list

&#x20;

[\<connection-id>](#cli-bank-connections-accounts-list-connection-id)

&#x20;

[\[-o, --format \<format>\]](#cli-bank-connections-accounts-list-format)

Lists the accounts registered under a connection, or registers more from a JSON file.

List accounts registered under a bank connection.

Arguments:

* `CONNECTION_ID` (integer, required): DualEntry bank connection ID.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry bank-connections accounts create

&#x20;

[\<connection-id>](#cli-bank-connections-accounts-create-connection-id)

&#x20;

[--file \<file>](#cli-bank-connections-accounts-create-file)

&#x20;

[\[-o, --format \<format>\]](#cli-bank-connections-accounts-create-format)

Register accounts under an existing bank connection.

Arguments:

* `CONNECTION_ID` (integer, required): DualEntry bank connection ID.

Flags:

* `--file`, `-f` (path, required): JSON file with the array of accounts to create.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List a connection's accounts theme={null}
dualentry bank-connections accounts list 42
```

```bash Register accounts from a file theme={null}
dualentry bank-connections accounts create 42 --file accounts.json
```

### Push bank transactions

dualentry bank-connections transactions push

&#x20;

[\<financial-account-id>](#cli-bank-connections-transactions-push-financial-account-id)

&#x20;

[--file \<file>](#cli-bank-connections-transactions-push-file)

&#x20;

[\[-o, --format \<format>\]](#cli-bank-connections-transactions-push-format)

Pushes a batch of bank transactions for a registered account from a JSON file.

Arguments:

* `FINANCIAL_ACCOUNT_ID` (integer, required): DualEntry financial account ID.

Flags:

* `--file`, `-f` (path, required): JSON file with the batch of transactions to push.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Push a batch of transactions theme={null}
dualentry bank-connections transactions push 87 --file transactions.json
```

### Generate a bank connection file

dualentry bank-connections template

&#x20;

[\[-o, --output \<file>\]](#cli-bank-connections-template-output)

&#x20;

[\[-t, --type \<type>\]](#cli-bank-connections-template-type)

Prints a sample JSON file for `create`, `accounts create`, or `transactions push`, or writes it to a file. On this subcommand, `-o` is short for `--output`.

Flags:

* `--output`, `-o` (path, optional): File to write the template to, instead of standard output.
* `--type`, `-t` (string, default `connection`): Template type: `connection`, `accounts`, or `transactions`.

```bash Write a transactions template theme={null}
dualentry bank-connections template --type transactions --output transactions.json
```

## Data exports

The `export-jobs` commands request and track an on-demand refresh of a connected data warehouse destination, outside its regular schedule.

### Request a data export

dualentry export-jobs create

&#x20;

[\[--integration-id \<integration-id>\]](#cli-export-jobs-create-integration-id)

&#x20;

[\[-o, --format \<format>\]](#cli-export-jobs-create-format)

Requests an export. If one is already running, returns that job instead of starting another.

Flags:

* `--integration-id` (integer, optional): Destination integration ID. You can omit it when your organization has exactly one connected destination.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Request an export theme={null}
dualentry export-jobs create
```

### Wait for a data export to finish

dualentry export-jobs wait

&#x20;

[\<job-id>](#cli-export-jobs-wait-job-id)

&#x20;

[\[flags\]](#cli-export-jobs-wait-flags)

Checks a job until it finishes. Exits with code `0` when it completes, or `1` when it fails or the timeout passes, so it works as a step in a CI job.

Arguments:

* `JOB_ID` (integer, required): Export job ID to poll until finished.

Flags:

* `--interval` (number, default `5.0`, minimum `0.5`): Seconds between status polls.
* `--timeout` (number, default `1800.0`, minimum `1.0`): Give up after this many seconds (default 30 minutes).
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Request an export and wait for it theme={null}
dualentry export-jobs create --format json | jq '.id'
dualentry export-jobs wait 12 --timeout 600
```

### List and check data exports

dualentry export-jobs list

&#x20;

[\[flags\]](#cli-export-jobs-list-flags)

Lists export jobs, most recent first, or prints one job.

List destination data export jobs, most recent first.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--status` (string, optional, repeatable): Return only jobs with this status: `pending`, `running`, `completed`, or `failed`. Repeat the flag to match more than one status.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry export-jobs get

&#x20;

[\<job-id>](#cli-export-jobs-get-job-id)

&#x20;

[\[-o, --format \<format>\]](#cli-export-jobs-get-format)

Get one export job by ID. Poll this after create.

Arguments:

* `JOB_ID` (integer, required): Export job ID from `export-jobs create` or `export-jobs list`.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List running and pending exports theme={null}
dualentry export-jobs list --status running --status pending
```

```bash Check one export theme={null}
dualentry export-jobs get 12
```

## Webhooks

The `webhooks` commands register endpoints that receive DualEntry events, change or remove them, and show their delivery history. For how deliveries are signed, retried, and auto-disabled, see [Webhooks](https://docs.dualentry.com/accountants/integrations/automation-and-developer-tools/webhooks.md). Commands that take a webhook take its UUID, shown in the `UUID` column of `webhooks list`. The CLI shows times in your local time zone.

### List webhook topics

dualentry webhooks topics

&#x20;

[\[-o, --format \<format>\]](#cli-webhooks-topics-format)

Prints the topics a webhook can subscribe to, one per line, such as `core.invoice/created`. With `--format json`, it prints the list as the API returns it.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List the topics you can subscribe to theme={null}
dualentry webhooks topics
```

### Register a webhook

dualentry webhooks create

&#x20;

[--url \<url>](#cli-webhooks-create-url)

&#x20;

[\[-t, --topic \<topic>\]](#cli-webhooks-create-topic)

&#x20;

[\[-o, --format \<format>\]](#cli-webhooks-create-format)

Registers an endpoint and prints the new webhook with its signing secret. The secret appears only in this output and DualEntry doesn't show it again, so store it before you close the terminal. If you don't pass `--topic`, the webhook is created but receives no events, and the CLI prints a warning.

Flags:

* `--url` (string, required): Public `http` or `https` URL that receives the events. Use `https` in production.
* `--topic`, `-t` (string, optional, repeatable): Topic to subscribe to, from `webhooks topics`. Repeat the flag to subscribe to more than one topic.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Register an endpoint for two topics theme={null}
dualentry webhooks create --url https://hooks.example.com/dualentry -t core.invoice/created -t core.invoice/updated
```

### List and retrieve webhooks

dualentry webhooks list

&#x20;

[\[flags\]](#cli-webhooks-list-flags)

Lists webhooks, newest first, with each one's URL, number of topics, and state: `active`, `inactive`, or `disabled` when DualEntry turned it off after repeated failed deliveries. Without `--active` or `--inactive`, the list includes both.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--search`, `-s` (string, optional): Text to search for.
* `--active` / `--inactive` (boolean, optional): Return only active webhooks, or only inactive ones.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

dualentry webhooks get

&#x20;

[\<webhook-id>](#cli-webhooks-get-webhook-id)

&#x20;

[\[-o, --format \<format>\]](#cli-webhooks-get-format)

Prints one webhook with its topics and when it was created and last changed. If DualEntry disabled it, the state also shows the date and the reason.

Arguments:

* `WEBHOOK_ID` (UUID, required): Webhook UUID, from `webhooks list`.

Flags:

* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash List active webhooks theme={null}
dualentry webhooks list --active
```

```bash Check why a webhook stopped receiving events theme={null}
dualentry webhooks get 3f2b8c1e-9a4d-4e6f-8b7a-1c2d3e4f5a6b
```

### Update a webhook

dualentry webhooks update

&#x20;

[\<webhook-id>](#cli-webhooks-update-webhook-id)

&#x20;

[\[flags\]](#cli-webhooks-update-flags)

Changes only the settings you pass. `--topic` replaces the whole list of topics rather than adding to it, so pass every topic you want to keep. Passing `--topic` and `--clear-topics` together, or passing no flags, is a usage error. `--active` also turns a webhook back on after DualEntry disabled it for repeated failures.

Arguments:

* `WEBHOOK_ID` (UUID, required): Webhook UUID, from `webhooks list`.

Flags:

* `--url` (string, optional): New endpoint URL.
* `--topic`, `-t` (string, optional, repeatable): Topic to subscribe to. The topics you pass replace the current list.
* `--clear-topics` (boolean, optional): Unsubscribe from every topic. The webhook then receives no events.
* `--active` / `--inactive` (boolean, optional): Turn delivery on or off.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Turn a disabled webhook back on theme={null}
dualentry webhooks update 3f2b8c1e-9a4d-4e6f-8b7a-1c2d3e4f5a6b --active
```

```bash Change the topics a webhook receives theme={null}
dualentry webhooks update 3f2b8c1e-9a4d-4e6f-8b7a-1c2d3e4f5a6b -t core.bill/created -t core.bill/updated
```

### Delete a webhook

dualentry webhooks delete

&#x20;

[\<webhook-id>](#cli-webhooks-delete-webhook-id)

Deletes a webhook without asking for confirmation. Its delivery history is deleted too, including deliveries that haven't been sent yet.

Arguments:

* `WEBHOOK_ID` (UUID, required): Webhook UUID, from `webhooks list`.

```bash Delete a webhook theme={null}
dualentry webhooks delete 3f2b8c1e-9a4d-4e6f-8b7a-1c2d3e4f5a6b
```

### List webhook deliveries

dualentry webhooks deliveries

&#x20;

[\<webhook-id>](#cli-webhooks-deliveries-webhook-id)

&#x20;

[\[flags\]](#cli-webhooks-deliveries-flags)

Lists a webhook's delivery attempts, newest first, with each one's topic, status, number of attempts, the HTTP status your endpoint returned, and the last error.

Arguments:

* `WEBHOOK_ID` (UUID, required): Webhook UUID, from `webhooks list`.

Flags:

* `--limit`, `-l` (integer, default `20`): Maximum number of records to return.
* `--offset` (integer, default `0`): Number of records to skip before the first one returned.
* `--all`, `-a` (boolean, optional): Fetch every page of results instead of one.
* `--format`, `-o` (string, default `human`): Output format: `human` (a table or detail view) or `json`.

```bash Check what a webhook delivered theme={null}
dualentry webhooks deliveries 3f2b8c1e-9a4d-4e6f-8b7a-1c2d3e4f5a6b
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.