jaz-clio 4.34.1 → 4.34.3

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.
@@ -1,7 +1,14 @@
1
1
  ---
2
2
  name: jaz-api
3
- version: 4.34.1
4
- description: Complete reference for the Jaz REST API — the accounting platform backend. Use this skill whenever building, modifying, debugging, or extending any code that calls the API — including API clients, integrations, data seeding, test data, or new endpoint work. Contains every field name, response shape, error, gotcha, and edge case discovered through live production testing.
3
+ version: 4.34.3
4
+ description: >-
5
+ Use this skill whenever you call, debug, or review code that touches the Jaz
6
+ REST API. Covers field names, response shapes, 117 production gotchas, error
7
+ recovery (422/400/404/500), search filters, pagination, and edge cases for
8
+ every endpoint — invoices, bills, credit notes, journals, cash entries,
9
+ payments, contacts, CoA, items, tax profiles, bank records, fixed assets,
10
+ schedulers, subscriptions, attachments, and Jaz Magic extraction. Also use
11
+ when building API clients, seeding test data, or adding new endpoint support.
5
12
  license: MIT
6
13
  compatibility: Requires Jaz API key (x-jk-api-key header). Works with Claude Code, Google Antigravity, OpenAI Codex, GitHub Copilot, Cursor, and any agent that reads markdown.
7
14
  ---
@@ -339,16 +346,6 @@ Supports `--json` for structured output. 186 articles across 20 sections. Automa
339
346
  - Use `clio help-center` when you need specific answers (returns only relevant articles, saves context)
340
347
  - Read `help-center-mirror/*.md` directly only when you need to scan an entire section comprehensively
341
348
 
342
- ## DX Overhaul (Implemented)
343
-
344
- The backend DX overhaul is live. Key improvements now available:
345
- - **Request-side field aliases**: `name` → `tagName`/`internalName`, `issueDate` → `valueDate`, `bankAccountResourceId` → `accountResourceId`, and more. Both canonical and alias names are accepted.
346
- - **Response-side aliases**: Tags, items, and custom fields return `name` alongside canonical field names (`tagName`, `internalName`, `customFieldName`).
347
- - **`saveAsDraft` defaults to `false`**: Omitting it creates a finalized transaction. No longer required on POST.
348
- - **`POST /items/search` available**: Advanced search with filters now works for items.
349
- - **NormalizeToArray**: Flat payment/refund/credit objects are auto-wrapped into arrays. Array format is still recommended.
350
- - **Nil-safe deletes**: Delete endpoints return 404 (not 500) when resource not found.
351
-
352
349
  ## Recommended Client Patterns
353
350
 
354
351
  - **Starting from an attachment?** → Use Jaz Magic (`POST /magic/createBusinessTransactionFromAttachment`). Never manually parse a PDF/JPG to construct `POST /invoices` or `POST /bills` — let the extraction & autofill pipeline handle it.
@@ -361,3 +358,10 @@ The backend DX overhaul is live. Key improvements now available:
361
358
  - **Scheduled invoices/bills**: Wrap as `{ status, startDate, endDate, repeat, invoice/bill: { reference, valueDate, dueDate, contactResourceId, lineItems, saveAsDraft: false } }`. `reference` is required.
362
359
  - **Scheduled journals**: Flat: `{ status, startDate, endDate, repeat, valueDate, schedulerEntries, reference }`. `valueDate` is required.
363
360
  - **FX currency (invoices, bills, credit notes, AND journals)**: `currency: { sourceCurrency: "USD" }` (auto-fetches platform rate) or `currency: { sourceCurrency: "USD", exchangeRate: 1.35 }` (custom rate). Same object form on all transaction types. **Never use `currencyCode` string** — silently ignored.
361
+
362
+ ## See Also
363
+
364
+ - **jaz-recipes** — 16 IFRS-compliant transaction recipes with journal entries, capsules, and calculators
365
+ - **jaz-jobs** — 12 accounting job playbooks (month-end close, bank recon, GST/VAT filing, etc.)
366
+ - **jaz-conversion** — Data migration workflows from Xero, QuickBooks, Sage, MYOB, and Excel
367
+ - **jaz-cli** — CLI command reference, auth, output formats, pagination, and workflow patterns
@@ -170,30 +170,38 @@ Source: https://help.jaz.ai/en/articles/9941717-managing-bank-statements
170
170
 
