jaz-clio 4.34.3 → 4.34.4
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 +1 -1
- package/assets/skills/api/SKILL.md +4 -2
- package/assets/skills/api/references/full-api-surface.md +1 -0
- package/assets/skills/cli/SKILL.md +1 -1
- package/assets/skills/cli/references/command-catalog.md +1 -1
- package/assets/skills/conversion/SKILL.md +1 -1
- package/assets/skills/jobs/SKILL.md +1 -1
- package/assets/skills/transaction-recipes/SKILL.md +1 -1
- package/dist/commands/reports.js +5 -1
- package/dist/core/api/reports.js +3 -0
- package/dist/core/registry/tools.js +10 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -235,7 +235,7 @@ Every command supports `--json` for structured output — ideal for piping to ot
|
|
|
235
235
|
|
|
236
236
|
## MCP Server
|
|
237
237
|
|
|
238
|
-
Expose all
|
|
238
|
+
Expose all 241 CLI tools to AI coding and coworking agents via the Model Context Protocol (MCP). The server runs locally on your machine — no cloud, no ports. API calls go directly from your machine to the Jaz API.
|
|
239
239
|
|
|
240
240
|
**Claude Code:**
|
|
241
241
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: jaz-api
|
|
3
|
-
version: 4.34.
|
|
3
|
+
version: 4.34.4
|
|
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, 117 production gotchas, error
|
|
@@ -117,8 +117,10 @@ You are working with the **Jaz REST API** — the accounting platform backend. A
|
|
|
117
117
|
| AR/AP summary | `startDate`, `endDate` |
|
|
118
118
|
| Bank balance summary | `primarySnapshotDate` |
|
|
119
119
|
| Equity movement | `primarySnapshotStartDate`, `primarySnapshotEndDate` |
|
|
120
|
+
| Ledger highlights | *(none — simple GET)* |
|
|
120
121
|
|
|
121
|
-
37. **
|
|
122
|
+
37. **Ledger highlights is a simple GET** — `GET /api/v1/ledger/highlights` returns org-wide GL summary metadata: transaction counts by type, date range, active accounts/currencies, cross-currency flag, and dynamic FX types. No parameters. Response dates are epoch ms (see Rule 52).
|
|
123
|
+
37a. **Data exports use simpler field names**: P&L export uses `startDate`/`endDate` (NOT `primarySnapshotDate`). AR/AP export uses `endDate`.
|
|
122
124
|
|
|
123
125
|
### Pagination
|
|
124
126
|
38. **All list/search endpoints use `limit`/`offset` pagination** — NOT `page`/`size`. Default limit=100, offset=0. Max limit=1000, max offset=65536. `page`/`size` params are silently ignored. Response shape: `{ totalPages, totalElements, truncated, data: [...] }`. When `truncated: true`, a `_meta: { fetchedRows, maxRows }` field explains why (offset cap or `--max-rows` soft cap — default 10,000). Use `--max-rows <n>` to override. Always check `truncated` before assuming the full dataset was returned.
|
|
@@ -349,6 +349,7 @@
|
|
|
349
349
|
| POST | `/generate-reports/fixed-assets-summary` |
|
|
350
350
|
| POST | `/generate-reports/fixed-assets-recon-summary` |
|
|
351
351
|
| POST | `/generate-reports/templated-*` | Templated versions of above |
|
|
352
|
+
| GET | `/ledger/highlights` | GL summary metadata (counts, date range, currencies) |
|
|
352
353
|
|
|
353
354
|
### Data Exports (downloadable)
|
|
354
355
|
| Method | Path |
|
|
@@ -297,7 +297,7 @@ Dynamic strings in schedulers: `{{Day}}`, `{{Date}}`, `{{Date+X}}`, `{{DateRange
|
|
|
297
297
|
clio reports generate <type> [flags]
|
|
298
298
|
```
|
|
299
299
|
|
|
300
|
-
Types: `trial-balance`, `balance-sheet`, `profit-loss`, `cashflow`, `aged-ar`, `aged-ap`, `cash-balance`, `general-ledger`, `vat-ledger`, `equity-movement`, `bank-balance-summary`, `bank-recon-summary`, `bank-recon-details`, `fa-summary`, `fa-recon-summary`, `ar-report`
|
|
300
|
+
Types: `trial-balance`, `balance-sheet`, `profit-loss`, `cashflow`, `aged-ar`, `aged-ap`, `cash-balance`, `general-ledger`, `vat-ledger`, `equity-movement`, `bank-balance-summary`, `bank-recon-summary`, `bank-recon-details`, `fa-summary`, `fa-recon-summary`, `ar-report`, `ledger-highlights`
|
|
301
301
|
|
|
302
302
|
| Flag | Purpose |
|
|
303
303
|
|------|---------|
|
package/dist/commands/reports.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import chalk from 'chalk';
|
|
2
|
-
import { generateTrialBalance, generateBalanceSheet, generateProfitAndLoss, generateCashflow, generateArSummary, generateApSummary, generateCashBalance, generateGeneralLedger, generateVatLedger, generateEquityMovement, generateBankBalanceSummary, generateBankReconSummary, generateBankReconDetails, generateFaSummary, generateFaReconSummary, generateArReport, } from '../core/api/reports.js';
|
|
2
|
+
import { generateTrialBalance, generateBalanceSheet, generateProfitAndLoss, generateCashflow, generateArSummary, generateApSummary, generateCashBalance, generateGeneralLedger, generateVatLedger, generateEquityMovement, generateBankBalanceSummary, generateBankReconSummary, generateBankReconDetails, generateFaSummary, generateFaReconSummary, generateArReport, getLedgerHighlights, } from '../core/api/reports.js';
|
|
3
3
|
import { messageToPdf } from '../core/api/message-pdf.js';
|
|
4
4
|
import { apiAction } from './api-action.js';
|
|
5
5
|
import { todayLocal } from './parsers.js';
|
|
@@ -9,6 +9,7 @@ const REPORT_TYPES = [
|
|
|
9
9
|
'general-ledger', 'vat-ledger', 'equity-movement',
|
|
10
10
|
'bank-balance-summary', 'bank-recon-summary', 'bank-recon-details',
|
|
11
11
|
'fa-summary', 'fa-recon-summary', 'ar-report',
|
|
12
|
+
'ledger-highlights',
|
|
12
13
|
];
|
|
13
14
|
const GL_GROUP_BY = ['ACCOUNT', 'TRANSACTION', 'CAPSULE'];
|
|
14
15
|
export function registerReportsCommand(program) {
|
|
@@ -157,6 +158,9 @@ export function registerReportsCommand(program) {
|
|
|
157
158
|
endDate: opts.to ?? today,
|
|
158
159
|
});
|
|
159
160
|
break;
|
|
161
|
+
case 'ledger-highlights':
|
|
162
|
+
result = await getLedgerHighlights(client);
|
|
163
|
+
break;
|
|
160
164
|
}
|
|
161
165
|
if (opts.json) {
|
|
162
166
|
console.log(JSON.stringify(result.data, null, 2));
|
package/dist/core/api/reports.js
CHANGED
|
@@ -46,3 +46,6 @@ export async function generateFaReconSummary(client, data) {
|
|
|
46
46
|
export async function generateArReport(client, data) {
|
|
47
47
|
return client.post('/api/v1/generate-reports/ar-report', data);
|
|
48
48
|
}
|
|
49
|
+
export async function getLedgerHighlights(client) {
|
|
50
|
+
return client.get('/api/v1/ledger/highlights');
|
|
51
|
+
}
|
|
@@ -5,7 +5,7 @@ import { listContacts, searchContacts, getContact, createContact, updateContact,
|
|
|
5
5
|
import { listInvoices, searchInvoices, getInvoice, createInvoice, updateInvoice, deleteInvoice, createInvoicePayment, createScheduledInvoice, finalizeInvoice, applyCreditsToInvoice, downloadInvoicePdf, listInvoicePayments, listInvoiceCredits, reverseInvoiceCredit, } from '../api/invoices.js';
|
|
6
6
|
import { listBills, searchBills, getBill, createBill, updateBill, deleteBill, createBillPayment, createScheduledBill, finalizeBill, applyCreditsToBill, listBillPayments, listBillCredits, reverseBillCredit, } from '../api/bills.js';
|
|
7
7
|
import { listJournals, searchJournals, getJournal, createJournal, deleteJournal, updateJournal, createScheduledJournal, } from '../api/journals.js';
|
|
8
|
-
import { generateTrialBalance, generateBalanceSheet, generateProfitAndLoss, generateCashflow, generateArSummary, generateApSummary, generateCashBalance, generateGeneralLedger, generateVatLedger, generateEquityMovement, generateBankBalanceSummary, generateBankReconSummary, generateBankReconDetails, generateFaSummary, generateFaReconSummary, generateArReport, } from '../api/reports.js';
|
|
8
|
+
import { generateTrialBalance, generateBalanceSheet, generateProfitAndLoss, generateCashflow, generateArSummary, generateApSummary, generateCashBalance, generateGeneralLedger, generateVatLedger, generateEquityMovement, generateBankBalanceSummary, generateBankReconSummary, generateBankReconDetails, generateFaSummary, generateFaReconSummary, generateArReport, getLedgerHighlights, } from '../api/reports.js';
|
|
9
9
|
import { listBankAccounts, addBankRecords, importBankStatement } from '../api/bank.js';
|
|
10
10
|
import { listItems, searchItems, getItem, createItem, updateItem, deleteItem, } from '../api/items.js';
|
|
11
11
|
import { listTags, getTag, searchTags, createTag, updateTag, deleteTag, } from '../api/tags.js';
|
|
@@ -3597,6 +3597,15 @@ Dynamic strings for reference/line item name/notes: {{Day}}, {{Date}}, {{Date+X}
|
|
|
3597
3597
|
readOnly: true,
|
|
3598
3598
|
execute: async (ctx, input) => generateArReport(ctx.client, { endDate: input.endDate }),
|
|
3599
3599
|
},
|
|
3600
|
+
{
|
|
3601
|
+
name: 'get_ledger_highlights',
|
|
3602
|
+
description: 'Get ledger highlights — summary metadata about the org general ledger: transaction counts by type, date range, active accounts, active currencies, and cross-currency detection. No parameters needed.',
|
|
3603
|
+
params: {},
|
|
3604
|
+
required: [],
|
|
3605
|
+
group: 'operational_reports',
|
|
3606
|
+
readOnly: true,
|
|
3607
|
+
execute: async (ctx) => getLedgerHighlights(ctx.client),
|
|
3608
|
+
},
|
|
3600
3609
|
// ══════════════════════════════════════════════════════════════
|
|
3601
3610
|
// ── Contact Groups ─────────────────────────────────────────
|
|
3602
3611
|
// ══════════════════════════════════════════════════════════════
|