@qontoctl/cli
v0.4.0
Published
CLI for Qonto API integration
Maintainers
Readme
@qontoctl/cli
CLI commands for Qonto API integration — transaction listing, organization details, labels, memberships, statements, and more.
Part of the QontoCtl project.
Note: For end-user usage, install the
qontoctlumbrella package instead. This package is for programmatic access to the CLI command definitions.
Installation
npm install @qontoctl/cliCommands
| Command | Description |
| --------------------------------------------- | ----------------------------------------- |
| org show | Show organization details |
| account list | List bank accounts |
| account show <id> | Show bank account details |
| account iban-certificate <id> | Download IBAN certificate PDF |
| account create | Create a new bank account |
| account update <id> | Update a bank account |
| account close <id> | Close a bank account |
| transaction list | List transactions with filters |
| transaction show <id> | Show transaction details |
| transaction attachment list <id> | List attachments for a transaction |
| transaction attachment add <id> <file> | Attach a file to a transaction |
| transaction attachment remove <id> [att-id] | Remove attachment(s) from a transaction |
| statement list | List bank statements |
| statement show <id> | Show statement details |
| statement download <id> | Download statement PDF |
| label list | List all labels |
| label show <id> | Show label details |
| membership list | List organization memberships |
| membership show | Show current user's membership |
| membership invite | Invite a new member |
| beneficiary list | List SEPA beneficiaries |
| beneficiary show <id> | Show beneficiary details |
| beneficiary add | Create a new beneficiary |
| beneficiary update <id> | Update a beneficiary |
| beneficiary trust <id...> | Trust one or more beneficiaries |
| beneficiary untrust <id...> | Untrust one or more beneficiaries |
| transfer list | List SEPA transfers |
| transfer show <id> | Show SEPA transfer details |
| transfer create | Create a SEPA transfer |
| transfer cancel <id> | Cancel a pending SEPA transfer |
| transfer proof <id> | Download SEPA transfer proof PDF |
| transfer verify-payee | Verify a payee (VoP) |
| transfer bulk-verify-payee | Bulk verify payees from CSV |
| internal-transfer create | Create an internal transfer |
| bulk-transfer list | List bulk transfers |
| bulk-transfer show <id> | Show bulk transfer details |
| recurring-transfer list | List recurring transfers |
| recurring-transfer show <id> | Show recurring transfer details |
| client list | List clients |
| client show <id> | Show client details |
| client create | Create a new client |
| client update <id> | Update a client |
| client delete <id> | Delete a client |
| client-invoice list | List client invoices |
| client-invoice show <id> | Show client invoice details |
| client-invoice create | Create a draft client invoice |
| client-invoice update <id> | Update a draft client invoice |
| client-invoice delete <id> | Delete a draft client invoice |
| client-invoice finalize <id> | Finalize client invoice and assign number |
| client-invoice send <id> | Send client invoice to client via email |
| client-invoice mark-paid <id> | Mark client invoice as paid |
| client-invoice unmark-paid <id> | Unmark client invoice paid status |
| client-invoice cancel <id> | Cancel a finalized client invoice |
| client-invoice upload <id> <file> | Upload a file to a client invoice |
| client-invoice upload-show <id> <upload-id> | Show upload details for a client invoice |
| quote list | List quotes |
| quote show <id> | Show quote details |
| quote create | Create a new quote |
| quote update <id> | Update a quote |
| quote delete <id> | Delete a quote |
| quote send <id> | Send quote to client via email |
| credit-note list | List credit notes |
| credit-note show <id> | Show credit note details |
| supplier-invoice list | List supplier invoices |
| supplier-invoice show <id> | Show supplier invoice details |
| supplier-invoice bulk-create | Create supplier invoices from files |
| einvoicing settings | Show e-invoicing settings |
| request list | List all requests |
| attachment upload <file> | Upload an attachment file |
| attachment show <id> | Show attachment details |
| auth setup | Configure OAuth client credentials |
| auth login | Start OAuth login flow |
| auth status | Display OAuth token status |
| auth refresh | Refresh the OAuth access token |
| auth revoke | Revoke OAuth consent and clear tokens |
| profile add <name> | Create a named profile |
| profile list | List all profiles |
| profile show <name> | Show profile details (secrets redacted) |
| profile remove <name> | Remove a named profile |
| profile test | Test credentials |
| completion | Generate shell completion scripts |
Global Options
| Option | Description |
| ----------------------- | --------------------------------------------- |
| -p, --profile <name> | Configuration profile to use |
| -o, --output <format> | Output format: table, json, yaml, csv |
| --verbose | Enable verbose logging |
| --debug | Enable debug logging |
| --page <number> | Page number for paginated results |
| --per-page <number> | Items per page |
| --no-paginate | Disable auto-pagination |
Programmatic Usage
import { createProgram } from "@qontoctl/cli";
const program = createProgram();
await program.parseAsync(process.argv);Requirements
- Node.js >= 24
License
AGPL-3.0-only — For commercial licensing, contact the maintainer.