171
171
  - You can upload your statements in a CSV file format or as a PDF.
172
172
 
173
- **Q3. Will Jaz let me configure the columns from the statement PDF file?**
173
+ **Q3. Can I import password protected bank statement PDFs?**
174
+
175
+ - Yes. To import a password-protected bank statement, include the password in the file name using this format:
176
+ - Filename__pw__password.pdf
177
+ - <filename>+<double underscore>+<pw>+<double underscore>+<file password>
178
+ - Example: bankStam3nt__pw__filepass001.pdf
179
+ - Note: Make sure there are two underscores before and after pw and do not include the “<>” – brackets.
180
+
181
+ **Q4. Will Jaz let me configure the columns from the statement PDF file?**
174
182
 
175
183
  - Yes, Jaz will extract the columns from the uploaded PDF file and let you assign them to fields in Jaz.
176
184
 
177
- **Q4. What if there are errors in the uploaded PDF statement file?**
185
+ **Q5. What if there are errors in the uploaded PDF statement file?**
178
186
 
179
187
  - Jaz will extract statement lines from the uploaded PDF file and create a downloadable CSV file for reviewing discrepancies, if any.
180
188
  - Alternatively, you can still import the statement lines with no errors. Jaz will ignore the ones with issues and import the rest.
181
189
 
182
- **Q5. Can I import a statement in one currency into a bank account that uses a different currency?**
190
+ **Q6. Can I import a statement in one currency into a bank account that uses a different currency?**
183
191
 
184
192
  - The final statement amounts that get recorded in Jaz will be in the currency of the bank account in Jaz, not the currency of the amounts in the bank statement.
185
193
  - Jaz will not do any automatic conversion between the different currencies, and will solely take the numerical amounts as is.
186
194
  - For example, a statement line that has 50 USD as its amount will be automatically recorded in Jaz as 50 USD, when importing to a USD bank account, or 50 SGD if importing into a SGD bank account.
187
195
 
188
- **Q6. Can I review the statement lines before they are imported into the system?**
196
+ **Q7. Can I review the statement lines before they are imported into the system?**
189
197
 
190
198
  - Yes, Jaz will let you review all the statement lines before they are imported into your bank account on Jaz.
191
199
 
192
- **Q7. Can I upload multiple bank statements?**
200
+ **Q8. Can I upload multiple bank statements?**
193
201
 
194
202
  - Yes, you can upload up to 12 files at a time.
195
203
 
196
- **Q8. Can I manage my uploaded statements?**
204
+ **Q9. Can I manage my uploaded statements?**
197
205
 
198
206
  - To manage your uploaded statements, utilize the Overview tab:
199
207
  - Pending – configure and review imported statements
@@ -202,11 +210,11 @@ Source: https://help.jaz.ai/en/articles/9941717-managing-bank-statements
202
210
  - Deleted – view and restore deleted files
203
211
  - *Note: Reconciled files cannot be deleted.*
204
212
 
205
- **Q9. Can I delete a bank statement line?**
213
+ **Q10. Can I delete a bank statement line?**
206
214
 
207
215
  - Yes, you can delete a bank statement line individually via the 3-dot menu on the statement line OR you can bulk-delete by selecting multiple statement lines at once from both reconciled & unreconciled tabs.
208
216
 
209
- **Q10. Is it possible to retrieve a deleted statement line?**
217
+ **Q11. Is it possible to retrieve a deleted statement line?**
210
218
 
211
219
  - Yes, you can. Under the **Deleted**tab for the bank account, you will find a list of deleted statement lines.
212
220
  - Undelete individual statement line OR bulk undelete to move it back to the Unreconciled tab.
@@ -36,6 +36,44 @@ Source: https://help.jaz.ai/en/articles/9104226-apply-supplier-credit
36
36
 
37
37
  ---
38
38
 
