jaz-clio 4.17.4 → 4.18.0
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 +1 -1
- package/assets/skills/api/help-center-mirror/bills.md +10 -10
- package/assets/skills/api/help-center-mirror/cashflow.md +72 -0
- package/assets/skills/api/help-center-mirror/get-started.md +96 -97
- package/assets/skills/api/help-center-mirror/help-center-embeddings.json +1 -0
- package/assets/skills/api/help-center-mirror/help-center-index.json +1 -1
- package/assets/skills/api/help-center-mirror/index.md +5 -6
- package/assets/skills/api/help-center-mirror/invoices.md +86 -49
- package/assets/skills/api/help-center-mirror/reports.md +50 -0
- package/assets/skills/api/help-center-mirror/supplier-credits.md +15 -84
- 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/accounts.js +1 -1
- package/dist/commands/auth.js +4 -4
- package/dist/commands/bank.js +1 -1
- package/dist/commands/bills.js +6 -5
- package/dist/commands/capsules.js +1 -1
- package/dist/commands/cash-entry.js +4 -5
- package/dist/commands/cash-transfer.js +1 -1
- package/dist/commands/cashflow.js +1 -1
- package/dist/commands/contacts.js +1 -1
- package/dist/commands/customer-credit-notes.js +6 -5
- package/dist/commands/draft-helpers.js +2 -2
- package/dist/commands/format-helpers.js +12 -0
- package/dist/commands/invoices.js +6 -5
- package/dist/commands/items.js +1 -1
- package/dist/commands/jobs.js +190 -14
- package/dist/commands/journals.js +7 -8
- package/dist/commands/kb.js +1 -1
- package/dist/commands/magic.js +12 -13
- package/dist/commands/org-users.js +1 -1
- package/dist/commands/payments.js +1 -1
- package/dist/commands/picker.js +55 -2
- package/dist/commands/recipe.js +3 -3
- package/dist/commands/supplier-credit-notes.js +6 -5
- package/dist/commands/tags.js +1 -1
- package/dist/index.js +88 -1
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: jaz-api
|
|
3
|
-
version: 4.
|
|
3
|
+
version: 4.18.0
|
|
4
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.
|
|
5
5
|
license: MIT
|
|
6
6
|
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.
|
|
@@ -957,15 +957,7 @@ Source: https://help.jaz.ai/en/articles/9104260-edit-bill-payments
|
|
|
957
957
|
### Record Bill Payments
|
|
958
958
|
Source: https://help.jaz.ai/en/articles/9104257-record-bill-payments
|
|
959
959
|
|
|
960
|
-
**Q1. How
|
|
961
|
-
|
|
962
|
-
- You cannot add a new payment method type for payments.
|
|
963
|
-
|
|
964
|
-
**Q2. Can I download the payment advice?**
|
|
965
|
-
|
|
966
|
-
- Yes, you can download the payment advice. Refer to [Bill Downloads](https://help.jaz.ai/en/articles/9104237-bill-downloads) for more information.
|
|
967
|
-
|
|
968
|
-
**Q3. How do I record a payment for a bill?**
|
|
960
|
+
**Q1. How do I record a payment for a bill?**
|
|
969
961
|
|
|
970
962
|
- To record a bill payment, there are a few ways you can do so:
|
|
971
963
|
1. During bill creation
|
|
@@ -976,10 +968,18 @@ Source: https://help.jaz.ai/en/articles/9104257-record-bill-payments
|
|
|
976
968
|
1. You can choose to create a partial/full payment for a bill by changing the bill payment amount.
|
|
977
969
|
1. Depending on whether the payment is partial/full the bill status will be updated.
|
|
978
970
|
|
|
979
|
-
**
|
|
971
|
+
**Q2. Can I record a partial payment for a bill?**
|
|
980
972
|
|
|
981
973
|
- Yes, you can. When recording a payment for a bill, if the **Bill Payment Amount**is less than the bill transaction amount, then the bill would be considered to be partially paid.
|
|
982
974
|
|
|
975
|
+
**Q3. Can I download the payment advice?**
|
|
976
|
+
|
|
977
|
+
- Yes, you can download the payment advice. Refer to [Bill Downloads](https://help.jaz.ai/en/articles/9104237-bill-downloads) for more information.
|
|
978
|
+
|
|
979
|
+
**Q4. How can I add a new payment method type?**
|
|
980
|
+
|
|
981
|
+
- You cannot add a new payment method type for payments.
|
|
982
|
+
|
|
983
983
|
**Q5. What happens if I pay in a different currency than the bill?**
|
|
984
984
|
|
|
985
985
|
- If there is a difference between the bill payment amount converted to the organization's base currency and the cash spent amount converted to the organization's base currency, realized gain-loss will take place. This is further explained in [When does realized FX gain-loss (RGL) happen, and how is it calculated?](#h_62f0092b92)
|
|
@@ -1,3 +1,75 @@
|
|
|
1
|
+
### Cash Transfer
|
|
2
|
+
Source: https://help.jaz.ai/en/articles/13882606-cash-transfer
|
|
3
|
+
|
|
4
|
+
**Q1. What is a cash transfer?**
|
|
5
|
+
|
|
6
|
+
- A cash transfer moves funds from one bank account to another.
|
|
7
|
+
- It automatically creates a cash out entry from one account and a cash in entry to the other in your Cashflows.
|
|
8
|
+
|
|
9
|
+
**Q2. How do I make a cash transfer?**
|
|
10
|
+
|
|
11
|
+
- Go to Reconciliations > Cashflows > click the New Direct Entry dropdown and select Cash Transfer.
|
|
12
|
+
- Choose the bank account to transfer from and the bank account to transfer to.
|
|
13
|
+
- Enter the amount, transfer date, and reference.
|
|
14
|
+
- Contact, Tracking Tags, Internal Notes, and Attachments are optional.
|
|
15
|
+
|
|
16
|
+
**Q3. Where can I see all my cash transfer records?**
|
|
17
|
+
|
|
18
|
+
- Go to Cashflows > Direct Entries > Cash Transfers.
|
|
19
|
+
|
|
20
|
+
**Q4. Can I duplicate a cash transfer?**
|
|
21
|
+
|
|
22
|
+
- Yes. Open a cash transfer record, click the three-dot icon, and select Duplicate.
|
|
23
|
+
|
|
24
|
+
**Q5. Can I edit a cash transfer?**
|
|
25
|
+
|
|
26
|
+
- Yes. Open the cash transfer record and update the necessary details before saving.
|
|
27
|
+
- Editing a cash transfer will reset any existing reconciliation linked to it.
|
|
28
|
+
|
|
29
|
+
**Q6. Can I delete a cash transfer record?**
|
|
30
|
+
|
|
31
|
+
- Yes. Open the cash transfer record, click the three-dot icon, and select Delete.
|
|
32
|
+
- Deleting a cash transfer will reset any existing reconciliation linked to it.
|
|
33
|
+
|
|
34
|
+
**Q7. How is a cash transfer recorded in the ledger?**
|
|
35
|
+
|
|
36
|
+
- It credits the sending bank account and debits the receiving bank account.
|
|
37
|
+
- No income or expense accounts are affected.
|
|
38
|
+
|
|
39
|
+
**Q8. Can I reconcile a cash transfer?**
|
|
40
|
+
|
|
41
|
+
- Yes. During bank reconciliation, you can match the cash transfer entry with the corresponding bank record.
|
|
42
|
+
|
|
43
|
+
**Q9. How do I know if a cash transfer is reconciled?**
|
|
44
|
+
|
|
45
|
+
- Open the cash transfer record.
|
|
46
|
+
- A reconciled icon will appear next to the bank account that has been reconciled.
|
|
47
|
+
|
|
48
|
+
**Q10. When should I use Cash Transfer instead of a Journal Entry?**
|
|
49
|
+
|
|
50
|
+
- Use Cash Transfer when moving funds between your own bank or cash accounts.
|
|
51
|
+
- It records the transaction as a movement of money rather than an accounting adjustment.
|
|
52
|
+
- This ensures it appears correctly in your Cashflow report and supports bank reconciliation.
|
|
53
|
+
|
|
54
|
+
**Q11. Can I attach proof of transfer?**
|
|
55
|
+
|
|
56
|
+
- Yes. You can upload supporting documents such as transfer receipts when creating or editing a cash transfer.
|
|
57
|
+
|
|
58
|
+
**Q12. Can I make an advance cash transfer?**
|
|
59
|
+
|
|
60
|
+
- Yes. Set a future transfer date when creating the cash transfer.
|
|
61
|
+
|
|
62
|
+
**Q13. Can I transfer between bank accounts with different currencies?**
|
|
63
|
+
|
|
64
|
+
- Yes, if multi-currency is enabled.
|
|
65
|
+
- Exchange rates will apply based on your currency settings.
|
|
66
|
+
|
|
67
|
+
**Q14. Can I put a cash transfer into a capsule?**
|
|
68
|
+
|
|
69
|
+
- Yes. When creating or editing a cash transfer, click the capsule icon in the reference field to assign it to a capsule.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
1
73
|
### Cashflows
|
|
2
74
|
Source: https://help.jaz.ai/en/articles/9095678-cashflows
|
|
3
75
|
|
|
@@ -1,3 +1,99 @@
|
|
|
1
|
+
### Converting to Jaz from Another Accounting Software
|
|
2
|
+
Source: https://help.jaz.ai/en/articles/13870579-converting-to-jaz-from-another-accounting-software
|
|
3
|
+
|
|
4
|
+
**Q1. How do I convert to Jaz from another accounting system?**
|
|
5
|
+
|
|
6
|
+
- You have two options to convert to Jaz:
|
|
7
|
+
|
|
8
|
+
- Option 1: **Full Service Managed Conversion**
|
|
9
|
+
- Jaz handles the full migration for you.
|
|
10
|
+
- Includes:
|
|
11
|
+
- Transfer of detailed transactions for current FY and FY-1
|
|
12
|
+
- Full configuration and validation
|
|
13
|
+
- Typical timeline: 3 to 5 business days per client
|
|
14
|
+
- Contact us at [help@jaz.ai](mailto:help@jaz.ai) if you’re interested.
|
|
15
|
+
|
|
16
|
+
- Option 2: **Quick Conversion as at Financial Year End (FYE)**
|
|
17
|
+
- Includes:
|
|
18
|
+
- Transfer of open AR and AP transactions
|
|
19
|
+
- Transfer of opening balances for all other accounts
|
|
20
|
+
- Typical timeline: 1 business day per client
|
|
21
|
+
|
|
22
|
+
**Q2. How do I do the Quick Conversion as at FYE?**
|
|
23
|
+
|
|
24
|
+
- Follow these steps to quickly convert to Jaz.
|
|
25
|
+
- **Step 1: Retrieval**
|
|
26
|
+
- Retrieve the following as at FYE:
|
|
27
|
+
- AR/AP Ageing Reports (source & functional)
|
|
28
|
+
- Trial Balance (functional)
|
|
29
|
+
- Balance Sheet (functional)
|
|
30
|
+
- Chart of Accounts (or 2 FY Trial Balance if unavailable)
|
|
31
|
+
- Customer & Supplier contacts
|
|
32
|
+
- Tax profiles
|
|
33
|
+
- Closing FX rates for all currencies
|
|
34
|
+
- Payment details for the conversion period
|
|
35
|
+
- General Ledger for the conversion period
|
|
36
|
+
|
|
37
|
+
- **Step 2: Jaz Configurations**
|
|
38
|
+
- Add currencies (ensure FYE rates match previous system)
|
|
39
|
+
- Import or create in Jaz:
|
|
40
|
+
- Chart of Accounts (including conversion clearing accounts listed below)
|
|
41
|
+
- Contacts & items
|
|
42
|
+
- Tax profiles
|
|
43
|
+
|
|
44
|
+
- **Step 3: Outstanding AR/AP Transactions**
|
|
45
|
+
- All open AR and AP ageing transactions will be created as conversion transactions.
|
|
46
|
+
- e.g. 1 invoice (or bill) will be created for each unpaid transaction using the FX rate as at FYE to prevent unrealized gains or losses.
|
|
47
|
+
- Each conversion transaction will have only one line item using the following COA:
|
|
48
|
+
- Invoices → AR Conversion Clearing Account (contra asset)
|
|
49
|
+
- Bills → AP Conversion Clearing Account (contra liability)
|
|
50
|
+
- Alternative: Create 1 contra asset clearing account for both invoices and bills
|
|
51
|
+
- Accounting impact:
|
|
52
|
+
- When invoice is created, AR gets debited, line item conversion COA gets credited. AR increases, AR clearing account decreases
|
|
53
|
+
- When a bill is created, AP gets credited, line item conversion COA gets debited. AP increases, AP clearing account decreases
|
|
54
|
+
- When future payments are received for a transaction before the FYE date, record the payment against the respective conversion invoice (or bill)
|
|
55
|
+
|
|
56
|
+
- **Step 4: Transfer Balances**
|
|
57
|
+
- Transfer Trial Balance as at FYE
|
|
58
|
+
- Do not transfer AR or AP balances from FYE TB
|
|
59
|
+
- AR from conversion transactions created in Step 3 should already show in the "Current Balance" column
|
|
60
|
+
- Instead, record the AR amount as a debit to the AR clearing account (credited above)
|
|
61
|
+
- Instead, record the AP amount as a credit to the AP clearing account (debited above)
|
|
62
|
+
- Alternative: If only 1x clearing account was used, then record AR-AP
|
|
63
|
+
- TTB also locks all accounts as at transfer date to prevent future mistakes
|
|
64
|
+
- Verify that Trial Balance on Jaz = Trial Balance on Existing Software as at FYE.
|
|
65
|
+
|
|
66
|
+
**Q3. How do I make sure that I did the quick conversion correctly?**
|
|
67
|
+
|
|
68
|
+
- Here’s a complete checklist you can use to make sure you’ve converted correctly.
|
|
69
|
+
- Import Chart of Accounts
|
|
70
|
+
- Import Contacts
|
|
71
|
+
- Create Tax Profiles
|
|
72
|
+
- Import Journal Entries
|
|
73
|
+
- Add Organization Currencies & FX Rates
|
|
74
|
+
- AR Ageing Balance Conversion
|
|
75
|
+
- AP Ageing Balance Conversion
|
|
76
|
+
- Transfer Trial Balance (all other COA)
|
|
77
|
+
- Trial Balance Audit between Jaz <> Existing Software
|
|
78
|
+
- Create all current FY transactions (Import or Open APIs)
|
|
79
|
+
|
|
80
|
+
**Q4. What should I prepare for Managed Migration Service?**
|
|
81
|
+
|
|
82
|
+
- **If migrating from Xero/QBO or similar:**
|
|
83
|
+
- Set up COA, multi-currencies, and FYE date in Jaz.
|
|
84
|
+
- Provide account/API access to your Xero/QBO.
|
|
85
|
+
- Inform Jaz for next steps
|
|
86
|
+
- **If migrating from Desktop Accounting Platforms:**
|
|
87
|
+
- Set up COA, tax profiles, multi-currencies, and FYE date in Jaz.
|
|
88
|
+
- Download and provide the following reports in Excel to the Jaz team:
|
|
89
|
+
- Detailed bills and invoices for the conversion period
|
|
90
|
+
- Payment details for the conversion period (Bills and Invoices)
|
|
91
|
+
- Closing AR and AP balances
|
|
92
|
+
- General Ledger for the conversion period
|
|
93
|
+
- Inform Jaz for next steps
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
1
97
|
### Customize Text Case in Business Transactions
|
|
2
98
|
Source: https://help.jaz.ai/en/articles/10052305-customize-text-case-in-business-transactions
|
|
3
99
|
|
|
@@ -50,66 +146,6 @@ Source: https://help.jaz.ai/en/articles/12570711-invite-team-members-and-clients
|
|
|
50
146
|
|
|
51
147
|
---
|
|
52
148
|
|
|
53
|
-
### Keyboard Shortcuts And Icons
|
|
54
|
-
Source: https://help.jaz.ai/en/articles/9117257-keyboard-shortcuts-and-icons
|
|
55
|
-
|
|
56
|
-
Upgrade your experience in Jaz! Learn how to quickly access the most commonly used functions and features in Jaz with keyboard shortcuts, as well as what the commonly used symbols in the Jaz refer to.
|
|
57
|
-
|
|
58
|
-
**Shortcuts**
|
|
59
|
-
|
|
60
|
-
| **Shortcut - Windows** |**Shortcut - Mac** | **What does it do?** |
|
|
61
|
-
| --- | --- | --- |
|
|
62
|
-
| Ctrl + k | Cmd + k | Open Search All from anywhere in the app |
|
|
63
|
-
| Ctrl + / | Cmd + / | Opens Navigate Anywhere |
|
|
64
|
-
| Ctrl + b | Cmd + b | Open / Close side bar (e.g. settings menu when creating invoices) |
|
|
65
|
-
| Ctrl + i | Cmd + i | Add new line item in an invoice, bill, customer credit note or supplier credit note |
|
|
66
|
-
| Ctrl + j | Cmd + j | Switch organization |
|
|
67
|
-
| Ctrl + f | Cmd + f | Search any transaction |
|
|
68
|
-
| Cmd + Enter | Cmd + Enter | On forms and report tabs, triggers the action when the button turns blue |
|
|
69
|
-
| D | D | - Activates date dropdown in reports tab. - Switches between dashboard dividers. |
|
|
70
|
-
| E | E | Enables sending emails from Edit Invoice and Customer Credit Note screens. |
|
|
71
|
-
| F | F | Opens custom fields in edit transaction screen. |
|
|
72
|
-
| I | I | Opens Internal Notes in Invoices. |
|
|
73
|
-
| N | N | Triggers the sole action button on a page, or opens its dropdown if available |
|
|
74
|
-
| T | T | - Cycle through tabs in modules with headers like Invoices, Bills, and Journals.- Opens tracking tags in edit transaction screen. |
|
|
75
|
-
| Esc | Esc | Close any open modal |
|
|
76
|
-
| Tab | Tab | Selects the next element on screen while editing a transaction. |
|
|
77
|
-
| Shift + Tab | Shift + Tab | Selects the previous element on screen while editing a transaction. |
|
|
78
|
-
| Right arrow | Right arrow | Navigate down the list of records |
|
|
79
|
-
| Left arrow | Left arrow | Navigate up the list of records |
|
|
80
|
-
| Down arrow | Down arrow | Navigate down the list of options in a drop-down field |
|
|
81
|
-
| Enter | Enter | Select an option from a drop-down field |
|
|
82
|
-
| Tab | Tab | Move to the next field |
|
|
83
|
-
|
|
84
|
-
**Automatic Calculations**
|
|
85
|
-
|
|
86
|
-
- Need to make a quick calculation of commissions? Or trying to calculate markups or profit margins? Make use of our automatic calculation feature!
|
|
87
|
-
- In any numerical entry field, simply type in the calculation that you'd like to do, and press **Enter**. See the images below for an example.
|
|
88
|
-
- Jaz will do the calculations for you!
|
|
89
|
-
|
|
90
|
-
**Flexible Date Input**
|
|
91
|
-
|
|
92
|
-
- In any date entry field, you can type dates in a variety of formats (e.g., "Apr 25 2025" or "042525") and it will automatically fill the field with the default date format. See the images below for an example.
|
|
93
|
-
|
|
94
|
-
**Icons/Symbols**
|
|
95
|
-
|
|
96
|
-
| **Icon/Symbol** |**Meaning** | **Location** |
|
|
97
|
-
| --- | --- | --- |
|
|
98
|
-
| | Cash-in amount | Reconciliations |
|
|
99
|
-
| | Cash-out amount | Reconciliations |
|
|
100
|
-
| | Outwards money movement | Reconciliations |
|
|
101
|
-
| | Inwards money movement | Reconciliations |
|
|
102
|
-
| | Edit | All modules except reports |
|
|
103
|
-
| | Data export | All modules except:Customer creditsSupplier credits |
|
|
104
|
-
| | Use to filter records | Sales modulePurchases module |
|
|
105
|
-
| | Autofill transaction amount’s cash equivalent | Payment/Refunds |
|
|
106
|
-
| | Indicates assigned fields during import | Bank Records |
|
|
107
|
-
| | A bill item is reconciled with a Fixed Asset | Bill details |
|
|
108
|
-
| | Pretty case formatting for line items | InvoiceBillCustomer CreditSupplier Credit |
|
|
109
|
-
| | Associate classifiers with transaction line items and journal entry lines | InvoiceBillCustomer CreditSupplier CreditJournal |
|
|
110
|
-
|
|
111
|
-
---
|
|
112
|
-
|
|
113
149
|
### Magic Search
|
|
114
150
|
Source: https://help.jaz.ai/en/articles/9994103-magic-search
|
|
115
151
|
|
|
@@ -129,29 +165,6 @@ Source: https://help.jaz.ai/en/articles/9994103-magic-search
|
|
|
129
165
|
|
|
130
166
|
---
|
|
131
167
|
|
|
132
|
-
### Navigate Anywhere
|
|
133
|
-
Source: https://help.jaz.ai/en/articles/10989493-navigate-anywhere
|
|
134
|
-
|
|
135
|
-
**Q1: How can I access Navigate Anywhere?**
|
|
136
|
-
|
|
137
|
-
- You can access Navigate Anywhere in two ways:
|
|
138
|
-
- Keyboard Shortcut: Press the designated shortcut to open it instantly.
|
|
139
|
-
- Mac: cmd + /
|
|
140
|
-
- Windows: ctrl + /
|
|
141
|
-
- Top right icon
|
|
142
|
-
|
|
143
|
-
**Q2: Can I use Navigate Anywhere with a keyboard?**
|
|
144
|
-
|
|
145
|
-
- Yes, Navigate Anywhere supports full keyboard navigation:
|
|
146
|
-
- Use the arrow keys to scroll through options.
|
|
147
|
-
- Press Enter to select and execute an action.
|
|
148
|
-
|
|
149
|
-
**Q3: Are there any restrictions on using Navigate Anywhere?**
|
|
150
|
-
|
|
151
|
-
- Actions restricted by user permissions are either disabled or hidden.
|
|
152
|
-
|
|
153
|
-
---
|
|
154
|
-
|
|
155
168
|
### Onboarding
|
|
156
169
|
Source: https://help.jaz.ai/en/articles/9117115-onboarding
|
|
157
170
|
|
|
@@ -166,20 +179,6 @@ Source: https://help.jaz.ai/en/articles/9117115-onboarding
|
|
|
166
179
|
|
|
167
180
|
---
|
|
168
181
|
|
|
169
|
-
### Plans
|
|
170
|
-
Source: https://help.jaz.ai/en/articles/9117234-plans
|
|
171
|
-
|
|
172
|
-
**Q1. What are the plans that Jaz currently offers?**
|
|
173
|
-
|
|
174
|
-
- Jaz is always upgrading to serve our users better, so our offerings may change from time to time!
|
|
175
|
-
- Get the latest information about our plans and the features offered by visiting our website at [https://www.jaz.ai/pricing](https://www.jaz.ai/pricing).
|
|
176
|
-
|
|
177
|
-
**Q2. Why are some of the features disabled on Jaz for my organization?**
|
|
178
|
-
|
|
179
|
-
- The feature you are trying to use may not be available for your plan. For information on features that you can access with your plan, visit [https://www.jaz.ai/#features](https://www.jaz.ai/#features).
|
|
180
|
-
|
|
181
|
-
---
|
|
182
|
-
|
|
183
182
|
### Quick Fix
|
|
184
183
|
Source: https://help.jaz.ai/en/articles/13513663-quick-fix
|
|
185
184
|
|