org.mule.modules

mule-module-quick-books-online

config

Namespace	http://www.mulesoft.org/schema/mule/quickbooks
Schema Location	http://www.mulesoft.org/schema/mule/quickbooks/current/mule-quickbooks.xsd (View Schema)
Schema Version	4.0
Minimum Mule Version	3.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:config> Configure an instance of this module

Message Processors
<quickbooks:auth-user> Authorize an user using OAuth1.0a
<quickbooks:change-data-deleted> Gets all of the transactions and objects that have been deleted on the Data Services server For details see: ChangeDataDeleted
<quickbooks:create-account> Creates an Account.
<quickbooks:create-bill> Creates a Bill.
<quickbooks:create-bill-payment> Creates a BillPayment.
<quickbooks:create-cash-purchase> Creates a CashPurchase.
<quickbooks:create-check> Creates a Check.
<quickbooks:create-credit-card-charge> Creates a CreditCardCharge.
<quickbooks:create-customer> Creates a Customer.
<quickbooks:create-estimate> Creates an Estimate.
<quickbooks:create-invoice> Creates an Invoice.
<quickbooks:create-item> Creates an Item.
<quickbooks:create-payment> Creates a Payment.
<quickbooks:create-payment-method> Creates a PaymentMethod.
<quickbooks:create-sales-receipt> Creates a SalesReceipt.
<quickbooks:create-sales-term> Creates a SalesTerm.
<quickbooks:create-vendor> Creates a Vendor.
<quickbooks:delete-object> Deletes an object.
<quickbooks:disconnect> Invalidates the OAuth access token in the request, thereby disconnecting the user from QuickBooks for this app.
<quickbooks:find-objects> Lazily retrieves Objects For details see: Vendor Specification
<quickbooks:get-access-token> Extract accessToken
<quickbooks:get-blue-dot-information> Gets blueDot menu information from Intuit
<quickbooks:get-company-metadata> Returns company metadata information.
<quickbooks:get-current-user> Returns current user information such as first name, last name, and email address.
<quickbooks:get-object> Retrieve objects by ID.
<quickbooks:open-id-initialize> Initializes OpenID process
<quickbooks:reconnect> Generates a new OAuth access token and invalidates the OAuth access token used in the request, thereby extending the life span by six months.
<quickbooks:update-account> Updates an Account The Account object represents the accounts that you keep to track your business.
<quickbooks:update-bill> Updates a Bill The Bill object represents an expense to the business.
<quickbooks:update-bill-payment> Updates a BillPayment BillPayment represents the financial transaction of payment of bills that the business owner receives from a vendor for goods or services purchased from the vendor.
<quickbooks:update-cash-purchase> Updates a CashPurchase.
<quickbooks:update-check> Updates a Check.
<quickbooks:update-credit-card-charge> Updates a CreditCardCharge.
<quickbooks:update-customer> Updates a Customer.
<quickbooks:update-estimate> Updates an Estimate.
<quickbooks:update-invoice> Updates an Invoice.
<quickbooks:update-item> Updates an Item.
<quickbooks:update-payment> Updates a Payment.
<quickbooks:update-payment-method> Updates a PaymentMethod.
<quickbooks:update-sales-receipt> Updates a SalesReceipt.
<quickbooks:update-sales-term> Updates a SalesTerm.
<quickbooks:update-vendor> Updates a Vendor.
<quickbooks:verify-open-id> Verify response from Intuit

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="http://www.mulesoft.org/schema/mule/quickbooks"
      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
               http://www.mulesoft.org/schema/mule/quickbooks/current/mule-quickbooks.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 necessary 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
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	accessTokenIdentifierPrefix		Optional. Prefix used for storing credentials in ObjectStore.
xs:string	baseUri	https://qbo.intuit.com/qbo1/rest/user/v2	Optional. The base uri of the quickbooks endpoint, used to fetch the company uri.
	client		Optional. Quick-Books client.
xs:string	consumerKey		API Key
xs:string	consumerSecret		API Secret
	objectStore	_defaultUserObjectStore	Optional. Object store reference
xs:boolean	verifyOpenIdResponse	true	Optional. Specifies if the OpenID response will be verified.

Message Processors

<quickbooks:auth-user>

