jaz-clio 5.20.30 → 5.20.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/assets/skills/api/SKILL.md +2 -2
- package/assets/skills/api/references/claims.md +55 -1
- package/assets/skills/cli/SKILL.md +3 -3
- package/assets/skills/conversion/SKILL.md +1 -1
- package/assets/skills/jaz-pseudo-sql/SKILL.md +1 -1
- package/assets/skills/jobs/SKILL.md +1 -1
- package/assets/skills/transaction-recipes/SKILL.md +1 -1
- package/assets/templates/platform-rules/jaz-agent-rules.md +1 -1
- package/cli.mjs +457 -457
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
<p align="center">
|
|
4
4
|
<a href="https://www.npmjs.com/package/jaz-clio"><img src="https://img.shields.io/npm/v/jaz-clio?style=for-the-badge&logo=npm" alt="npm"></a>
|
|
5
5
|
<a href="https://www.npmjs.com/package/jaz-clio"><img src="https://img.shields.io/npm/dm/jaz-clio?style=for-the-badge&label=downloads" alt="npm downloads"></a>
|
|
6
|
-
<img src="https://img.shields.io/badge/tools-
|
|
6
|
+
<img src="https://img.shields.io/badge/tools-340-blue?style=for-the-badge" alt="340 tools">
|
|
7
7
|
<a href="https://github.com/teamtinvio/jaz-ai/blob/main/LICENSE"><img src="https://img.shields.io/github/license/teamtinvio/jaz-ai?style=for-the-badge&color=green" alt="License"></a>
|
|
8
8
|
</p>
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
340 tools. 64 command groups. 13 calculators. 12 job playbooks. 158 API rules. 16 IFRS recipes.
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
13
|
npm install -g jaz-clio
|
|
@@ -18,8 +18,8 @@ Requires **Node.js 18+** ([nodejs.org](https://nodejs.org)). Also fully compatib
|
|
|
18
18
|
## Contents
|
|
19
19
|
|
|
20
20
|
- [Three Ways In](#three-ways-in) · CLI, MCP, Skills
|
|
21
|
-
- [CLI](#cli) ·
|
|
22
|
-
- [MCP Server](#mcp-server) ·
|
|
21
|
+
- [CLI](#cli) · 64 command groups
|
|
22
|
+
- [MCP Server](#mcp-server) · 340 tools for AI agents
|
|
23
23
|
- [Skills](#skills) · Teach any AI the Jaz API
|
|
24
24
|
- [Setup](#setup) · Auth, multi-org, automation
|
|
25
25
|
- [Semantic help-center search](#help-center-semantic-search-optional) · Optional OpenAI-backed retrieval
|
|
@@ -47,13 +47,13 @@ clio invoices search --query 'status:unpaid AND $500+' # Structured per-entity
|
|
|
47
47
|
clio invoices search --query 'status:unpaid' --view lean # Compact summary rows (id + key fields), then drill in with get
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
64 command groups. 16 report types. 13 calculators. 12 job playbooks. Every command supports `--json`. Run `clio --help` for the full list.
|
|
51
51
|
|
|
52
52
|
---
|
|
53
53
|
|
|
54
54
|
## MCP Server
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
340 tools, available to any AI agent that speaks MCP. Runs locally: no cloud, no ports.
|
|
57
57
|
|
|
58
58
|
> **No install at all?** Claude.ai, ChatGPT, Cowork, and Microsoft Copilot Studio can use Jaz via the **hosted connector**: add `https://mcp.jaz.ai/mcp` as a custom connector (Claude/ChatGPT) or MCP tool (Copilot Studio) and sign in (OAuth, no key). The local setup below is for terminal use, scripting, and editors that run MCP servers as local processes.
|
|
59
59
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: jaz-api
|
|
3
|
-
version: 5.20.
|
|
3
|
+
version: 5.20.31
|
|
4
4
|
description: >-
|
|
5
5
|
Use this skill whenever you call, debug, or review code that touches the Jaz
|
|
6
6
|
REST API. Covers field names, response shapes, 158 production gotchas, error
|
|
@@ -31,7 +31,7 @@ The rest of this skill — field names, gotchas, error catalog, dependency order
|
|
|
31
31
|
|
|
32
32
|
**Core fundamentals (read first, every integration):** Identifiers & Dates 1–3; Names & Fields 9–13; Transaction Creation 14–16; Chart of Accounts 17–22; Payments / Cross-Currency 4–8; Journals & Cash 23–26; Credit Notes & Refunds 27–28; Reports 36–37; Tax Profile Scoping 100; Transaction References 104; Draft Finalization Pipeline 81–88; Jaz Magic / PDF-JPG 57–63; Currency Rates 39, 49, 105; Withholding Tax 45, 98.
|
|
33
33
|
|
|
34
|
-
**Integration depth (API clients, pipelines, batch jobs, MCP/CLI):** Bulk Upsert (Items/Contacts/Rates); Background Jobs (filter `resourceId` not `jobId`); Export Records; Pagination (38); Search & Filter (50–56); Response Shape Gotchas (66–73); Cash Entry Response Shape (74–77); Entity Resolution (78–80); Bank Rules (89–90c); Fixed Assets (91–92c); Subscriptions & Scheduled (93–94); niche endpoints (95–102); Journals balance (103); Quick Fix (107, 111); TTB (108); Dynamic Strings (109–110); Sub-Resource Shapes (112); Nano-Classifier (113); Scheduler Asymmetry (114); Payment Record CRUD (115–117); Bulk Upserts transactions (118–122); Reconciliation write-side (123–127); Drafts lifecycle (128–135); Orders — Sale Quotes / Sale Orders / Purchase Requests / Purchase Orders (`references/orders.md`);
|
|
34
|
+
**Integration depth (API clients, pipelines, batch jobs, MCP/CLI):** Bulk Upsert (Items/Contacts/Rates); Background Jobs (filter `resourceId` not `jobId`); Export Records; Pagination (38); Search & Filter (50–56); Response Shape Gotchas (66–73); Cash Entry Response Shape (74–77); Entity Resolution (78–80); Bank Rules (89–90c); Fixed Assets (91–92c); Subscriptions & Scheduled (93–94); niche endpoints (95–102); Journals balance (103); Quick Fix (107, 111); TTB (108); Dynamic Strings (109–110); Sub-Resource Shapes (112); Nano-Classifier (113); Scheduler Asymmetry (114); Payment Record CRUD (115–117); Bulk Upserts transactions (118–122); Reconciliation write-side (123–127); Drafts lifecycle (128–135); Orders — Sale Quotes / Sale Orders / Purchase Requests / Purchase Orders (`references/orders.md`); Claims — records / lifecycle / bulk + Claim Settings (`references/claims.md`).
|
|
35
35
|
|
|
36
36
|
## When to Use This Skill
|
|
37
37
|
|
|
@@ -1,4 +1,58 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Claims — Records, Lifecycle, Bulk + Claim Settings
|
|
2
|
+
|
|
3
|
+
The employee-expense **Claims** feature. This reference covers the **claim records**
|
|
4
|
+
(search / edit / lifecycle / bulk) and the **Claim Settings** master data (types /
|
|
5
|
+
profiles / posting rules). Claim → journal conversion + employee payouts are a
|
|
6
|
+
separate surface.
|
|
7
|
+
|
|
8
|
+
## Claim records (`claims` + `claim_processing` namespaces)
|
|
9
|
+
|
|
10
|
+
CLI: `clio claims …`. **Claims have no bare list or create** — a claim is born DRAFT
|
|
11
|
+
via document attachment or conversion, then mutated. List = `search_claims`.
|
|
12
|
+
|
|
13
|
+
### Status flow (server-enforced — surface the 422, don't pre-validate)
|
|
14
|
+
|
|
15
|
+
`DRAFT → SUBMITTED → APPROVED → CONVERTED` (CONVERTED = the customer-facing
|
|
16
|
+
**"Processed"**), with `REJECTED` / `CANCELLED` branches.
|
|
17
|
+
|
|
18
|
+
| Action | Tool | Legal from | Body |
|
|
19
|
+
|--------|------|-----------|------|
|
|
20
|
+
| Edit | `update_claim` | DRAFT | partial; `claimItems` non-empty REPLACES all, `[]` clears |
|
|
21
|
+
| Submit | `submit_claim` (or `update_claim` saveAsDraft=false) | DRAFT | none |
|
|
22
|
+
| Approve | `approve_claim` | SUBMITTED | none |
|
|
23
|
+
| Reject | `reject_claim` | SUBMITTED / APPROVED | `rejectionReason` (1-1000) |
|
|
24
|
+
| Cancel | `cancel_claim` | DRAFT / SUBMITTED | `cancellationReason` (1-1000) |
|
|
25
|
+
| Unpost | `unpost_claim` | CONVERTED | none (reverses conversion → APPROVED) |
|
|
26
|
+
| Delete | `delete_claim` | DRAFT / REJECTED / CANCELLED | none |
|
|
27
|
+
|
|
28
|
+
Single lifecycle ops are **SYNC** and return the updated claim. Illegal transitions
|
|
29
|
+
return `422` with a clear code, e.g. `CLAIM_NOT_SUBMITTABLE` ("Only DRAFT claims can
|
|
30
|
+
be submitted (current status: APPROVED)"). Don't pre-check — call and surface the error.
|
|
31
|
+
|
|
32
|
+
### Bulk actions are ASYNC
|
|
33
|
+
|
|
34
|
+
`bulk_submit / approve / reject / cancel / delete_claims` (max 500 ids) return **HTTP 202**
|
|
35
|
+
+ a job handle `{ jobId, subscriptionFBPath, status: "QUEUED", totalRecords, totalChunks }`.
|
|
36
|
+
Per-item processing happens in the background — **poll `search_background_jobs` by `jobId`**
|
|
37
|
+
for results (a queued job doesn't pre-validate item state). bulk_reject/cancel take one
|
|
38
|
+
shared reason for the batch.
|
|
39
|
+
|
|
40
|
+
### Update semantics (verified live)
|
|
41
|
+
|
|
42
|
+
`update_claim` is **partial**: omitted fields are unchanged; no GET-merge needed for
|
|
43
|
+
scalars. `claimItems` is a **full replacement set** (non-empty replaces every line,
|
|
44
|
+
`[]` clears, omit = no change). Attachments are per-row upsert (resourceId = edit, omit =
|
|
45
|
+
add, `deleted:true` = remove); `delete_claim_attachment` removes one and returns the claim.
|
|
46
|
+
`contactResourceId` and `vendorName` are mutually exclusive.
|
|
47
|
+
|
|
48
|
+
### Pickers (bare arrays)
|
|
49
|
+
|
|
50
|
+
`get_claim_tracking_tags` and `get_claim_custom_field_values` return a **bare array**,
|
|
51
|
+
not a `{data}` envelope.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Claim Settings (`claim_settings` + `posting_rules` namespaces)
|
|
2
56
|
|
|
3
57
|
Configuration for the employee-expense **Claims** feature (Settings → Claim Settings).
|
|
4
58
|
Three master-data entities, each with full CRUD + search. Employees, claims, and
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: jaz-cli
|
|
3
|
-
version: 5.20.
|
|
3
|
+
version: 5.20.31
|
|
4
4
|
description: >-
|
|
5
5
|
Use this skill when running Clio CLI commands, building shell scripts with
|
|
6
6
|
Clio, debugging auth issues, understanding --json output, paginating results,
|
|
@@ -8,7 +8,7 @@ description: >-
|
|
|
8
8
|
command groups, auth precedence, output formats, entity resolution, and common
|
|
9
9
|
workflow patterns. Also use when the user asks how to use clio, what commands
|
|
10
10
|
are available, or how to automate accounting tasks from the command line.
|
|
11
|
-
Covers all
|
|
11
|
+
Covers all 64 command groups and 340 tools.
|
|
12
12
|
license: MIT
|
|
13
13
|
compatibility: Requires Node.js >= 18.0.0. Install via npm install -g jaz-clio.
|
|
14
14
|
---
|
|
@@ -17,7 +17,7 @@ compatibility: Requires Node.js >= 18.0.0. Install via npm install -g jaz-clio.
|
|
|
17
17
|
|
|
18
18
|
> **Audience note:** for power users and CI/automation. Load this skill only when you're scripting from a terminal, building shell pipelines, or debugging from `clio --json` output. For day-to-day accounting inside Claude Desktop / Cowork, the MCP tools cover the common flows without dropping to the CLI.
|
|
19
19
|
|
|
20
|
-
You are working with **Clio** (`jaz-clio`) — the CLI for the Jaz accounting platform.
|
|
20
|
+
You are working with **Clio** (`jaz-clio`) — the CLI for the Jaz accounting platform. 64 command groups, 13 calculators, 12 job blueprints, 340 tools. Also fully compatible with Juan Accounting (same API, same endpoints).
|
|
21
21
|
|
|
22
22
|
## When to Use This Skill
|
|
23
23
|
|
|
@@ -6,7 +6,7 @@ Source of truth lives in the installed skills (`.claude/skills/jaz-*/SKILL.md` o
|
|
|
6
6
|
|
|
7
7
|
## Discovery
|
|
8
8
|
|
|
9
|
-
The Jaz MCP server exposes
|
|
9
|
+
The Jaz MCP server exposes 340 tools across 40 namespaces via 3 meta-tools. **Use the meta-tool flow — never enumerate tools blindly.**
|
|
10
10
|
|
|
11
11
|
1. `search_tools(query)` → top-N tool names + namespaces.
|
|
12
12
|
2. `describe_tools(names)` → full parameter schemas.
|