incwo CLI

██╗███╗   ██╗ ██████╗██╗    ██╗ ██████╗      ██████╗██╗     ██╗
██║████╗  ██║██╔════╝██║    ██║██╔═══██╗    ██╔════╝██║     ██║
██║██╔██╗ ██║██║     ██║ █╗ ██║██║   ██║    ██║     ██║     ██║
██║██║╚██╗██║██║     ██║███╗██║██║   ██║    ██║     ██║     ██║
██║██║ ╚████║╚██████╗╚███╔███╔╝╚██████╔╝    ╚██████╗███████╗██║
╚═╝╚═╝  ╚═══╝ ╚═════╝ ╚══╝╚══╝  ╚═════╝      ╚═════╝╚══════╝╚═╝

  Your CRM/ERP · incwo.com

Command-line interface for incwo CRM/ERP.

Access all your incwo data from the terminal — list, search, and inspect any object across CRM, sales, invoicing, inventory, projects, HR, and POS.

Installation

npm install -g incwo-cli

Or from source:

git clone https://github.com/incwo/incwo-cli
cd incwo-cli
npm install
npm run build
npm link

Setup

incwo config

You'll be prompted to configure your server — two modes available:

Option A — full endpoint URL:

Endpoint URL: mycompany.incwo.com/12345

Option B — shard + business file ID separately:

Shard (leave empty for www.incwo.com): mycompany
Business file ID: 12345

Then your login and password. Config is saved to ~/.incwo/config.json.

API access must be enabled in your incwo account under Settings → Users → APIs.

Usage

Every resource supports two sub-commands: list and get.

incwo <resource> list [options]
incwo <resource> get <id>

Common options

| Flag | Description | |------|-------------| | --search <q> | Full-text search | | --filter <json> | ufilters JSON (see below) | | --page <n> | Page number (default: 1) | | --from <date> | Start date, YYYY-MM-DD | | --to <date> | End date, YYYY-MM-DD |

Filtering

# Exact match
incwo contacts list --filter '{"last_name":{"eq":"Dupont"}}'

# Contains
incwo firms list --filter '{"name":{"like":"Acme"}}'

# Unpaid invoices
incwo bill_sheets list --filter '{"balance":{"gt":"0"}}'

Available resources

CRM

| Command | Description | |---------|-------------| | contacts | Contacts (people) | | firms | Companies / organisations | | leads | Sales opportunities | | contact_items | Contact details (emails, phones…) | | contact_addresses | Contact addresses | | contact_lists | Contact lists | | missions | Missions |

Sales

| Command | Description | |---------|-------------| | proposal_sheets | Quotes, orders, delivery notes, purchase orders (use --sheet-type) | | bill_sheets | Customer invoices | | emitted_payments | Vendor bills / purchase invoices | | customer_products | Product / service catalog | | customer_product_categories | Product categories | | customer_pricings | Customer pricing rules | | vendor_pricings | Vendor pricing rules | | bank_accounts | Bank accounts | | campaigns | Marketing campaigns |

Inventory

| Command | Description | |---------|-------------| | stock_movements | Stock movements | | serial_numbers | Serial numbers | | serial_lots | Serial lot numbers | | warehouses | Warehouses / depots |

Projects & Time

| Command | Description | |---------|-------------| | projects | Projects | | tasks | Tasks | | timesheets | Timesheets |

HR

| Command | Description | |---------|-------------| | staff_members | Staff members | | expense_sheets | Expense reports | | vacation_requests | Vacation requests | | salary_campaigns | Salary campaigns | | contracts | Contracts | | interviews | HR interviews |

Misc

| Command | Description | |---------|-------------| | notes | Notes | | upload_files | Files / attachments | | custom_labels | Custom labels | | conversations | Conversations / messaging | | webhooks | Configured webhooks | | bookables | Bookable resources | | fleets | Vehicle fleets |

Examples

# List contacts, search by name
incwo contacts list --search "Martin"

# Get a specific invoice
incwo bill_sheets get 1042

# Unpaid invoices since January
incwo bill_sheets list --filter '{"balance":{"gt":"0"}}' --from 2026-01-01

# Quotes from Q1
incwo proposal_sheets list --sheet-type quote --from 2026-01-01 --to 2026-03-31

# Tasks assigned to a project
incwo tasks list --filter '{"project_id":{"eq":"99"}}'

# Stock movements this month
incwo stock_movements list --from 2026-04-01

Rate limits

incwo API: 8 req/s · 240 req/min · 4 800 req/h

License

MIT