Authorize an user using OAuth1.0a

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
requestTokenUrl	RequestTokenUrl	String	/	UTF-8
accessTokenUrl	AccessTokenUrl	String	/	UTF-8
authorizationUrl	AuthorizationUrl	String	/	UTF-8
callbackUrl	CallbackUrl for OAuth service	String	/	UTF-8
requestTokenId	Optional. Optional value for identifying the requestToken. If it is not passed the client will use a UUID	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<quickbooks:headers>		Outbound headers	Map<String, Object>

Returns

Return Type	Description
String	Authorize Url

Exception Payloads

Payload Class	Description
ObjectStoreException	from the Object Store instance
OAuthCommunicationException	requesting to OAuth provider
OAuthExpectationFailedException	requesting to OAuth provider
OAuthNotAuthorizedException	requesting to OAuth provider
OAuthMessageSignerException	requesting to OAuth provider

<quickbooks:change-data-deleted>

Gets all of the transactions and objects that have been deleted on the Data Services server For details see: ChangeDataDeleted

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
accessTokenId	Identifier for QuickBooks credentials.	String	/	UTF-8
queryFilter	Optional. String with a filter format (see details). Each type of object to be retrieved, has a list of attributes for which it can be filtered (See this list following the link in the details of the documentation of the create or update method of that object).	String	/	UTF-8
querySort	Optional. String with a sort format (see details). Each type of object to be retrieved, has a list of attributes for which it can be sorted (See this list following the link in the details of the documentation of the create or update method of that object).	String	/	UTF-8

Returns

Return Type	Description
Iterable	Iterable of the objects to be retrieved.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-account>

Creates an Account. The Account object represents the accounts that you keep to track your business. Account is a component of a chart of accounts, and is part of a ledger. You can use Account to record the total monetary amount that is allocated for a specific use. For details see: Account Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
account	#[payload]	Optional. The Quickbooks account to be created.	Account	/

Returns

Return Type	Description
Account	The created Account.

<quickbooks:create-bill>

Creates a Bill. The Bill object represents an expense to the business. For details see: Bill Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
bill	#[payload]	Optional. The bill to be created	Bill	/

Returns

Return Type	Description
Bill	The created Bill.

<quickbooks:create-bill-payment>

Creates a BillPayment. BillPayment represents the financial transaction of payment of bills that the business owner receives from a vendor for goods or services purchased from the vendor. QBO supports bill payments through a credit card or a bank account. For details see: BillPayment Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
billPayment	#[payload]	Optional. The bill payment object	BillPayment	/

Returns

Return Type	Description
BillPayment	The created BillPayment.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-cash-purchase>

Creates a CashPurchase. CashPurchase represents an expense to the business as a cash transaction. For details see: CashPurchase Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
cashPurchase	#[payload]	Optional. The cash purchase to be created	CashPurchase	/

Returns

Return Type	Description
CashPurchase	The created CashPurchase.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-check>

Creates a Check. The Check object represents an expense to the business paid as a check transaction. For details see: Check Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
check	#[payload]	Optional. The check to be created	Check	/

Returns

Return Type	Description
Check	The created Check.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-credit-card-charge>

Creates a CreditCardCharge. The CreditCardCharge object represents an expense to the business as a credit card charge transaction. CreditCardCharge must have the total expense equal to the total expense of line items. For details see: CreditCardCharge Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
creditCardCharge	#[payload]	Optional. The credit card charge to be created	CreditCardCharge	/

Returns

Return Type	Description
CreditCardCharge	The created CreditCardCharge.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-customer>

Creates a Customer. The Customer object represents the consumer of the service or the product that your business offers. QBO allows categorizing the customers in a way that is meaningful to the business. For details see: Customer Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
customer	#[payload]	Optional. The customer to be created	Customer	/

Returns

Return Type	Description
Customer	The created Customer.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-estimate>

Creates an Estimate. The Estimate object represents a proposal for a financial transaction from a business to a customer for goods or services proposed to be sold, including proposed pricing. It is also known as quote. For details see: Estimate Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
estimate	#[payload]	Optional. The estimate to be created	Estimate	/

Returns

Return Type	Description
Estimate	The created Estimate.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-invoice>

