diff --git a/docs/docs/img/setup-missing-item.png b/docs/docs/img/setup-missing-item.png new file mode 100644 index 0000000..0c8ac5f Binary files /dev/null and b/docs/docs/img/setup-missing-item.png differ diff --git a/docs/docs/install-preferences.md b/docs/docs/install-preferences.md index b91fda2..741173f 100644 --- a/docs/docs/install-preferences.md +++ b/docs/docs/install-preferences.md @@ -1,3 +1,83 @@ -# Test page +# QBI preferences + +QBI needs to know some things about how you wish items to be invoiced in QuickBooks and has a preferences "wizard" for this purpose. + +If preferences have not been set yet or a previously set preference is missing you will be taken automatically to the preferences selection process on start up. + +### Changing preferences + +You can change preferences at any time from the main menu option: + +![preferences menu option](img/main-menu-tools-preferences-item.png) + +### Backing up preferences + +Preferences are stored in the AyaNova database and backed up with AyaNova during the backup process. + +### Starting over with new preferences + +You can completely remove all preferences and start over by [deleting the AyaNova QBI Integration object](https://www.ayanova.com/docs/adm-integrations/#delete) from within AyaNova. +QBI will see it's missing on startup and trigger the setup wizard process automatically. + +### Preference items + +Each item required by QBI is presented in a series of dialog boxes: + +#### Billable Work order status + +![pre wostatus wizard page](img/setup-billable-wo-status.png) + +This is the [Work order status](https://www.ayanova.com/docs/svc-work-order-status/) QBI will look for when it queries AyaNova's [Work orders](https://www.ayanova.com/docs/svc-workorders/) to find Work orders to present for invoicing in QBI. + +** Warning: select a specific status ** + +Unless your circumstances specfically require it, we strongly recommend you do **not** select < Any status > here. + +Instead, we recommend you narrow it down to a particular status to avoid QBI having to retrieve _every_ work order in AyaNova every time it starts up which could be extremely slow and potentially result in thousands of records having to be retrieved, scanned and displayed by QBI. + +We suggest making a work order status specifically for Invoicing purposes that is a locking and completed status that can only be removed by the Accounting role. This way when a work order has been fully serviced and is ready for billing out it can be set to this special status which will then ensure it can no longer be modified and will show up in QBI for the Accounting person to bill out. + +#### Post billing Work order status + +![post wostatus wizard page](img/setup-post-billed-wo-status.png) + +This is the [Work order status](https://www.ayanova.com/docs/svc-work-order-status/) QBI will set on [Work orders](https://www.ayanova.com/docs/svc-workorders/) after they have been successfully invoiced. + +Use of this is optional but it is highly recommended that a special status be created for this purpose that is a [locking](https://www.ayanova.com/docs/svc-work-order-status/#is-a-locking-status) and [completed](https://www.ayanova.com/docs/svc-work-order-status/#is-a-completed-status) type status with very restricted [Roles](https://www.ayanova.com/docs/ay-biz-admin-roles/) as to who can [remove](https://www.ayanova.com/docs/svc-work-order-status/#who-can-remove) that status. + +This will will ensure the Work order is locked and can't be easily modified by anyone after it has been invoiced to the Customer. + +#### Outside service + +![outside service wizard page](img/setup-outside-service-charge-as.png) + +Here you select the QuickBooks Item that should be used to bill an AyaNova Work order's [Outside service](https://www.ayanova.com/docs/svc-workorders/#outside-services) charges. + +#### Expenses + +![Expenses wizard page](img/setup-misc-expenses-charge-as.png) + +Here you select the QuickBooks Item that should be used to bill an AyaNova Work order's [Expenses](https://www.ayanova.com/docs/svc-workorders/#expenses) charges. + +#### Loans + +![Loans wizard page](img/setup-loaner-charge-as.png) + +Here you select the QuickBooks Item that should be used to bill an AyaNova Work order's [Loaned items](https://www.ayanova.com/docs/svc-workorders/#loans) charges. + +#### Transaction class + +![trans class wizard page](img/setup-trans-class.png) + +Here you select the QuickBooks Transaction Class that should be used when invoicing Work orders. This is optional and you do not need to select a Transaction class if you don't use them in QuickBooks. + +#### Invoice template + +![invoice template wizard page](img/setup-invoice-template.png) + +Here you select the QuickBooks Invoice Template that should be used when invoicing Work orders. + + + + -## TEST PAGE diff --git a/docs/docs/install-qbi.md b/docs/docs/install-qbi.md index 57b617a..1cce787 100644 --- a/docs/docs/install-qbi.md +++ b/docs/docs/install-qbi.md @@ -91,7 +91,9 @@ This special status use also means you can see at a glance in AyaNova exactly wh (If you have skipped straight to here without reading the above requirements remember what happened to poor Bertram and start from [the top](#installing-qbi) again) -### Download and install QBFC integration package +### Download and install QBFC package + +Intuit, the makers of QuickBooks provide a developers API package that is a pre-requisite for QBI to communicate with QuickBooks and we provide the installer for that package on our website. [Download](https://ayanova.com/download/QBFC15_0Installer.exe) the QBFC installation file [QBFC15_0Installer.exe](https://ayanova.com/download/QBFC15_0Installer.exe) and run it to install QBFC on the computer that will be using QBI and has QuickBooks already installed and operational. diff --git a/docs/docs/install-starting.md b/docs/docs/install-starting.md index 55153d2..d5944f2 100644 --- a/docs/docs/install-starting.md +++ b/docs/docs/install-starting.md @@ -42,17 +42,22 @@ QBI will now read in data from both QuickBooks and then AyaNova to cache lists o ![qbi init caching message](img/auth-processing.png) - ### Confirm company file As a precaution QBI will prompt you when it starts to confirm that the QuickBooks company file you are using is the one you want to work with: ![approve company file](img/confirm-company.png) +If all is well this completes startup, however if there are any missing settings you may encounter the QBI preferences wizard: + ### Set QBI preferences -If this is your first time starting QBI or you have recently deleted the QBI [Integration data](https://www.ayanova.com/docs/adm-integrations/) from AyaNova you will be prompted to set your QBI preferences: +If this is your first time starting QBI or you have recently deleted the QBI [Integration data](https://www.ayanova.com/docs/adm-integrations/) from AyaNova you will be prompted to [set your QBI preferences](install-preferences.md): ![wizard](img/setup-wizard.png) -todo: here next \ No newline at end of file +#### Missing QBI preference + +If a prior setting is found to be missing (such as a QuickBooks item previously selected having been deleted) at start up you will see a message like this and the [QBI preferences wizard](install-preferences.md) will start to correct the in-valid setting: + +![missing preference](img/setup-missing-item.png)