jaz-clio 5.1.5 → 5.1.7
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 +11 -1
- package/assets/skills/api/help-center-mirror/bills.md +22 -23
- package/assets/skills/api/help-center-mirror/contacts.md +54 -0
- package/assets/skills/api/help-center-mirror/customer-credits.md +34 -9
- package/assets/skills/api/help-center-mirror/fixed-assets.md +22 -0
- package/assets/skills/api/help-center-mirror/help-center-embeddings.json +1 -1
- package/assets/skills/api/help-center-mirror/help-center-index.json +1 -1
- package/assets/skills/api/help-center-mirror/import-data.md +11 -0
- package/assets/skills/api/help-center-mirror/index.md +8 -8
- package/assets/skills/api/help-center-mirror/invoices.md +34 -28
- package/assets/skills/api/help-center-mirror/reports.md +14 -5
- package/assets/skills/api/help-center-mirror/settings.md +47 -135
- package/assets/skills/api/help-center-mirror/supplier-credits.md +21 -7
- package/assets/skills/cli/SKILL.md +1 -1
- package/assets/skills/conversion/SKILL.md +5 -1
- package/assets/skills/jobs/SKILL.md +1 -1
- package/assets/skills/transaction-recipes/SKILL.md +1 -1
- package/cli.mjs +348 -348
- package/help-center-mirror/bills.md +22 -23
- package/help-center-mirror/contacts.md +54 -0
- package/help-center-mirror/customer-credits.md +34 -9
- package/help-center-mirror/fixed-assets.md +22 -0
- package/help-center-mirror/help-center-embeddings.json +1 -1
- package/help-center-mirror/help-center-index.json +1 -1
- package/help-center-mirror/import-data.md +11 -0
- package/help-center-mirror/index.md +8 -8
- package/help-center-mirror/invoices.md +34 -28
- package/help-center-mirror/reports.md +14 -5
- package/help-center-mirror/settings.md +47 -135
- package/help-center-mirror/supplier-credits.md +21 -7
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: jaz-api
|
|
3
|
-
version: 5.1.
|
|
3
|
+
version: 5.1.7
|
|
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
|
|
@@ -17,6 +17,16 @@ compatibility: Requires Jaz API key (x-jk-api-key header). Works with Claude Cod
|
|
|
17
17
|
|
|
18
18
|
You are working with the **Jaz REST API** — the accounting platform backend. Also fully compatible with Juan Accounting (same API, same endpoints).
|
|
19
19
|
|
|
20
|
+
## Pick the right invocation path first
|
|
21
|
+
|
|
22
|
+
Before touching this skill's HTTP details, check what's actually available:
|
|
23
|
+
|
|
24
|
+
- **Running inside an MCP host (Claude Desktop, Cowork)**: use the MCP tools (`execute_tool` with `create_invoice`, `list_bills`, etc.). Do not write direct HTTP. The MCP server handles auth, retries, and field shape for you.
|
|
25
|
+
- **Running Claude Code with the `jaz-clio` CLI**: use the CLI commands (`clio invoices list --json`, etc.). Same code path, structured output.
|
|
26
|
+
- **No agent surface, raw integration**: write HTTP calls per the endpoints catalog below.
|
|
27
|
+
|
|
28
|
+
The rest of this skill — field names, gotchas, error catalog, dependency order, search filter syntax — applies regardless of invocation path. Read it for *context*, not for HTTP-call construction unless you're in the third bucket.
|
|
29
|
+
|
|
20
30
|
## When to Use This Skill
|
|
21
31
|
|
|
22
32
|
- Writing or modifying any code that calls the Jaz API
|
|
@@ -125,36 +125,50 @@ Source: https://help.jaz.ai/en/articles/9104224-draft-bills-payments
|
|
|
125
125
|
|
|
126
126
|
- Any draft bill can be converted to active only after all the mandatory fields are filled.
|
|
127
127
|
|
|
128
|
-
**Q3.
|
|
128
|
+
**Q3. How do I bulk convert draft bills to active?**
|
|
129
|
+
|
|
130
|
+
- Select the draft bills using the checkboxes → click **Check and Convert**. This will:
|
|
131
|
+
- Validate which bills can be converted
|
|
132
|
+
- Show errors for those that can’t
|
|
133
|
+
- If you proceed, only eligible bills will be converted.
|
|
134
|
+
|
|
135
|
+
**Q4. How do I bulk approve draft bills?**
|
|
136
|
+
|
|
137
|
+
- Select the draft bills using the checkboxes → click **Check and Approve**. This will:
|
|
138
|
+
- Validate which bills can be approved
|
|
139
|
+
- Show errors for those that can’t
|
|
140
|
+
- If you proceed, only eligible bills will be approved.
|
|
141
|
+
|
|
142
|
+
**Q5. Can I save bill payment records as drafts?**
|
|
129
143
|
|
|
130
144
|
- Similar to bill records, bill payments can also be saved as a draft.
|
|
131
145
|
|
|
132
|
-
**
|
|
146
|
+
**Q6. How can I convert draft payment records to active ones?**
|
|
133
147
|
|
|
134
148
|
- For bills, any draft payments are converted only if the bill is also converted to active.
|
|
135
149
|
- Hence, to record the payment, the bill must be converted to active status.
|
|
136
150
|
|
|
137
|
-
**
|
|
151
|
+
**Q7. Can I delete a draft bill?**
|
|
138
152
|
|
|
139
153
|
- Yes, you can delete a draft bill. If the bill had a draft payment linked, it will also be deleted.
|
|
140
154
|
|
|
141
|
-
**
|
|
155
|
+
**Q8. Can I delete a draft bill payment?**
|
|
142
156
|
|
|
143
157
|
- Similar to draft bills, draft bill payments can also be deleted.
|
|
144
158
|
|
|
145
|
-
**
|
|
159
|
+
**Q9. Do draft bills affect my financial reports?**
|
|
146
160
|
|
|
147
161
|
- No, it does not. Financial reports are only affected once the bills are active.
|
|
148
162
|
|
|
149
|
-
**
|
|
163
|
+
**Q10. Do draft bill payments affect my financial reports?**
|
|
150
164
|
|
|
151
165
|
- No, it does not. Financial reports are only affected once the payments are active.
|
|
152
166
|
|
|
153
|
-
**
|
|
167
|
+
**Q11. Can I create a non-base currency draft bill?**
|
|
154
168
|
|
|
155
169
|
- Yes, the currency setting on a bill does not affect the ability to save it as a draft.
|
|
156
170
|
|
|
157
|
-
**
|
|
171
|
+
**Q12. Can I create a non-base currency draft bill payment?**
|
|
158
172
|
|
|
159
173
|
- Yes, you can save a bill payment as a draft even if it is in non-base currency.
|
|
160
174
|
|
|
@@ -206,21 +220,6 @@ Source: https://help.jaz.ai/en/articles/9104236-import-bills
|
|
|
206
220
|
|
|
207
221
|
---
|
|
208
222
|
|
|
209
|
-
### Purchase Order
|
|
210
|
-
Source: https://help.jaz.ai/en/articles/10219637-purchase-order
|
|
211
|
-
|
|
212
|
-
**Q1. How can I create a purchase order?**
|
|
213
|
-
|
|
214
|
-
- Create a new invoice and save it as draft.
|
|
215
|
-
- Open the draft invoice and download the PDF purchase order.
|
|
216
|
-
|
|
217
|
-
**
|
|
218
|
-
Q2. Can I email the purchase order directly from Jaz?**
|
|
219
|
-
|
|
220
|
-
- Emailing purchase order directly from the app is not yet supported.
|
|
221
|
-
|
|
222
|
-
---
|
|
223
|
-
|
|
224
223
|
### Scheduled And Recurring Bills
|
|
225
224
|
Source: https://help.jaz.ai/en/articles/9104238-scheduled-and-recurring-bills
|
|
226
225
|
|
|
@@ -1,3 +1,57 @@
|
|
|
1
|
+
### Beneficiaries
|
|
2
|
+
Source: https://help.jaz.ai/en/articles/14836403-beneficiaries
|
|
3
|
+
|
|
4
|
+
**Q1. What are beneficiaries?**
|
|
5
|
+
|
|
6
|
+
- Beneficiaries are used for disbursements. They represent payment recipients and store their payout details, such as payment method and account information.
|
|
7
|
+
- A contact can have multiple beneficiaries. Contacts store the person’s details, while beneficiaries store their payout details (how they receive payments).
|
|
8
|
+
|
|
9
|
+
**Q2. What are the requirements to use beneficiaries?**
|
|
10
|
+
|
|
11
|
+
- To use beneficiaries for disbursements, you must first [set up a payment connection](https://help.jaz.ai/en/articles/14819935-setup-connections#h_803d317fce) that supports disbursements.
|
|
12
|
+
- Some payment services may not support disbursements and will not appear in the list.
|
|
13
|
+
|
|
14
|
+
**Q3. How do I create a beneficiary?**
|
|
15
|
+
|
|
16
|
+
- You can create a beneficiary in two ways:
|
|
17
|
+
- From **Contacts**
|
|
18
|
+
- During a **disbursement flow** by adding a new beneficiary**Q4. How do I use a beneficiary?**
|
|
19
|
+
|
|
20
|
+
- When making online disbursements, select a beneficiary for each contact. A single beneficiary can also be used across multiple contacts.
|
|
21
|
+
|
|
22
|
+
**Q5. How do I manage a beneficiary (edit or delete)?**
|
|
23
|
+
|
|
24
|
+
- **To edit:**Choose a beneficiary → click the 3-dot icon → **Edit**
|
|
25
|
+
- Note: editing beneficiaries will not impact past disbursements. Edits will only take effect for succeeding disbursements.
|
|
26
|
+
- **To delete:** Choose a beneficiary → click the 3-dot icon →**DeleteQ6. Where can I manage all my beneficiaries?**
|
|
27
|
+
|
|
28
|
+
- Go to **Contacts** →**Beneficiaries.Q7. Can I use a beneficiary for a different contact in bills?**
|
|
29
|
+
|
|
30
|
+
- Yes. You can choose any available beneficiary when processing bill payments, regardless of the contact.
|
|
31
|
+
|
|
32
|
+
**Q8. Why can’t I disburse to a beneficiary with payment method set to “Paid offline”?**
|
|
33
|
+
|
|
34
|
+
- Disbursements require an active payment service connection. You cannot process online disbursements for beneficiaries set to “Paid offline.”
|
|
35
|
+
|
|
36
|
+
**Q9. What happens to a beneficiary when I edit a payment connection?**
|
|
37
|
+
|
|
38
|
+
- The beneficiary’s payment method and currency will reset. You’ll need to set them up again before using them for disbursements.
|
|
39
|
+
|
|
40
|
+
**Q10. Why can’t I see a payment connection I just connected?**
|
|
41
|
+
|
|
42
|
+
- Some payment services do not support disbursements. Only [supported services](https://help.jaz.ai/en/articles/14819935-setup-connections#h_803d317fce) will appear in the list.
|
|
43
|
+
|
|
44
|
+
**Q11. Are there limits to choosing beneficiaries during disbursement?**
|
|
45
|
+
|
|
46
|
+
- Yes. Limits depend on the connected payment service. For example, PayNow has a per-transaction limit of up to S$200,000 for local transfers.
|
|
47
|
+
- This limit is applied to the total disbursement amount per transaction. For example, if you are disbursing to multiple contacts using the same beneficiary:
|
|
48
|
+
- Contact 1: S$100,000
|
|
49
|
+
- Contact 2: S$100,000
|
|
50
|
+
- Contact 3: S$50,000
|
|
51
|
+
- The total becomes S$250,000, which exceeds the limit. In this case, the beneficiary will no longer be available for selection once the limit is reached.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
1
55
|
### Contact Groups
|
|
2
56
|
Source: https://help.jaz.ai/en/articles/10214737-contact-groups
|
|
3
57
|
|
|
@@ -41,23 +41,37 @@ Source: https://help.jaz.ai/en/articles/9101352-draft-customer-credits
|
|
|
41
41
|
- For customer credits, any draft refunds are converted only if the credit note is also converted to active.
|
|
42
42
|
- Hence, to record the refund, the customer credit note must be converted to active status.
|
|
43
43
|
|
|
44
|
-
**Q5.
|
|
44
|
+
**Q5. How do I bulk convert draft customer credits to active?**
|
|
45
|
+
|
|
46
|
+
- Select the draft customer credits using the checkboxes → click **Check and Convert**. This will:
|
|
47
|
+
- Validate which customer credits can be converted
|
|
48
|
+
- Show errors for those that can’t
|
|
49
|
+
- If you proceed, only eligible customer credits will be converted.
|
|
50
|
+
|
|
51
|
+
**Q6. How do I bulk approve draft customer credits?**
|
|
52
|
+
|
|
53
|
+
- Select the draft customer credits using the checkboxes → click **Check and Approve**. This will:
|
|
54
|
+
- Validate which customer credits can be approved
|
|
55
|
+
- Show errors for those that can’t
|
|
56
|
+
- If you proceed, only eligible customer credits will be approved.
|
|
57
|
+
|
|
58
|
+
**Q7. Can I delete a draft customer credit?**
|
|
45
59
|
|
|
46
60
|
- Yes, you can delete a draft customer credit note. If the note also had a linked draft refund record, it will also be deleted.
|
|
47
61
|
|
|
48
|
-
**
|
|
62
|
+
**Q8. Do draft customer credits affect my financial reports?**
|
|
49
63
|
|
|
50
64
|
- No, they do not. Financial reports are only affected once the customer credit notes are active, and a refund has been recorded for it or it has been applied to an invoice.
|
|
51
65
|
|
|
52
|
-
**
|
|
66
|
+
**Q9. Can I create non-base draft customer credit notes?**
|
|
53
67
|
|
|
54
68
|
- Yes, you can save a customer credit note as a draft even if it is in non-base currency.
|
|
55
69
|
|
|
56
|
-
**
|
|
70
|
+
**Q10. Do draft customer credit refunds affect my financial reports?**
|
|
57
71
|
|
|
58
72
|
- No, draft customer credit refunds do not affect financial reports.
|
|
59
73
|
|
|
60
|
-
**
|
|
74
|
+
**Q11. Can I create a non-base draft customer credit refund?**
|
|
61
75
|
|
|
62
76
|
- Yes, you can save a customer credit refund even if it's in non-base currency.
|
|
63
77
|
|
|
@@ -241,18 +255,25 @@ Source: https://help.jaz.ai/en/articles/9062379-create-customer-credit
|
|
|
241
255
|
|
|
242
256
|
---
|
|
243
257
|
|
|
244
|
-
### Customer Credit Attachments
|
|
245
|
-
Source: https://help.jaz.ai/en/articles/9101350-customer-credit-attachments
|
|
258
|
+
### Customer Credit Attachments (External & Internal)
|
|
259
|
+
Source: https://help.jaz.ai/en/articles/9101350-customer-credit-attachments-external-internal
|
|
246
260
|
|
|
247
261
|
**Q1. Can I upload attachments to a customer credit note?**
|
|
248
262
|
|
|
249
|
-
- You can upload attachments during customer credit note creation
|
|
263
|
+
- You can upload attachments during customer credit note creation. There are two types:
|
|
264
|
+
- **External attachments:** Included in the customer credit email sent to your customers.
|
|
265
|
+
- **Internal attachments:** Visible only to users within your organization.
|
|
250
266
|
- Alternatively, you can add attachments to an existing customer credit note.
|
|
251
267
|
|
|
252
268
|
**Q2. Can I preview the uploaded attachment?**
|
|
253
269
|
|
|
254
270
|
- Yes, you can see a preview of the attachment by clicking on the attachment after uploading.
|
|
255
271
|
|
|
272
|
+
**Q3. Will my customers be able to see these attachments when I send them the customer credit note via email?**
|
|
273
|
+
|
|
274
|
+
- Customers can only see **external attachments** when the customer credit note email is sent to them.
|
|
275
|
+
- **Internal attachments** are visible only to users in your organization who have access to the credit note.
|
|
276
|
+
|
|
256
277
|
---
|
|
257
278
|
|
|
258
279
|
### Customer Credit Line Items
|
|
@@ -302,7 +323,11 @@ Source: https://help.jaz.ai/en/articles/9101351-notes-in-customer-credits
|
|
|
302
323
|
**Q1. How can I add notes for customers on a customer credit note?**
|
|
303
324
|
|
|
304
325
|
- Click on **Customer Credit > + New Credit**
|
|
305
|
-
- Under **Credit Notes** on the bottom of the customer credit note, add a note for your customer.**Q2.
|
|
326
|
+
- Under **Credit Notes** on the bottom of the customer credit note, add a note for your customer.**Q2. Can I customize customer credit notes?**
|
|
327
|
+
|
|
328
|
+
- Yes. Click the customize icon beside Credit Notes to edit them. Your changes will appear in the credit note PDF and will be seen by your customer.
|
|
329
|
+
|
|
330
|
+
**Q3. How can I add internal notes to a customer credit note?**
|
|
306
331
|
|
|
307
332
|
- Find the internal notes section in the customer credit settings tab under 'Advanced'.
|
|
308
333
|
|
|
@@ -115,3 +115,25 @@ Source: https://help.jaz.ai/en/articles/9575775-fixed-assets
|
|
|
115
115
|
- Only **Admins**can convert draft fixed assets to active fixed asset.
|
|
116
116
|
|
|
117
117
|
---
|
|
118
|
+
|
|
119
|
+
### Import Fixed Assets
|
|
120
|
+
Source: https://help.jaz.ai/en/articles/14835057-import-fixed-assets
|
|
121
|
+
|
|
122
|
+
**Q1. How do I import Fixed Assets?**
|
|
123
|
+
|
|
124
|
+
- There are several ways you can import Fixed Assets into Jaz
|
|
125
|
+
- **New Fixed Assets**
|
|
126
|
+
- Fixed Assets → + Register Asset → Import Fixed Assets → New Assets
|
|
127
|
+
- **Transfer Fixed Assets**
|
|
128
|
+
- Fixed Assets → + Register Asset → Import Fixed Assets → Transferred Assets
|
|
129
|
+
- Alternatively, [Data Transfer](https://help.jaz.ai/en/articles/14456526-data-transfer-migrate-data-to-jaz) is available to migrate assets from another accounting software.
|
|
130
|
+
|
|
131
|
+
**Q2. How do I download templates for importing Fixed Assets?**
|
|
132
|
+
|
|
133
|
+
- While you’re in the import flow, a template is available for you to download.
|
|
134
|
+
|
|
135
|
+
**Q3. What files are accepted for importing Fixed Assets?**
|
|
136
|
+
|
|
137
|
+
- Only Excel (XLSX) files are supported.
|
|
138
|
+
|
|
139
|
+
---
|