Creates an Invoice. The Invoice object represents an invoice to a customer. Invoice could be based on salesterm with invoice and due dates for payment. Invoice supports tax, but as of now shipping charges are not supported. Invoice can be printed and emailed to a customer. For details see: Invoice Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
invoice	#[payload]	Optional. The invoice to be created	Invoice	/

Returns

Return Type	Description
Invoice	The created Invoice.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-item>

Creates an Item. The Item object represents any product or service that is sold or purchased. Inventory items are not currently supported. For details see: Item Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
item	#[payload]	Optional. The item to be created	Item	/

Returns

Return Type	Description
Item	The created Item.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-payment>

Creates a Payment. The Payment object represents the financial transaction that signifies a payment from a customer for one or more sales transactions. For details see: Payment Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
payment	#[payload]	Optional. The payment to be created	Payment	/

Returns

Return Type	Description
Payment	The created Payment.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-payment-method>

Creates a PaymentMethod. PaymentMethod represents the method of payment for a transaction. It can be a credit card payment type or a non-credit card payment type. For details see: PaymentMethod Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
paymentMethod	#[payload]	Optional. The payment method to be created	PaymentMethod	/

Returns

Return Type	Description
PaymentMethod	The created PaymentMethod.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-sales-receipt>

Creates a SalesReceipt. The Payment object represents the financial transaction that signifies a payment from a customer for one or more sales transactions. For details see: SalesReceipt Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
salesReceipt	#[payload]	Optional. The sales receipt to be created	SalesReceipt	/

Returns

Return Type	Description
SalesReceipt	The created SalesReceipt.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-sales-term>

Creates a SalesTerm. The SalesTerm object represents the terms under which a sale is made. SalesTerm is typically expressed in the form of days due after the goods are received. There is an optional discount part of the sales term, where a discount of total amount can automatically be applied if payment is made within a few days of the stipulated time. For details see: SalesTerm Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
salesTerm	#[payload]	Optional. The sales term to be created	SalesTerm	/

Returns

Return Type	Description
SalesTerm	The created SalesTerm.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:create-vendor>

Creates a Vendor. The Vendor object represents the buyer from whom you purchase any service or product for your organization. For details see: Vendor Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
vendor	#[payload]	Optional. The vendor to be created	Vendor	/

Returns

Return Type	Description
Vendor	The created Vendor.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:delete-object>

Deletes an object.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
type		EntityType of the object.	OnlineEntityType	/
id	#[payload]	Optional. Id which is assigned by Data Services when the object is created.	IdType	/
syncToken		Optional. Integer that indicates how many times the object has been updated. Before performing the update, Data Services verifies that the SyncToken in the request has the same value as the SyncToken in the Data Service's repository.	String	/	UTF-8

<quickbooks:disconnect>

Invalidates the OAuth access token in the request, thereby disconnecting the user from QuickBooks for this app.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Credentials identifier for the user information to be requested	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the user was disconnect from QBO

<quickbooks:find-objects>

Lazily retrieves Objects For details see: Vendor Specification

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
accessTokenId	Identifier for QuickBooks credentials.	String	/	UTF-8
type	EntityType of the object.	OnlineEntityType	/
queryFilter	Optional. String with a filter format (see details). Each type of object to be retrieved, has a list of attributes for which it can be filtered (See this list following the link in the details of the documentation of the create or update method of that object).	String	/	UTF-8
querySort	Optional. String with a sort format (see details). Each type of object to be retrieved, has a list of attributes for which it can be sorted (See this list following the link in the details of the documentation of the create or update method of that object).	String	/	UTF-8

Returns

Return Type	Description
Iterable	Iterable of the objects to be retrieved.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:get-access-token>

Extract accessToken

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
apiUrl		Optional. API URL	String	/	UTF-8
verifier	#[message.inboundProperties.oauth_verifier]	Optional. OAuth verifier. It comes within the callback. The default value is "#[header:inbound:oauth_verifier]"	String	/	UTF-8
requestTokenId	#[message.inboundProperties.userId]	Optional. Id used for identifying the authorized request token. It comes within the callback. By default the query string parameter is userId	String	/	UTF-8
userIdentifier	#[message.inboundProperties.realmId]	Optional. Id used for store the accessToken in the Object Store. By default the value is the realmId	String	/	UTF-8

Returns

Return Type	Description
OAuthCredentials	credentials user credentials

