Summary: Configuration | Message Processors
org.mule.modules

mule-module-quick-books

2.1-alpha-3
Namespacehttp://www.mulesoft.org/schema/mule/quickbooks-windows
Schema Locationhttp://www.mulesoft.org/schema/mule/quickbooks-windows/2.0/mule-quickbooks-windows.xsd
Version2.0
Minimum Mule Version3.2

Module Overview

QuickBooks software provides an interface that allows you to use forms such as checks, deposit slips and invoices, making the accounting process more comfortable for the average business owner or manager. By using the built-in functions that pertain to your business, you are able to perform your company accounting by simply recording your vendor activities, customer activities, banking transactions, payroll checks and taxes. QuickBooks handles the accounting portion of each transaction behind the scenes. Read more: QuickBooks Accounting Tutorial | eHow.com http://www.ehow.com/way_5462311_quickbooks-accounting-tutorial.html#ixzz1csaydwxl

Summary

Configuration
<quickbooks-windows:config>
Configure an instance of this module
Message Processors
<quickbooks-windows:create>
Creates.
<quickbooks-windows:delete>
Deletes an object.
<quickbooks-windows:find-objects>
Lazily retrieves Objects For details on how to generate a query see: Retrieve Especification



<quickbooks-windows:generate-a-new-request-id>
Generate a new GUID for the requestId
<quickbooks-windows:get-object>
Retrieve objects by ID.
<quickbooks-windows:status>
Retrieve the Status

Retrieves information about the sync status of Quickbooks entities.

<quickbooks-windows:sync-activity>
Retrieve the SyncActivities

The SyncActivity object contains information about Quickbooks for Windows synchronizations.

<quickbooks-windows:update>
Updates.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:quickbooks-windows="http://www.mulesoft.org/schema/mule/quickbooks-windows"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/quickbooks-windows
               http://www.mulesoft.org/schema/mule/quickbooks-windows/2.0/mule-quickbooks-windows.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necesary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
TypeNameDefault ValueDescription
xs:string name Optional. Give a name to this configuration so it can be later referenced.
xs:string baseUri https://services.intuit.com/sb Optional. The base uri of the quickbooks endpoint, used to fetch the company uri.
client Optional. Quick-Books client.

Message Processors

<quickbooks-windows:create>

Creates. For details of the supported objects and its fields: Supported Objects and Operations

XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
realmId The realmID, also known as the Company ID, uniquely identifies the data for a company. In QuickBooks, the Company ID appears on the My Account page. In Data Services for QuickBooks, the realmID is required in the URL for most calls.
appKey Application Id.
realmIdPseudonym Pseudonym Realm Id, obtained from the gateway that represents the company.
authIdPseudonym Pseudonym Auth Id, obtained from the gateway that represents the user.
type WindowsEntityType of the object.
requestId The unique request Id
draft Optional. Boolean draft

Saving an IDS object in a draft state prevents it from being synchronized with Quickbooks. Your app might want to save an object in a draft state if the user has not finished entering data, or for some other reason the user does not want to commit the object for synchronization. You may save an object in draft state during a create or update operation by specifying the draft="true" attribute. By default, the Draft attribute is false, which means that the saved object will be synchronized with Quickbooks.
fullResponse Optional. Boolean fullResponse. If this flag is true, it will return the created object, otherwise, it will return an ObjectRef.
Child Elements
<quickbooks-windows:obj>
Map that represents the object to be created.
Return Payload
  • The created Object or an ObjectRef if the fullResponse flag was null of false.
Exception Payload
QuickBooksRuntimeException when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks-windows:delete>

Deletes an object.

Most objects cannot be deleted by calling Data Services.

If the obj map do not have the MetaData field or the SyncToken, internally, will retrieve the object at first, to delete it. So be careful, because it will need two request instead of one, which could make it slower.

For details of the supported objects and its fields: Supported Objects and Operations

XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
realmId The realmID, also known as the Company ID, uniquely identifies the data for a company. In QuickBooks Online, the Company ID appears on the My Account page. In Data Services for QuickBooks Online, the realmID is required in the URL for most calls.
appKey Application Id.
realmIdPseudonym Pseudonym Realm Id, obtained from the gateway that represents the company.
authIdPseudonym Pseudonym Auth Id, obtained from the gateway that represents the user.
type WindowsEntityType of the object.
requestId The unique request Id
Child Elements
<quickbooks-windows:obj>
Map that represents the object to be created.
Exception Payload
QuickBooksRuntimeException when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks-windows:find-objects>

Lazily retrieves Objects For details on how to generate a query see: Retrieve Especification

XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
realmId The realmID, also known as the Company ID, uniquely identifies the data for a company. In QuickBooks Online, the Company ID appears on the My Account page. In Data Services for QuickBooks Online, the realmID is required in the URL for most calls.
appKey Application Id.
realmIdPseudonym Pseudonym Realm Id, obtained from the gateway that represents the company.
authIdPseudonym Pseudonym Auth Id, obtained from the gateway that represents the user.
type WindowsEntityType of the object.
Child Elements
<quickbooks-windows:query>
Optional. Map that represents every filter and sort for the objects retrieved. Each type of object to be retrieved, has a TheObjectQuery class that has the attributes for which it can be filtered

