Summary: Configuration | Message Processors

org.mule.modules

mule-module-quick-books

1.0.1

Namespace	http://www.mulesoft.org/schema/mule/quickbooks
Schema Location	http://www.mulesoft.org/schema/mule/quickbooks/1.0/mule-quickbooks.xsd
Version	1.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: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:find-objects> Lazily retrieves Objects For details see: Vendor Especification
<quickbooks:get-object> Retrieve objects by ID.
<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.

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/1.0/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 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
Type	Name	Default Value	Description
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
	client		Optional. Quick-Books client.
xs:string	consumerKey		Unique consumer key for the app.
xs:string	consumerSecret		Unique consumer secret for the app.
xs:string	realmId		The realmID, also known as the Company ID, uniquely identifies the data for a company.

Message Processors

<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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
name		User-recognizable name for the account. This name must be unique. When you create a company, you get some default accounts. If you want to create an account, you must provide an account name that does not match the name of any default account.
desc		Optional. Optional. User-entered description of the account. This description helps the book keepers or accountants to decide which journal entries should be posted to this account.
subtype		Detailed classification of the account that specifies the use of this account. The accepted values are defined in QboAccountDetailTypeEnum.
acctNum		Optional. Optional. User-specified account number that help the user to identify the account within the chart of accounts and decide what should be posted to the account.
openingBalance		Optional. Optional. Opening balance amount when you create a new balance sheet account.
openingBalanceDate		Optional. Optional. Date of the opening balance amount when creating a new balance sheet account.
accountParentId		Optional. Optional. If the account is a subaccount, AccountParentId is used to store the ID of the parent account.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Account.

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:create-bill>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
header		Information on the financial transaction of the Bill.
line		Information about a specific good or service purchased for which the payment is demanded as a part of the bill. A bill can have multiple lines.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Bill.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
header		Header information about the BillPayment.
line		List of lines. Specifies the line details for the bill payment.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created BillPayment.

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:create-cash-purchase>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
header		Information about the financial transaction of the entire CashPurchase.
line		List of lines. Information about a specific good or service purchased for which the payment is demanded as a part of the CashPurchase.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created CashPurchase.

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:create-check>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
header		Financial Transaction information that pertains to the entire CheckHeader.
line		List of lines. Information about a specific good or service purchased for which the payment is demanded as a part of the check.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Check.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
header		Financial Transaction information that pertains to the entire CreditCardChargeHeader.
line		List of lines. Information about a specific good or service purchased for which the payment is demanded as a part of the CreditCardCharge purchase.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created CreditCardCharge.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
name		Optional. Optional. Specifies the full name of the customer. If the Name is specified, then GivenName, MiddleName, and FamilyName values are ignored.
givenName		Optional. Specifies the given name or first name of a person. GivenName is a required field only if Name is not sent in the request. If a Name is sent, then the GivenName field is optional.
middleName		Optional. Optional. Specifies the middle name of the person. A person can have zero or more middle names.
familyName		Optional. Optional. Specifies the family name or the last name of the customer.
suffix		Optional. Optional. Suffix appended to the name, Jr., Sr., etc.
dBAName		Optional. Optional. Specifies the "Doing Business As" name of the customer.
showAs		Optional. Optional. Specifies the name of the vendor to be displayed.
webSite		Optional. Valid URI strings. Specifies the customers's Web sites.
salesTermId		Optional. Optional. Specifies the default sales term ID that is to be associated with the customer.
salesTaxCodeId		Optional. QBO only supports the customers being taxable or not, so if this field is "1", the job is taxable. If the field value is null, the job is not taxable. All other values are invalid.
email		Optional. Optional. Valid email strings. Specifies the customers's email addresses.
phone		Optional. Optional. Specifies the phone numbers of the customer. QBO allows mapping of up to 5 phone numbers but only one phone number is permitted for one device type.
address		Optional. Optional. Specifies the physical addresses.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Customer.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
header		Financial transaction information that pertains to the entire Estimate.
line		Information about a specific good or service for which the estimate is being issued.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Estimate.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
header		Provides information that pertains to the entire Invoice.
line		Information about a specific good or service for which the Invoice is being issued.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Invoice.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
name		Optional. Optional. User recognizable name of the Item.
unitPrice		Optional. Optional. Monetary values of the service or product
desc		Optional. Optional. User entered description for the item to further describe the details of service or product.
taxable		Optional. Optional. Indicates whether the item is subject to tax.
incomeAccount		Optional. Optional. Income account reference to be associated with the sales item.
itemParentId		Optional. Optional. The parent item id of current item.
itemParentName		Optional. Optional. Name of parent Item. This field is output only.
purchaseDesc		Optional. Optional. User entered purchase description for the item to further describe the details of the purchase.
purchaseCost		Optional. Optional. The monetary value of the service or product.
expenseAccount		Optional. Optional. Income account reference to be associated with the purchase item.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Item.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
header		Information that pertains to the entire payment.
line		Line details of the receive payment. A receive payment can have multiple lines.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Payment.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
name		User recognizable name for the payment method.
type		Optional. Optional. Type of payment. Specifies if it is a credit card payment type or a non-credit card payment type.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created PaymentMethod.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
header		Groups the elements that are common to the SalesReceipt transaction.
line		Groups the line items for the sales receipt.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created SalesReceipt.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
name		Specifies the user recognizable name for the salesterm.
dueDays		Number of days from the delivery of goods or services till the payment is due. If DueDays is specified, only DiscountDays and DiscountPercent can be additionally specified.
discountDays		Optional. Optional. Number of days for which the discount is applicable, if the payment is made within these days. This value is used only when DueDays is specified.
discountPercent		Optional. Optional. Percentage of discount that is available against a price, if paid within the days specified by DiscountDays. This value is used only when DueDays is specified.
dayOfMonthDue		Payment must be received by the day of the month specified by DayOfMonthDue. This value is used only when DueDays is not specified.
dueNextMonthDays		Optional. Optional. Payment due next month if issued that many days before the DayOfMonthDue. This value is used only when DueDays is not specified.
discountDayOfMonth		Optional. Optional. Discount applies if paid before that day of month. This value is used only when DueDays is not specified.
dateDiscountPercent		Optional. Optional. Percentage of discount that is available against a price, if paid before DiscountDayofMonth. This value is used only when DueDays is not specified.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created SalesTerm.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
name		Optional. Optional. Specifies the full name of the vendor. If the FullName is specified, then GivenName, MiddleName, and FamilyName values are ignored.
givenName		Optional. Specifies the given name or first name of a person. GivenName is a required field only if Name is not sent in the request. If a Name is sent, then the GivenName field is optional.
middleName		Optional. Optional. Specifies the middle name of the vendor. A person can have zero or more middle names.
familyName		Optional. Optional. Specifies the family name or the last name of the vendor.
dBAName		Optional. Optional. Specifies the "Doing Business As" name of the vendor.
showAs		Optional. Optional. Specifies the name of the vendor to be displayed.
webSite		Optional. Optional. Valid URI strings. Specifies the vendor's Web site.
taxIdentifier		Optional. Optional. Specifies the Tax ID of the person or the organization. This is a Personally Identifiable Information (PII) attribute.
acctNum		Optional. Optional. Specifies the account name or the account number that is associated with the vendor.
vendor1099		Optional. Optional. Specifies that the Vendor is an independent contractor, someone who is given a 1099-MISC form at the end of the year. The "1099 Vendor" is paid with regular checks, and taxes are not withheld on the vendor's behalf.
email		Optional. Optional. Valid email strings. Specifies the vendors's email addresses.
phone		Optional. Optional. Specifies the phone numbers of the vendor. QBO allows mapping of up to 5 phone numbers but only one phone number is permitted for one device type.
address		Optional. Optional. Specifies the physical addresses.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Vendor.

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:delete-object>