Exception Payloads

Payload Class	Description
ObjectStoreException	from the object store instance
OAuthCommunicationException	requesting to OAuth provider
OAuthExpectationFailedException	requesting to OAuth provider
OAuthNotAuthorizedException	requesting to OAuth provider
OAuthMessageSignerException	requesting to OAuth provider

<quickbooks:get-blue-dot-information>

Gets blueDot menu information from Intuit

XML Sample

INCLUDE_ERROR

Attributes

Name Default Value Description Java Type MIME Type Encoding

config-ref Optional. Specify which configuration to use.

accessTokenId Credentials identifier for the user information to be requested String */* UTF-8

regex

intuitPlatformOpenOtherApp\\((.+?)\\)\ style=\'background-image: url\\((.+?)\\)

Optional. Regex for extracting the information

The regex has to extract the information in this way:

match[0]: "appId,appName,contextArea"

match[1]: "logoImageUrl"

The method will split the application information to generate the @link{AppMenuInformation} object

String

*/*

UTF-8

Returns

Return Type	Description
List<AppMenuInformation>	list with AppMenu information from Intuit

<quickbooks:get-company-metadata>

Returns company metadata information. For details see: CompanyMetaData

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8

Returns

Return Type	Description
Object	company metadata

<quickbooks:get-current-user>

Returns current user information such as first name, last name, and email address. For details see: CurrentUserAPI

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8

Returns

Return Type	Description
UserInformation	current user information

<quickbooks:get-object>

Retrieve objects by ID.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
type		EntityType of the object.	OnlineEntityType	/
id	#[payload]	Optional. Id which is assigned by Data Services when the object is created.	IdType	/

Returns

Return Type	Description
Object	The object.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:open-id-initialize>

Initializes OpenID process

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
providerUrl	https://openid.intuit.com/OpenId/Provider	Optional. OpenID provider url	String	/	UTF-8
callbackUrl		OpenID callbackUrl. It has to point to an endpoint callback to process the response	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<quickbooks:headers>		OpenId response headers	Map<String, Object>

Returns

Return Type	Description
String	url to redirect the user

Exception Payloads

Payload Class	Description
ObjectStoreException	if the operation cannot store the OpenIDManagers

<quickbooks:reconnect>

Generates a new OAuth access token and invalidates the OAuth access token used in the request, thereby extending the life span by six months. Because accessing QuickBooks data requires a valid access token, when the OAuth access token is renewed, your app can continue to access the user's QuickBooks company data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Credentials identifier for the user information to be requested	String	/	UTF-8

Exception Payloads

Payload Class	Description
ObjectStoreException	if the credentials store failed

<quickbooks:update-account>

Updates an Account The Account object represents the accounts that you keep to track your business. Account is a component of a chart of accounts, and is part of a ledger. You can use Account to record the total monetary amount that is allocated for a specific use. 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 see: Account Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
account	#[payload]	Optional. The account to be updated	Account	/

Returns

Return Type	Description
Account	The updated Account.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-bill>

Updates a Bill The Bill object represents an expense to the business. 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 see: Bill Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
bill	#[payload]	Optional. The bill to be updated	Bill	/

Returns

Return Type	Description
Bill	The updated Bill.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-bill-payment>

Updates a BillPayment BillPayment represents the financial transaction of payment of bills that the business owner receives from a vendor for goods or services purchased from the vendor. QBO supports bill payments through a credit card or a bank account. 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 see: BillPayment Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
billPayment	#[payload]	Optional. Bill payment to be updated	BillPayment	/

Returns

Return Type	Description
BillPayment	The updated BillPayment.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-cash-purchase>

Updates a CashPurchase. CashPurchase represents an expense to the business as a cash transaction. 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 see: CashPurchase Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
cashPurchase	#[payload]	Optional. The cash purchase to be updated	CashPurchase	/

Returns

Return Type	Description
CashPurchase	The updated CashPurchase.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-check>

Updates a Check. The Check object represents an expense to the business paid as a check transaction. 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 see: Check Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
check	#[payload]	Optional. The check to be updated	Check	/

Returns

Return Type	Description
Check	The updated Check.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-credit-card-charge>

