Difference between revisions of "Quickbooks UI"

From ISoft Wiki
Jump to navigationJump to search
(Making the Quickbooks UI page more useful)
(A bit of a rewrite in an attempt at more clarity)
 
Line 5: Line 5:
{{Tip|Make sure you make a backup copy of the Quickbooks Company File before you begin}}
{{Tip|Make sure you make a backup copy of the Quickbooks Company File before you begin}}


* To use the Quickbooks UI you must first be logged in as an Administrator and be in Multi-User Mode, then transfer the Quickbooks UI and its XML file to the customer's computer.
# Make sure Quickbooks is logged in as an Administrator and in Multi-User Mode
* Once you open QB UI - hit the 'browse' button next to 'XML Definition' and navigate to where you put the XML file, then select the XML file (qbxmlops70.xml)
# Open Quickbooks UI
* Then hit the 'browse' button next to 'Quickbooks File' and navigate to where the customer's Quickbooks Company file is and select it (the location of this file can be found by using ITrack's Quickbooks Tools Extention)
# Select the correct company file
# Hit the 'browse' button next to 'XML Definition', navigate to where you put the XML file, and select the XML file (qbxmlops[7-8]0.xml)
# Hit the 'browse' button next to 'Quickbooks File', navigate to the customer's Quickbooks Company file, and select it


=== Request Mode ===
== Search for things in Quickbooks ==
* Make sure the "single request" option button is selected so that you are in 'Request Mode'
This is usually the first step in doing something useful with this utility.
* In the drop down menu there should be a list of different things that you can select.
** InvoiceQueryRq will give you information about Invoices in Quickbooks
** CustomerQueryRq will give you info about Customers in QB
** etc
* Select the appropriate item from the drop down list and the options area will populate with options like 'Modified Date Range', 'From Modified Date', 'To Modified Date', etc.
* Click on the 'Invert All' button to deselect all of the options, select the options that you want to query, then fill in the value fields.
** For example, put '2009-01-01' in the 'From Modified Date' field and '2010-01-01' in the 'To Modified Date' field
** In QB UI, dates must be in the format 'yyyy-mm-dd' and when searching for a date range you must have 3 options checked: Modified Date Range, From Modified Date, and To Modified Date
* Now click on the 'Send to QB' button. This will send a query to Quickbooks and populate the results area of the Quickbooks UI.


=== Respond Mode ===
# Select the "single request" radio button.
* Click on the 'Respond to Checked Items' radiobutton to switch to 'Respond Mode'
# Select the appropriate message to be sent from the dropdown.
* Let's say that we mistakenly pushed an invoice to quickbooks that we didn't want to. You will need to select 'TnxDelRq' from the drop down menu and enter in the following values:
## InvoiceQueryRq will give you information about Invoices in Quickbooks
** TxnDelType: Invoice (if you want to delete an invoice)
## CustomerQueryRq will give you info about Customers in QB
** TxnID: {?txnID} (a parameter that will make the XML work)
## etc
* Check all of the invoices in the results area that you want to delete and hit the 'Send to QB' button.
# Select the parameters in the bottom list that you want to use to search for items in Quickbooks.  You don't have to select any - if there are none selected, Quickbooks will bring up all of them. In most company files, this will take forever (rounded up).
# Fill in the parameter values that you want to use to search.  Dates must be in the format YYYY-MM-DD.  Some parameters can only accept certain predefined values.  Sadly, to see what those values are, you must read the comments in the XML file.
# Click on the 'Send to QB' button to send a query to Quickbooks and populate the top list.


{{Tip|If you get an IDispatch Error #512 that means something went wrong with the xml. You probably typed something in wrong (wrong place, wrong format, misspelled, etc)}}
== Fiddle with things in Quickbooks ==
Generally, people use the Quickbooks UI tool to fiddle with a bunch of stuff in Quickbooks at once.
 
# Select the "Respond to Checked Items" radio button
# Select all of the quickbooks items that you want to do something to.  A message will be sent for each checked item.
# Select the message that is appropriate for the action you want to happen
## TxnDelRq deletes transactions
## CustomerModRq modifies a customer
## ...and so on.  Some things are named more sensibly than others
# Fill in the relevant parameters in the bottom list.  You '''WILL''' need to fill in at least one parameter to let it know what object in Quickbooks you are talking about.
## You can refer to the value in the top list with the syntax {?FieldName} - for example {?ListID} or {?TxnId}
## As with some of the request messages, some of the parameters only take special values.  Your options are described in the XML file comments.
# Hit the "Send to QB" button and grab a cup of coffee while stuff happens.
 
{{Tip|If you get an IDispatch Error #512 that means something went wrong with the parameters you gave. Try to be less wrong!}}

Latest revision as of 16:44, 9 November 2011

Duff made this app to do things to a Quickbooks files without using the craptastic Quickbooks Interface.

How to use the Quickbooks UI

Tip
Make sure you make a backup copy of the Quickbooks Company File before you begin
  1. Make sure Quickbooks is logged in as an Administrator and in Multi-User Mode
  2. Open Quickbooks UI
  3. Select the correct company file
  4. Hit the 'browse' button next to 'XML Definition', navigate to where you put the XML file, and select the XML file (qbxmlops[7-8]0.xml)
  5. Hit the 'browse' button next to 'Quickbooks File', navigate to the customer's Quickbooks Company file, and select it

Search for things in Quickbooks

This is usually the first step in doing something useful with this utility.

  1. Select the "single request" radio button.
  2. Select the appropriate message to be sent from the dropdown.
    1. InvoiceQueryRq will give you information about Invoices in Quickbooks
    2. CustomerQueryRq will give you info about Customers in QB
    3. etc
  3. Select the parameters in the bottom list that you want to use to search for items in Quickbooks. You don't have to select any - if there are none selected, Quickbooks will bring up all of them. In most company files, this will take forever (rounded up).
  4. Fill in the parameter values that you want to use to search. Dates must be in the format YYYY-MM-DD. Some parameters can only accept certain predefined values. Sadly, to see what those values are, you must read the comments in the XML file.
  5. Click on the 'Send to QB' button to send a query to Quickbooks and populate the top list.

Fiddle with things in Quickbooks

Generally, people use the Quickbooks UI tool to fiddle with a bunch of stuff in Quickbooks at once.

  1. Select the "Respond to Checked Items" radio button
  2. Select all of the quickbooks items that you want to do something to. A message will be sent for each checked item.
  3. Select the message that is appropriate for the action you want to happen
    1. TxnDelRq deletes transactions
    2. CustomerModRq modifies a customer
    3. ...and so on. Some things are named more sensibly than others
  4. Fill in the relevant parameters in the bottom list. You WILL need to fill in at least one parameter to let it know what object in Quickbooks you are talking about.
    1. You can refer to the value in the top list with the syntax {?FieldName} - for example {?ListID} or {?TxnId}
    2. As with some of the request messages, some of the parameters only take special values. Your options are described in the XML file comments.
  5. Hit the "Send to QB" button and grab a cup of coffee while stuff happens.
Tip
If you get an IDispatch Error #512 that means something went wrong with the parameters you gave. Try to be less wrong!