(To know which attributes are accepted in every ObjectQuery, you could follow the link in the documentation of the WindowsEntityType that you require, or you can follow the link changing the word OBJECT for the object that you required, for example Account:

https://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0050_Data_Services/ 0500_QuickBooks_Windows/0600_Object_Reference/OBJECT

).

Do not complete the fields chunkSize and startPage, because are need it for the "lazily retrieve".

If query is null, it will retrieve all the objects of that WindowsEntityType.
Return Payload
  • Iterable of the objects to be retrieved.
Exception Payload
QuickBooksRuntimeException when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks-windows:generate-a-new-request-id>

Generate a new GUID for the requestId

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
Child Elements
Return Payload
  • a GUID for the requestId

<quickbooks-windows:get-object>

Retrieve objects by ID. For details of the supported objects: Supported Objects and Operations

XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
realmId The realmID, also known as the Company ID, uniquely identifies the data for a company. In QuickBooks, the Company ID appears on the My Account page. In Data Services for QuickBooks, the realmID is required in the URL for most calls.
appKey Application Id.
realmIdPseudonym Pseudonym Realm Id, obtained from the gateway that represents the company.
authIdPseudonym Pseudonym Auth Id, obtained from the gateway that represents the user.
type WindowsEntityType of the object.
Child Elements
<quickbooks-windows:id>
Id which is assigned by Data Services when the object is created.
Return Payload
  • The object.
Exception Payload
QuickBooksRuntimeException when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks-windows:status>

Retrieve the Status

Retrieves information about the sync status of Quickbooks entities. You can also query specific entity types for either synchronized or unsynchronized objects with filters. You can get information on recent synchronizations using the syncActivity operation.

Note: Sync status information will be maintained for all operations in the cloud up to 30 days old. Of those operations older than 30 days, only the last operation's synch status will be maintained.

XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
realmId The realmID, also known as the Company ID, uniquely identifies the data for a company. In QuickBooks Online, the Company ID appears on the My Account page. In Data Services for QuickBooks Online, the realmID is required in the URL for most calls.
appKey Application Id.
realmIdPseudonym Pseudonym Realm Id, obtained from the gateway that represents the company.
authIdPseudonym Pseudonym Auth Id, obtained from the gateway that represents the user.
Child Elements
<quickbooks-windows:syncStatusRequest>
Optional. Map that represents a SyncStatusRequest object. It has the specifications of the syncStatuses to be retrieved. (like a filter)
Return Payload

<quickbooks-windows:sync-activity>

Retrieve the SyncActivities

The SyncActivity object contains information about Quickbooks for Windows synchronizations. To get the sync status of another type of object, for example, a customer, use the status operation. To filter a query based on whether or not an object is synchronized, use a filter.

Note: Sync status information will be maintained for all operations in the cloud up to 30 days old. Of those operations older than 30 days, only the last operation's synch status will be maintained.

XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
realmId The realmID, also known as the Company ID, uniquely identifies the data for a company. In QuickBooks Online, the Company ID appears on the My Account page. In Data Services for QuickBooks Online, the realmID is required in the URL for most calls.
appKey Application Id.
realmIdPseudonym Pseudonym Realm Id, obtained from the gateway that represents the company.
authIdPseudonym Pseudonym Auth Id, obtained from the gateway that represents the user.
Child Elements
<quickbooks-windows:syncActivityRequest>
Optional. Map that represents a SyncActivityRequest object. It has the specifications of the SyncActivities to be retrieved. (like a filter)
Return Payload

<quickbooks-windows:update>

Updates.

Specify all the parameters for the object, not just the new or changed elements. If you omit an element, it is removed from the object by the update operation.

For details of the supported objects and its fields: Supported Objects and Operations

When updating transaction objects (such as Estimate or Invoice), note the following:

* To retain existing line items, specify them in the request XML body and do not change their order.

* To remove a line item, omit it.

* To add a new line item, insert a new one in the list.

XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
realmId The realmID, also known as the Company ID, uniquely identifies the data for a company. In QuickBooks Online, the Company ID appears on the My Account page. In Data Services for QuickBooks Online, the realmID is required in the URL for most calls.
appKey Application Id.
realmIdPseudonym Pseudonym Realm Id, obtained from the gateway that represents the company.
authIdPseudonym Pseudonym Auth Id, obtained from the gateway that represents the user.
type WindowsEntityType of the object.
requestId The unique request Id
draft Optional. Boolean draft

Saving an IDS object in a draft state prevents it from being synchronized with Quickbooks. Your app might want to save an object in a draft state if the user has not finished entering data, or for some other reason the user does not want to commit the object for synchronization. You may save an object in draft state during a create or update operation by specifying the draft="true" attribute. By default, the Draft attribute is false, which means that the saved object will be synchronized with Quickbooks.
fullResponse Optional. Boolean fullResponse. If this flag is true, it will return the created object, otherwise, it will return an ObjectRef.
Child Elements
<quickbooks-windows:obj>
Map that represents the object to be created.
Return Payload
  • The updated Object or an ObjectRef if the fullResponse flag was null of false.
Exception Payload
QuickBooksRuntimeException when there is a problem with the server. It has a code and a message provided by quickbooks about the error.