Deletes an object.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
type		EntityType of the object.
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

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:find-objects>

Lazily retrieves Objects For details see: Vendor Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
type		EntityType of the object.
queryFilter		Optional. String with a filter format (see details)
querySort		Optional. String with a sort format (see details)
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

Iterable of the objects.

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:get-object>

Retrieve objects by ID.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
type		EntityType of the object.
id		Id which is assigned by Data Services when the object is created.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
name		User-recognizable name for the account. This name must be unique. When you create a company, you get some default accounts. If you want to create an account, you must provide an account name that does not match the name of any default account.
desc		Optional. Optional. User-entered description of the account. This description helps the book keepers or accountants to decide which journal entries should be posted to this account.
subtype		Detailed classification of the account that specifies the use of this account. The accepted values are defined in QboAccountDetailTypeEnum.
acctNum		Optional. Optional. User-specified account number that help the user to identify the account within the chart of accounts and decide what should be posted to the account.
openingBalance		Optional. Optional. Opening balance amount when you create a new balance sheet account.
openingBalanceDate		Optional. Optional. Date of the opening balance amount when creating a new balance sheet account.
accountParentId		Optional. Optional. If the account is a subaccount, AccountParentId is used to store the ID of the parent account.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated Account.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
header		Information on the financial transaction of the Bill.
line		Information about a specific good or service purchased for which the payment is demanded as a part of the bill. A bill can have multiple lines.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The created Bill.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
header		Header information about the BillPayment.
line		Specifies the line details for the bill payment. A bill payment can have multiple lines.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated BillPayment.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
header		Information about the financial transaction of the entire CashPurchase.
line		List of lines. Information about a specific good or service purchased for which the payment is demanded as a part of the CashPurchase.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated CashPurchase.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
header		Financial Transaction information that pertains to the entire CheckHeader.
line		List of lines. Information about a specific good or service purchased for which the payment is demanded as a part of the check.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated Check.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
header		Financial Transaction information that pertains to the entire CreditCardChargeHeader.
line		List of lines. Information about a specific good or service purchased for which the payment is demanded as a part of the CreditCardCharge purchase.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated CreditCardCharge.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
name		Optional. Optional. Specifies the full name of the customer. If the Name is specified, then GivenName, MiddleName, and FamilyName values are ignored.
givenName		Optional. Specifies the given name or first name of a person. GivenName is a required field only if Name is not sent in the request. If a Name is sent, then the GivenName field is optional.
middleName		Optional. Optional. Specifies the middle name of the person. A person can have zero or more middle names.
familyName		Optional. Optional. Specifies the family name or the last name of the customer.
suffix		Optional. Optional. Suffix appended to the name, Jr., Sr., etc.
dBAName		Optional. Optional. Specifies the "Doing Business As" name of the customer.
showAs		Optional. Optional. Specifies the name of the vendor to be displayed.
webSite		Optional. Valid URI strings. Specifies the customers's Web sites.
salesTermId		Optional. Optional. Specifies the default sales term ID that is to be associated with the customer.
salesTaxCodeId		Optional. QBO only supports the customers being taxable or not, so if this field is "1", the job is taxable. If the field value is null, the job is not taxable. All other values are invalid.
email		Optional. Optional. Valid email strings. Specifies the customers's email addresses.
phone		Optional. Specifies the phone numbers of the customer. QBO allows mapping of up to 5 phone numbers but only one phone number is permitted for one device type.
address		Optional. Optional. Specifies the physical addresses.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated Customer.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
header		Financial transaction information that pertains to the entire Estimate.
line		Information about a specific good or service for which the estimate is being issued.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated Estimate.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
header		Provides information that pertains to the entire Invoice.
line		Information about a specific good or service for which the Invoice is being issued.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated Invoice.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
name		Optional. Optional. User recognizable name of the Item.
unitPrice		Optional. Optional. Monetary values of the service or product
desc		Optional. Optional. User entered description for the item to further describe the details of service or product.
taxable		Optional. Optional. Indicates whether the item is subject to tax.
incomeAccount		Optional. Optional. Income account reference to be associated with the sales item.
itemParentId		Optional. Optional. The parent item id of current item.
itemParentName		Optional. Optional. Name of parent Item. This field is output only.
purchaseDesc		Optional. Optional. User entered purchase description for the item to further describe the details of the purchase.
purchaseCost		Optional. Optional. The monetary value of the service or product.
expenseAccount		Optional. Optional. Income account reference to be associated with the purchase item.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated Item.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
header		Information that pertains to the entire payment.
line		Line details of the receive payment. A receive payment can have multiple lines.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated Payment.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
name		User recognizable name for the payment method.
type		Optional. Optional. Type of payment. Specifies if it is a credit card payment type or a non-credit card payment type.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated PaymentMethod.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
header		Groups the elements that are common to the SalesReceipt transaction.
line		Groups the line items for the sales receipt.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated SalesReceipt.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
name		Specifies the user recognizable name for the salesterm.
dueDays		Number of days from the delivery of goods or services till the payment is due. If DueDays is specified, only DiscountDays and DiscountPercent can be additionally specified.
discountDays		Optional. Optional. Number of days for which the discount is applicable, if the payment is made within these days. This value is used only when DueDays is specified.
discountPercent		Optional. Optional. Percentage of discount that is available against a price, if paid within the days specified by DiscountDays. This value is used only when DueDays is specified.
dayOfMonthDue		Payment must be received by the day of the month specified by DayOfMonthDue. This value is used only when DueDays is not specified.
dueNextMonthDays		Optional. Optional. Payment due next month if issued that many days before the DayOfMonthDue. This value is used only when DueDays is not specified.
discountDayOfMonth		Optional. Optional. Discount applies if paid before that day of month. This value is used only when DueDays is not specified.
dateDiscountPercent		Optional. Optional. Percentage of discount that is available against a price, if paid before DiscountDayofMonth. This value is used only when DueDays is not specified.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated SalesTerm.

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: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 Especification

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
accessToken		The oauth access token
accessTokenSecret		The oauth secret token
id		Id which is assigned by Data Services when the object is created.
syncToken		Optional. 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.
name		Optional. Optional. Specifies the full name of the vendor. If the FullName is specified, then GivenName, MiddleName, and FamilyName values are ignored.
givenName		Optional. Specifies the given name or first name of a person. GivenName is a required field only if Name is not sent in the request. If a Name is sent, then the GivenName field is optional.
middleName		Optional. Optional. Specifies the middle name of the vendor. A person can have zero or more middle names.
familyName		Optional. Optional. Specifies the family name or the last name of the vendor.
dBAName		Optional. Optional. Specifies the "Doing Business As" name of the vendor.
showAs		Optional. Optional. Specifies the name of the vendor to be displayed.
webSite		Optional. Optional. Valid URI strings. Specifies the vendor's Web site.
taxIdentifier		Optional. Optional. Specifies the Tax ID of the person or the organization. This is a Personally Identifiable Information (PII) attribute.
acctNum		Optional. Optional. Specifies the account name or the account number that is associated with the vendor.
vendor1099		Optional. Optional. Specifies that the Vendor is an independent contractor, someone who is given a 1099-MISC form at the end of the year. The "1099 Vendor" is paid with regular checks, and taxes are not withheld on the vendor's behalf.
email		Optional. Optional. Valid email strings. Specifies the vendors's email addresses.
phone		Optional. Optional. Specifies the phone numbers of the vendor. QBO allows mapping of up to 5 phone numbers but only one phone number is permitted for one device type.
address		Optional. Optional. Specifies the physical addresses.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

The updated Vendor.

Exception Payload

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