Updates a CreditCardCharge. The CreditCardCharge object represents an expense to the business as a credit card charge transaction. CreditCardCharge must have the total expense equal to the total expense of line items. 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 see: CreditCardCharge Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
creditCardCharge	#[payload]	Optional. The credit card charge to be updated	CreditCardCharge	/

Returns

Return Type	Description
CreditCardCharge	The updated CreditCardCharge.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-customer>

Updates a Customer. The Customer object represents the consumer of the service or the product that your business offers. QBO allows categorizing the customers in a way that is meaningful to the business. 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 see: Customer Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
customer	#[payload]	Optional. The customer to be updated	Customer	/

Returns

Return Type	Description
Customer	The updated Customer.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-estimate>

Updates an Estimate. The Estimate object represents a proposal for a financial transaction from a business to a customer for goods or services proposed to be sold, including proposed pricing. It is also known as quote. 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 see: Estimate Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
estimate	#[payload]	Optional. The estimate to be updated	Estimate	/

Returns

Return Type	Description
Estimate	The updated Estimate.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-invoice>

Updates an Invoice. The Invoice object represents an invoice to a customer. Invoice could be based on salesterm with invoice and due dates for payment. Invoice supports tax, but as of now shipping charges are not supported. Invoice can be printed and emailed to a customer. 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 see: Invoice Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
invoice	#[payload]	Optional. The invoice to be updated	Invoice	/

Returns

Return Type	Description
Invoice	The updated Invoice.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-item>

Updates an Item. The Item object represents any product or service that is sold or purchased. Inventory items are not currently supported. 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 see: Item Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
item	#[payload]	Optional. The item to be updated	Item	/

Returns

Return Type	Description
Item	The updated Item.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-payment>

Updates a Payment. The Payment object represents the financial transaction that signifies a payment from a customer for one or more sales transactions. 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 see: Payment Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
payment	#[payload]	Optional. The payment to be updated	Payment	/

Returns

Return Type	Description
Payment	The updated Payment.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-payment-method>

Updates a PaymentMethod. PaymentMethod represents the method of payment for a transaction. It can be a credit card payment type or a non-credit card payment type. 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 see: PaymentMethod Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
paymentMethod	#[payload]	Optional. The payment method to be updated	PaymentMethod	/

Returns

Return Type	Description
PaymentMethod	The updated PaymentMethod.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-sales-receipt>

Updates a SalesReceipt. The Payment object represents the financial transaction that signifies a payment from a customer for one or more sales transactions. 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 see: SalesReceipt Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
salesReceipt	#[payload]	Optional. The sales receipt	SalesReceipt	/

Returns

Return Type	Description
SalesReceipt	The updated SalesReceipt.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-sales-term>

Updates a SalesTerm. The SalesTerm object represents the terms under which a sale is made. SalesTerm is typically expressed in the form of days due after the goods are received. There is an optional discount part of the sales term, where a discount of total amount can automatically be applied if payment is made within a few days of the stipulated time. 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 see: SalesTerm Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
salesTerm	#[payload]	Optional. The sales term to be updated	SalesTerm	/

Returns

Return Type	Description
SalesTerm	The updated SalesTerm.

Exception Payloads

Payload Class	Description
QuickBooksRuntimeException	when there is a problem with the server. It has a code and a message provided by quickbooks about the error.

<quickbooks:update-vendor>

Updates a Vendor. The Vendor object represents the buyer from whom you purchase any service or product for your organization. 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 see: Vendor Specification

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
accessTokenId		Identifier for QuickBooks credentials.	String	/	UTF-8
vendor	#[payload]	Optional. The vendor to be updated	Vendor	/

Returns

Return Type	Description
Vendor	The updated Vendor.

<quickbooks:verify-open-id>

Verify response from Intuit

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
muleMessage	Injected MuleMessage	MuleMessage	/
receivingUrl	Optional. Url from OpenID provider. If it is not provided the processor will extract it from the Mule message	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<quickbooks:response-parameters>	#[header:INBOUND:http.query.params]	Optional. Response parameters from Intuit. It process a map with all the OpenID attributes sent from Intuit.	Map<String, String>

Returns

Return Type	Description
OpenIDCredentials	OpenID credentials for the authenticated user

Exception Payloads

Payload Class	Description
MessageException	from OpenID manager
ObjectStoreException	if the operation cannot retrieve OpenID managers from ObjectStore