39
+ ### Apply Supplier Credit
40
+ Source: https://help.jaz.ai/en/articles/9104226-apply-supplier-credit
41
+
42
+ **Q1. Can I apply a draft supplier credit note to a bill?**
43
+
44
+ - No, supplier credit notes must be active before they can be applied.
45
+
46
+ **Q2. Can I apply a supplier credit note of a different currency than the bill?**
47
+
48
+ - If you would like to apply a supplier credit note to a bill, the supplier credit note must be in the same currency that the bill was created in.
49
+ - For example, a bill that was created in USD can only make use of supplier credits that were also credited in USD.
50
+
51
+ **Q3. Can I partially apply a supplier credit note to a bill?**
52
+
53
+ - Yes, you do not have to use the full amount in the supplier credit note.
54
+ - You can adjust this via the **Amount to Apply**field. Enter an amount smaller than the supplier credit note amount to only apply the credit note partially.
55
+
56
+ **Q4. Can I partially pay a bill using a supplier credit only?**
57
+
58
+ - Yes, supplier credits do not have to cover the entire bill amount. You can apply as much of a supplier credit note as you would like to a bill.
59
+ - The rest of the bill can be paid with other payment methods.
60
+
61
+ **Q5. Can I remove an applied supplier credit note from a bill?**
62
+
63
+ - Yes, you can remove an applied supplier credit note on a bill by updating the applied amount to 0.
64
+ - Change the **Amount to Apply**amount to 0 on the **Edit Applied Credit**modal. This will remove all applied credit from the bill.
65
+
66
+ **Q6. Does applying or removing a supplier credit note have an impact on my financial reports?**
67
+
68
+ - There will be no further impact on your financial reports.
69
+ - This is because the credits would have been accounted for during creation, appearing as a debit to Accounts Payable, and a credit to transaction account used on the bill.
70
+ - The offset value date aligns with the later of the transaction date or the credit note date, ensuring accurate reporting across time zones. For example:
71
+ - Transaction Date: 1 Jan 2025
72
+ - Credit Note Date: 5 Jan 2025
73
+ - Offset Value Date: 5 Jan 2025
74
+
75
+ ---
76
+
39
77
  ### Bill Approval Records
40
78
  Source: https://help.jaz.ai/en/articles/9115415-bill-approval-records
41
79
 
@@ -114,52 +152,6 @@ Source: https://help.jaz.ai/en/articles/9104231-bill-receipts
114
152
 
115
153
  ---
116
154
 
117
- ### Draft Bills & Payments
118
- Source: https://help.jaz.ai/en/articles/9104224-draft-bills-payments
119
-
120
- **Q1. Can I save a bill as a draft?**
121
-
122
- - Yes, a bill can be saved as a draft even if all the mandatory fields are not filled.
123
-
124
- **Q2. How can I convert a draft bill to an active one?**
125
-
126
- - Any draft bill can be converted to active only after all the mandatory fields are filled.
127
-
128
- **Q3. Can I save bill payment records as drafts?**
129
-
130
- - Similar to bill records, bill payments can also be saved as a draft.
131
-
132
- **Q4. How can I convert draft payment records to active ones?**
133
-
134
- - For bills, any draft payments are converted only if the bill is also converted to active.
135
- - Hence, to record the payment, the bill must be converted to active status.
136
-
137
- **Q5. Can I delete a draft bill?**
138
-
139
- - Yes, you can delete a draft bill. If the bill had a draft payment linked, it will also be deleted.
140
-
141
- **Q6. Can I delete a draft bill payment?**
142
-
143
- - Similar to draft bills, draft bill payments can also be deleted.
144
-
145
- **Q7. Do draft bills affect my financial reports?**
146
-
147
- - No, it does not. Financial reports are only affected once the bills are active.
148
-
149
- **Q8. Do draft bill payments affect my financial reports?**
150
-
151
- - No, it does not. Financial reports are only affected once the payments are active.
152
-
153
- **Q9. Can I create a non-base currency draft bill?**
154
-
155
- - Yes, the currency setting on a bill does not affect the ability to save it as a draft.
156
-
157
- **Q10. Can I create a non-base currency draft bill payment?**
158
-
159
- - Yes, you can save a bill payment as a draft even if it is in non-base currency.
160
-
161
- ---
162
-
163
155
  ### Import Bills
164
156
  Source: https://help.jaz.ai/en/articles/9104236-import-bills
165
157