jaz-clio 5.20.7 → 5.20.9
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/assets/skills/api/SKILL.md +2 -2
- package/assets/skills/api/references/endpoints.md +3 -3
- package/assets/skills/api/references/field-map.md +1 -1
- package/assets/skills/cli/SKILL.md +1 -1
- 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/cli.mjs +110 -110
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: jaz-api
|
|
3
|
-
version: 5.20.
|
|
3
|
+
version: 5.20.9
|
|
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
|
|
@@ -376,7 +376,7 @@ Bills, invoices, and credit notes share identical mandatory field specs. Adding
|
|
|
376
376
|
113. **Nano-classifier API gotchas** — CREATE uses `classes: string[]` (NOT `classNames` or `[{className}]`). `printable: boolean` is required — defaults to `false` (most classifiers are not printable). GET single is double-wrapped: `{data: {data: [...], totalElements, totalPages}}` — extract the first element from the inner paginated response. GET/LIST response returns classes as `[{className, resourceId}]` (objects), while CREATE accepts plain `string[]`.
|
|
377
377
|
|
|
378
378
|
### Scheduler Response Asymmetry
|
|
379
|
-
114. **Scheduler response uses `interval`, not `repeat`** — POST/PUT uses `repeat` field (values: `
|
|
379
|
+
114. **Scheduler response uses `interval`, not `repeat`** — POST/PUT uses `repeat` field (values: `ONE_TIME`, `DAILY`, `WEEKLY`, `MONTHLY`, `YEARLY`; `QUARTERLY` is rejected with 422). GET response returns `interval` field (same values; legacy rows may still show `QUARTERLY`). PUT accepts the full transaction template (`invoice`, `bill`, or journal entries at top level), not just schedule metadata — same structure as POST.
|
|
380
380
|
|
|
381
381
|
### Payment Record CRUD
|
|
382
382
|
115. **Payment record CRUD** — `GET /payments/:resourceId` returns `{data: PaymentRecord}` (wrapped). Payment resourceIds come from invoice/bill GET response → `paymentRecords[].resourceId`. **Cashflow transaction IDs ≠ payment IDs** — don't mix them. `POST /cashflow-transactions/search` returns cashflow IDs, while payment CRUD uses separate payment IDs from the parent document.
|
|
@@ -1353,7 +1353,7 @@ Same but with `"bill"` wrapper instead of `"invoice"`.
|
|
|
1353
1353
|
|
|
1354
1354
|
**CRITICAL notes from live testing**:
|
|
1355
1355
|
- Recurrence field is `repeat` — NOT `frequency` or `interval`. Using `frequency` or `interval` silently defaults to ONE_TIME.
|
|
1356
|
-
- Valid `repeat` values: `"
|
|
1356
|
+
- Valid `repeat` values: `"ONE_TIME"`, `"DAILY"`, `"WEEKLY"`, `"MONTHLY"`, `"YEARLY"` (`"QUARTERLY"` is rejected with 422)
|
|
1357
1357
|
- `saveAsDraft: false` is REQUIRED on the wrapped invoice/bill. Using `saveAsDraft: true` causes `INVALID_SALE_STATUS` (invoices) or `INVALID_PURCHASE_STATUS` (bills).
|
|
1358
1358
|
- Since `saveAsDraft: false`, every line item MUST have `accountResourceId`.
|
|
1359
1359
|
- Response uses `interval` field (not `repeat`): `{ "status": "ACTIVE", "interval": "MONTHLY", ... }`
|
|
@@ -1395,7 +1395,7 @@ Subscriptions auto-generate invoices on schedule with proration support. **Diffe
|
|
|
1395
1395
|
- `proratedConfig` is **REQUIRED** on create, update, and cancel. Omitting it causes 500 (server null pointer).
|
|
1396
1396
|
- `businessTransactionType` is NOT in the OAS — the API ignores it. Don't send it.
|
|
1397
1397
|
- Uses `repeat` + `invoice` wrapper — same structure as scheduled invoices (`POST /scheduled/invoices`).
|
|
1398
|
-
- `repeat`: `"
|
|
1398
|
+
- `repeat`: `"ONE_TIME"`, `"DAILY"`, `"WEEKLY"`, `"MONTHLY"`, `"YEARLY"` (`"QUARTERLY"` is rejected with 422).
|
|
1399
1399
|
- `saveAsDraft: false` is REQUIRED inside the `invoice` wrapper.
|
|
1400
1400
|
- Currency, tax, and account details are the SAME for all items and CANNOT be changed after creation.
|
|
1401
1401
|
- Mid-period cancellations or amount changes auto-generate prorated credit notes.
|
|
@@ -2186,7 +2186,7 @@ Accepts scheduling fields AND the full invoice template (same structure as POST)
|
|
|
2186
2186
|
```json
|
|
2187
2187
|
// Request:
|
|
2188
2188
|
{
|
|
2189
|
-
"repeat": "
|
|
2189
|
+
"repeat": "MONTHLY",
|
|
2190
2190
|
"startDate": "2026-03-01",
|
|
2191
2191
|
"endDate": "2027-03-01",
|
|
2192
2192
|
"invoice": {
|
|
@@ -432,7 +432,7 @@ DELETE → expects "A" (parentEntityResourceId, via /cash-entries/:id)
|
|
|
432
432
|
|
|
433
433
|
| What You'd Guess | Actual API Field | Notes |
|
|
434
434
|
|------------------|-------------------|-------|
|
|
435
|
-
| `frequency` | `repeat` | Creation field. `"
|
|
435
|
+
| `frequency` | `repeat` | Creation field. `"ONE_TIME"`, `"DAILY"`, `"WEEKLY"`, `"MONTHLY"`, `"YEARLY"` (`"QUARTERLY"` rejected, 422). NOT `frequency` or `interval` |
|
|
436
436
|
| `interval` (response) | `interval` | Response field. Shows the recurrence after creation. Different name from creation! |
|
|
437
437
|
| (flat payload) | `{ invoice: {...} }` or `{ bill: {...} }` | Document wrapped in type key |
|
|
438
438
|
| `saveAsDraft: true` | `saveAsDraft: false` | MUST be false — true causes INVALID_SALE_STATUS / INVALID_PURCHASE_STATUS |
|