CreditMemo Class

Properties Methods Events Config Settings Errors

A CreditMemo indicates that a CUSTOMER is owed money by the QuickBooks company. A CreditMemo is the opposite of an INVOICE .

Syntax

class inqb.CreditMemo

Remarks

The CreditMemo class represents a credit memo sent to a Customer. When a CreditMemo is added, the total amount is automatically entered into the Accounts Receivable register.

Required Fields (Add): Customer*, Items

Supported Methods: Add, Get (Id), Cancel, Delete DueDate, SalesRep*, FOB, ShipMethod, TaxItem, and CustomerSalesTax.

Example CreditMemo1.CustomerName = "John Q. Customer" '* CreditMemo1.TransactionDate = "1/17/03" CreditMemo1.ItemCount = 1 CreditMemo1.ItemName(0) = "Our Company's Product" '* CreditMemo1.ItemAmount(0) = "140.00" CreditMemo1.Add() '*: Item must already exist in QuickBooks.

total_amount is the total of the item lines. It is computed automatically, and should never be set.

Item Lines: Item lines are used to track the sale of goods or services. Line items may be added by first setting ItemCount. Then for each line set the Item Id (or Name) or Group. You may also optionally set the Rate/RatePercent/PriceLevel, Quantity, Description, Class, TaxCode, ServiceDate, and Amount for each item as well.

The class supports a variety of other operations as well. The class's get, cancel, and delete methods may be used to retrieve, cancel, and delete CreditMemos, respectively. The ObjSearch Class may be used to search for CreditMemos in the QuickBooks database.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


ar_account_id	Reference to the Accounts Receivable account where money goes.
ar_account_name	Reference to the Accounts Receivable account where money goes.
billing_address	Address to bill to.
customer_id	A reference to the customer or customer job.
customer_message_id	Reference to message to appear to customer.
customer_message_name	Reference to message to appear to customer.
customer_name	A reference to the customer or customer job.
due_date	Date when payment is due.
include_linked_txns	Indicates whether to include linked transactions in the response.
is_pending	If true, this transaction has not been completed.
is_to_be_printed	Whether this transaction is to be printed.
item_count	The number of records in the Item arrays.
item_aggregate	Contains an XML aggregate of the line item.
item_amount	Line item property: the total amount of this item.
item_class_id	Line item property: Reference to the class of the item.
item_class_name	Line item property: Reference to the class of the item.
item_description	Line item property: Description of item.
item_group_id	Reference to a group of line items.
item_group_name	Reference to a group of line items.
item_id	Line item property: Reference to the kind of item.
item_name	Line item property: Reference to the kind of item.
item_line_id	Identification number of the transaction line, used for Updates.
item_other1	Standard QuickBooks Custom Field available for transaction line items.
item_other2	Standard QuickBooks Custom Field available for transaction line items.
item_override_account_id	An account which will override the default account for the line item.
item_override_account_name	An account which will override the default account for the line item.
item_price_level_id	Line Item property: Used to specify custom pricing for specific customers.
item_price_level_name	Line Item property: Specify custom pricing for specific customers.
item_quantity	Line item property: Quantity of item or item group.
item_rate	Unit rate of item.
item_rate_percent	Line item property: A markup or discount percentage.
item_service_date	Line item property: Date of service.
item_tax_code_id	Line item property: Sales tax information for this item.
item_tax_code_name	Line item property: Sales tax information for this item.
item_unit_of_measure	Unit of measure describing the Quantity .
linked_txn_count	The number of records in the LinkedTxn arrays.
linked_txn_amount	The amount of the linked transaction.
linked_txn_date	The date of the linked transaction.
linked_txn_link_type	Indicates the nature of the link between the transactions.
linked_txn_ref_number	This is the reference number assigned to the linked transaction.
linked_txn_id	This property can be used by another class to reference the original transaction which is linked to the current response.
linked_txn_type	This property indicates which type of linked transaction has been returned.
memo	Memo to appear on internal reports only.
po_number	P.O. number.
qb_connection_string	An aggregate consisting of various QuickBooks connection properties.
qb_request_aggregate	The request aggregate.
qb_request_id	The Id of the next message to be sent to QuickBooks.
qb_request_mode	Defines whether the request is made online or stored offline.
qb_response_aggregate	The last QBXML response aggregate received from QuickBooks.
qbxml_version	The version of QBXML used in the outgoing message.
ref_id	An alphanumerical identifier generated by the server.
ref_number	Reference number for the transaction.
sales_rep_id	Reference to (initials of) sales rep.
sales_rep_name	Reference to (initials of) sales rep.
sales_tax_total	Total amount of sales tax.
ship_date	Date of shipping.
ship_method_id	Reference to preferred method of shipping.
ship_method_name	Reference to preferred method of shipping.
shipping_address	Address to ship to.
subtotal	Gross subtotal; doesn't count taxes/amount already paid.
tax_item_id	Reference to detailed taxation information.
tax_item_name	Reference to detailed taxation information.
terms_id	Reference to terms of payment.
terms_name	Reference to terms of payment.
total_amount	Subtotal + SalesTaxTotal.
transaction_date	Date of transaction.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


add	Adds the record into QuickBooks.
cancel	Cancels (voids) the transaction.
check_request_status	Checks whether or not the specified request was processed by QuickBooks.
close_qb_connection	Closes a persistent connection to QuickBooks.
config	Sets or retrieves a configuration setting.
delete	Deletes the record from QuickBooks.
get	Gets a single record from QuickBooks.
get_custom_field	Gets a custom field value from QuickBooks.
import_qbxml	Imports a QBXML response aggregate.
open_qb_connection	Opens a persistent connection to QuickBooks.
reset	Resets all properties to their defaults.
set_custom_field	Sets a custom field value within QuickBooks.
update	Updates the bill in QuickBooks.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


on_error	Information about errors during data delivery.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.
on_status	Shows the progress of the QuickBooks connection.
on_warning	Fired when a warning occurs.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


AppendAfter	Appends an XML tag after the specified QBXML element.
AuthFlags	Connection Flags (use for QuickBooks Simple Start).
ClassId	A reference to the class of transaction.
ClassName	A reference to the class of transaction.
CreditRemaining	Available Credit.
CustomerSalesTaxId	Reference to sales tax information for the CUSTOMER.
CustomerSalesTaxName	Reference to sales tax information for the CUSTOMER.
EditSequence	An identifier for this copy of the object.
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields.
ExchangeRate	Indicates the exchange rate for the transaction.
FirstName	A first name.
FOB	Freight On Board: the place from where shipped.
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersion	Returns the version of the QB Request Processor that is installed on your system.
GetSupportedVersions	Returns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnly	This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
IsToBeEmailed	When true, if no email address is on file for the customer the transaction will fail.
Items[index].OverrideItemAccountId	An account which will override the default account for the line item.
Items[index].OverrideItemAccountName	An account which will override the default account for the line item.
LastName	A last name.
MiddleInitial	A middle initial.
PersonalDataPref	Whether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionMode	The mode of connection to QuickBooks.
QBFileStatus	The status of the company file as it pertains to accepting connections.
QBOpenCompanyFile	The file currently open in QuickBooks.
SalesTaxPercentage	Percent paid as sales tax.
Salutation	A salutation, such as Mr., Mrs., etc.
SendRawXML	Sends specified XML to quickbooks without modification.
SeparateContact	A contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName.
SSLAcceptServerCert	The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).
SSLAcceptServerCertFile	The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
StopOnError	Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.
Tax1Total	Canadian field used for Goods and Services Tax, or GST.
Tax2Total	Canadian field used for Provincial Sales Taxes, or PST.
TemplateId	The ID of an existing template to apply to the transaction.
TemplateName	The name of an existing template to apply to the transaction.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.
UnattendedModePref	Whether connecting while QuickBooks is closed is required or optional for the user.
WarningCodes	A comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

ar_account_id Property

Reference to the Accounts Receivable account where money goes.

Syntax

def get_ar_account_id() -> str: ...
def set_ar_account_id(value: str) -> None: ...

ar_account_id = property(get_ar_account_id, set_ar_account_id)

Default Value

Remarks

A reference to the Accounts Receivable account where the money received from this transaction will go.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

ar_account_name Property

Reference to the Accounts Receivable account where money goes.

Syntax

def get_ar_account_name() -> str: ...
def set_ar_account_name(value: str) -> None: ...

ar_account_name = property(get_ar_account_name, set_ar_account_name)

Default Value

Remarks

A reference to the Accounts Receivable account where the money received from this transaction will go.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

billing_address Property

Address to bill to.

Syntax

def get_billing_address() -> str: ...
def set_billing_address(value: str) -> None: ...

billing_address = property(get_billing_address, set_billing_address)

Default Value

Remarks

The address to bill to.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address class to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

customer_id Property

A reference to the customer or customer job.

Syntax

def get_customer_id() -> str: ...
def set_customer_id(value: str) -> None: ...

customer_id = property(get_customer_id, set_customer_id)

Default Value

Remarks

The Customer property indicates the Customer who has purchased goods or services from the company.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

Either CustomerId or customer_name is required.

customer_message_id Property

Reference to message to appear to customer.

Syntax

def get_customer_message_id() -> str: ...
def set_customer_message_id(value: str) -> None: ...

customer_message_id = property(get_customer_message_id, set_customer_message_id)

Default Value

Remarks

A reference to a predefined message that will appear to the customer.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

customer_message_name Property

Reference to message to appear to customer.

Syntax

def get_customer_message_name() -> str: ...
def set_customer_message_name(value: str) -> None: ...

customer_message_name = property(get_customer_message_name, set_customer_message_name)

Default Value

Remarks

A reference to a predefined message that will appear to the customer.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

customer_name Property

A reference to the customer or customer job.

Syntax

def get_customer_name() -> str: ...
def set_customer_name(value: str) -> None: ...

customer_name = property(get_customer_name, set_customer_name)

Default Value

Remarks

The customer property indicates the Customer who has purchased goods or services from the company.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

Either customer_id or CustomerName is required.

due_date Property

Date when payment is due.

Syntax

def get_due_date() -> str: ...
def set_due_date(value: str) -> None: ...

due_date = property(get_due_date, set_due_date)

Default Value

Remarks

Appears in a variety of transactions. The date when payment is due.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

include_linked_txns Property

Indicates whether to include linked transactions in the response.

Syntax

def get_include_linked_txns() -> bool: ...
def set_include_linked_txns(value: bool) -> None: ...

include_linked_txns = property(get_include_linked_txns, set_include_linked_txns)

Default Value

FALSE

Remarks

If you set include_linked_txns to true, then the returned object will include a list of all the transactions linked to the queried object (this list is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items). Each linked transaction will be represented by a LinkedTxn aggregate, which will be parsed by the class into the following properties:

LinkedTxnCount
linked_txn_amount
linked_txn_date
linked_txn_id
linked_txn_link_type
linked_txn_ref_number
linked_txn_type

is_pending Property

If true, this transaction has not been completed.

Syntax

def get_is_pending() -> bool: ...
def set_is_pending(value: bool) -> None: ...

is_pending = property(get_is_pending, set_is_pending)

Default Value

FALSE

Remarks

If set to true, this transaction (an Invoice, SalesReceipt, or CreditMemo) has not been completed. Pending sales might include unpaid orders, sales of back-ordered items, etc.

is_to_be_printed Property

Whether this transaction is to be printed.

Syntax

def get_is_to_be_printed() -> bool: ...
def set_is_to_be_printed(value: bool) -> None: ...

is_to_be_printed = property(get_is_to_be_printed, set_is_to_be_printed)

Default Value

FALSE

Remarks

Indicates whether or not the transaction is to be printed. If set to true, the "To Be Printed" box in the QuickBooks user interface will be checked.

item_count Property

The number of records in the Item arrays.

Syntax

def get_item_count() -> int: ...
def set_item_count(value: int) -> None: ...

item_count = property(get_item_count, set_item_count)

Default Value

Remarks

This property controls the size of the following arrays:

item_aggregate
item_amount
item_class_id
item_class_name
item_description
item_group_id
item_group_name
item_id
item_line_id
item_name
item_other1
item_other2
item_override_account_id
item_override_account_name
item_price_level_id
item_price_level_name
item_quantity
item_rate
item_rate_percent
item_service_date
item_tax_code_id
item_tax_code_name
item_unit_of_measure

The array indices start at 0 and end at item_count - 1.

item_aggregate Property

Contains an XML aggregate of the line item.

Syntax

def get_item_aggregate(item_index: int) -> str: ...
def set_item_aggregate(item_index: int, value: str) -> None: ...

Default Value

Remarks

Contains an XML aggregate of the line item. If the line item has not been modified since receiving a response from QuickBooks, the exact LineRet aggregate that QuickBooks returned will be contained in this XML aggregate. However, if you have made changes to the this line item's properties the item_aggregate property will re-generate the line item XML with the new data.

If you set the other line item properties and then query the item_aggregate, a LineRet aggregate will be generated from the currently set properties.

You may set this property with raw xml. So long as you do not modify any other properties (forcing the line item to regenerate based on new changes), the xml will be sent as-is to the QuickBooks request processor. It is essential that you properly format the XML that you place in this property. When setting this property manually, the class will send exactly what you have set. You must ensure your xml is appropriate for the action you are attempting. For instance, if you are Adding an Invoice, you must ensure the outer tags are "InvoiceLineAdd". If Modifying an Invoice, the outer tags must be "InvoiceLineMod".

If you do not expressly set the item_aggregate field with your own custom XML, all of this will be taken care of you automatically by the class.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_amount Property

Line item property: the total amount of this item.

Syntax

def get_item_amount(item_index: int) -> str: ...
def set_item_amount(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: the total amount of this item.

This property represents the total amount of a transaction line. If item_rate, item_cost and/or item_quantity are specified the item_amount will be automatically computed by QuickBooks.

Whether item_rate or item_cost is used will depend on the transaction type. item_rate is available for CreditMemo, Estimate, Invoice, PurchaseOrder, SalesOrder, and SalesReceipt transactions while item_cost is available for Bill, CCCharge, CCCredit, Check, ItemReceipt, and VendorCredit transactions.

The amount should be formatted as a string in dollars.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_class_id Property

Line item property: Reference to the class of the item.

Syntax

def get_item_class_id(item_index: int) -> str: ...
def set_item_class_id(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: Reference to the class of the item.

A reference to the class of this item.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_class_name Property

Line item property: Reference to the class of the item.

Syntax

def get_item_class_name(item_index: int) -> str: ...
def set_item_class_name(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: Reference to the class of the item.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_description Property

Line item property: Description of item.

Syntax

def get_item_description(item_index: int) -> str: ...
def set_item_description(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: Description of item.

A string description of the Item specified by item_name or item_id.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_group_id Property

Reference to a group of line items.

Syntax

def get_item_group_id(item_index: int) -> str: ...
def set_item_group_id(item_index: int, value: str) -> None: ...

Default Value

Remarks

Reference to a group of line items.

Line item groups represent sets of items that are grouped together. A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index.

When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular properties (total item_amount, item_quantity, and item_description), but the line items returned are not accessible with this object. However, you may parse the returned line items by passing the contents of the item_aggregate property to the LineItemGroups class. You may use the LineItemGroups class to view or change the contents of the line items, and then pass the xml aggregate generated by the class back to the item_aggregate field to use in an Update transaction.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_group_name Property

Reference to a group of line items.

Syntax

def get_item_group_name(item_index: int) -> str: ...
def set_item_group_name(item_index: int, value: str) -> None: ...

Default Value

Remarks

Reference to a group of line items.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_id Property

Line item property: Reference to the kind of item.

Syntax

def get_item_id(item_index: int) -> str: ...
def set_item_id(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: Reference to the kind of item.

Line items represent goods or services bought in a QuickBooks transaction.

Each line item is represented by a number of properties, each prefixed by Item (see the list of properties for individual classs for details). Properties such as item_quantity and item_description are always present; some properties are found in only certain types of transactions.

Item is a reference to a kind of item, predefined within QuickBooks. Generally items defined within QuickBooks have default values for item_description, etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically.

This class is used to create a single item. However, any InQB class may be set with an unlimited number of these items. For example:

Invoice.ItemCount = 3 LineItems.ItemName = "Wingnut" LineItems.Quantity = 8 Invoice.ItemAggregate[0] = LineItems.GetAggregate() LineItems.ItemName = "Shovel" LineItems.Quantity = 1 Invoice.ItemAggregate[1] = LineItems.GetAggregate() LineItems.ItemName = "Mower blade" LineItems.Quantity = 1 Invoice.ItemAggregate[2] = LineItems.GetAggregate()

Items may also be grouped into ItemGroups, using the LineItemGroups class.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_name Property

Line item property: Reference to the kind of item.

Syntax

def get_item_name(item_index: int) -> str: ...
def set_item_name(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: Reference to the kind of item.

Line items represent goods or services bought in a QuickBooks transaction.

This class is used to create a single item. However, any InQB class may be set with an unlimited number of these items. For example:

Items may also be grouped into ItemGroups, using the LineItemGroups class.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_line_id Property

Identification number of the transaction line, used for Updates.

Syntax

def get_item_line_id(item_index: int) -> str: ...
def set_item_line_id(item_index: int, value: str) -> None: ...

Default Value

Remarks

Identification number of the transaction line, used for Updates.

If you need to add a new transaction line in a transaction Update request, you can do so by setting the item_line_id to -1.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_other1 Property

Standard QuickBooks Custom Field available for transaction line items.

Syntax

def get_item_other1(item_index: int) -> str: ...
def set_item_other1(item_index: int, value: str) -> None: ...

Default Value

Remarks

Standard QuickBooks Custom Field available for transaction line items.

The item_other1 and item_other2 custom fields are available for immediate use: you don't need to enable these in the transaction template to be able to access them via SDK. (However, those item_other1 and item_other2 fields and their values are viewable and printable in QuickBooks only if the transaction template has these enabled!). QBXMLVersion 6.0 or higher is required to use this property.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_other2 Property

Standard QuickBooks Custom Field available for transaction line items.

Syntax

def get_item_other2(item_index: int) -> str: ...
def set_item_other2(item_index: int, value: str) -> None: ...

Default Value

Remarks

Standard QuickBooks Custom Field available for transaction line items.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_override_account_id Property

An account which will override the default account for the line item.

Syntax

def get_item_override_account_id(item_index: int) -> str: ...
def set_item_override_account_id(item_index: int, value: str) -> None: ...

Default Value

Remarks

An account which will override the default account for the line item. qbxml_version must be 2.0 or higher to use this configuration setting.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_override_account_name Property

An account which will override the default account for the line item.

Syntax

def get_item_override_account_name(item_index: int) -> str: ...
def set_item_override_account_name(item_index: int, value: str) -> None: ...

Default Value

Remarks

An account which will override the default account for the line item. qbxml_version must be 2.0 or higher to use this configuration setting.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_price_level_id Property

Line Item property: Used to specify custom pricing for specific customers.

Syntax

def get_item_price_level_id(item_index: int) -> str: ...
def set_item_price_level_id(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line Item property: Used to specify custom pricing for specific customers.

Id for the PriceLevel selected for this transaction.

If item_price_level_id and/or item_price_level_name are specified, then item_amount will be calculated automatically and should not be specified.

Note that item_price_level_id and item_price_level_name, OR item_rate OR item_rate_percent may be specified. item_price_level_id and item_price_level_name are ONLY available for QBXMLVersions 4.0 and above.

You can use price levels to specify custom pricing for specific customers. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc.)

The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders.

Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the item_rate, which was set using the price level.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_price_level_name Property

Line Item property: Specify custom pricing for specific customers.

Syntax

def get_item_price_level_name(item_index: int) -> str: ...
def set_item_price_level_name(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line Item property: Specify custom pricing for specific customers.

Id for the PriceLevel selected for this transaction.

If item_price_level_id and/or item_price_level_name are specified, then item_amount will be calculated automatically and should not be specified.

The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders.

Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the item_rate, which was set using the price level.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_quantity Property

Line item property: Quantity of item or item group.

Syntax

def get_item_quantity(item_index: int) -> str: ...
def set_item_quantity(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: Quantity of item or item group.

The quantity of the Item specified in this line.

If item_quantity and only one of item_cost, item_rate, or item_amount are specified, QuickBooks will automatically calculate the other.

This property is a String type in order to allow setting fractional quantities. Setting this property with non-numeric data will cause an error. Correct usage of this property is shown below:

class.Quantity = "3.5"

Leave this property blank and no quantity will be sent to QuickBooks.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_rate Property

Unit rate of item.

Syntax

def get_item_rate(item_index: int) -> str: ...
def set_item_rate(item_index: int, value: str) -> None: ...

Default Value

Remarks

Unit rate of item.

The unit rate charged for this item.

If item_amount is specified, then item_rate will be calculated automatically and should not be specified.

The amount should be formatted as a string in dollars.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_rate_percent Property

Line item property: A markup or discount percentage.

Syntax

def get_item_rate_percent(item_index: int) -> str: ...
def set_item_rate_percent(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: A markup or discount percentage.

If item_rate_percent is specified instead of item_rate, then this line item represents a percentage markup or discount, to be applied to the previous Item or Item group.

item_rate_percent should be formatted as a positive or negative integer; a positive value indicates a markup.

Only one of item_rate_percent and item_rate may be specified. If item_rate_percent is set, then item_rate will be set to its default.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_service_date Property

Line item property: Date of service.

Syntax

def get_item_service_date(item_index: int) -> str: ...
def set_item_service_date(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: Date of service.

For Items that represent a service, item_service_date refers to the date of service. item_service_date is only applicable for the CreditMemo, Invoice, PurchaseOrder, and SalesReceipt classs.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_tax_code_id Property

Line item property: Sales tax information for this item.

Syntax

def get_item_tax_code_id(item_index: int) -> str: ...
def set_item_tax_code_id(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: Sales tax information for this item.

This is a reference to a sales tax code predefined within QuickBooks.

By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_tax_code_name Property

Line item property: Sales tax information for this item.

Syntax

def get_item_tax_code_name(item_index: int) -> str: ...
def set_item_tax_code_name(item_index: int, value: str) -> None: ...

Default Value

Remarks

Line item property: Sales tax information for this item.

This is a reference to a sales tax code predefined within QuickBooks.

By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_unit_of_measure Property

Unit of measure describing the Quantity .

Syntax

def get_item_unit_of_measure(item_index: int) -> str: ...
def set_item_unit_of_measure(item_index: int, value: str) -> None: ...

Default Value

Remarks

Unit of measure describing the item_quantity.

In a transaction line item, the name of the unit of measure selected from within the item's available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!

This property is only available for QBXMLVersion 7.0 and higher.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

linked_txn_count Property

The number of records in the LinkedTxn arrays.

Syntax

def get_linked_txn_count() -> int: ...

linked_txn_count = property(get_linked_txn_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

linked_txn_amount
linked_txn_date
linked_txn_id
linked_txn_link_type
linked_txn_ref_number
linked_txn_type

The array indices start at 0 and end at linked_txn_count - 1.

This property is read-only.

linked_txn_amount Property

The amount of the linked transaction.

Syntax

def get_linked_txn_amount(linked_txn_index: int) -> str: ...

Default Value

Remarks

The amount of the linked transaction.

The linked_txn_index parameter specifies the index of the item in the array. The size of the array is controlled by the linked_txn_count property.

This property is read-only.

linked_txn_date Property

The date of the linked transaction.

Syntax

def get_linked_txn_date(linked_txn_index: int) -> str: ...

Default Value

Remarks

The date of the linked transaction.

The linked_txn_index parameter specifies the index of the item in the array. The size of the array is controlled by the linked_txn_count property.

This property is read-only.

linked_txn_link_type Property

Indicates the nature of the link between the transactions.

Syntax

def get_linked_txn_link_type(linked_txn_index: int) -> str: ...

Default Value

Remarks

Indicates the nature of the link between the transactions. Possible responses include:


AMTTYPE	The two transactions are linked based on an amount value (for example an invoice linked to a payment).
QUANTYPE	The two transactions are linked based on a quantity. This affects transactions that are linked to sales orders, estimates and purchase orders. For example, an invoice might be created from a sales order, based on the quantity of items received.

The linked_txn_index parameter specifies the index of the item in the array. The size of the array is controlled by the linked_txn_count property.

This property is read-only.

linked_txn_ref_number Property

This is the reference number assigned to the linked transaction.

Syntax

def get_linked_txn_ref_number(linked_txn_index: int) -> str: ...

Default Value

Remarks

This is the reference number assigned to the linked transaction. Depending on the type of transaction, it appears in the QuickBooks user interface as Bill Number, Invoice Number, etc.

Reference numbers are alphanumeric strings and are not limited to actually being numbers.

The linked_txn_index parameter specifies the index of the item in the array. The size of the array is controlled by the linked_txn_count property.

This property is read-only.

linked_txn_id Property

This property can be used by another class to reference the original transaction which is linked to the current response.

Syntax

def get_linked_txn_id(linked_txn_index: int) -> str: ...

Default Value

Remarks

This property can be used by another class to reference the original transaction which is linked to the current response. Simply set the Id property of the appropriate class (based on the linked_txn_txn_type property) and call the Get method.

The linked_txn_index parameter specifies the index of the item in the array. The size of the array is controlled by the linked_txn_count property.

This property is read-only.

linked_txn_type Property

This property indicates which type of linked transaction has been returned.

Syntax

def get_linked_txn_type(linked_txn_index: int) -> str: ...

Default Value

Remarks

This property indicates which type of linked transaction has been returned. The linked_txn_txn_type returned will tell you which class to use to retrieve the original transaction. Use the linked_txn_txn_id as the Id parameter in the indicated class's Get method to return the original transaction details.

Valid values include:


Bill	(Bill class)
BillPaymentCheck	(n/a)
BillPaymentCreditCard	(n/a)
BuildAssembly	(n/a)
Charge	(StatementCharge class)
Check	(Check class)
CreditCardCharge	(CCCredit class)
CreditCardCredit	(CCCharge class)
CreditMemo	(CreditMemo class)
Deposit	(Deposit class)
Estimate	(Estimate class)
InventoryAdjustment	(AdjustInventory class)
Invoice	(Invoice class)
ItemReceipt	(ItemReceipt class)
JournalEntry	(JournalEntry class)
LiabilityAdjustment	(n/a)
Paycheck	(n/a)
PayrollLiabilityCheck	(n/a)
PurchaseOrder	(PurchaseOrder class)
ReceivePayment	(ReceivePayment class)
SalesOrder	(SalesOrder class)
SalesReceipt	(SalesReceipt class)
SalesTaxPaymentCheck	(n/a)
Transfer	(n/a)
VendorCredit	(VendorCredit class)
YTDAdjustment	(n/a)

Note: Not all of the above values are available in the QuickBooks API. Some are only available within the QuickBooks application itself. If the value above is available in the API, the corresponding class is indicated in parenthesis.

The linked_txn_index parameter specifies the index of the item in the array. The size of the array is controlled by the linked_txn_count property.

This property is read-only.

memo Property

Memo to appear on internal reports only.

Syntax

def get_memo() -> str: ...
def set_memo(value: str) -> None: ...

memo = property(get_memo, set_memo)

Default Value

Remarks

A memo to appear on internal reports. Will not appear to customers, vendors, etc.

po_number Property

P.O. number.

Syntax

def get_po_number() -> str: ...
def set_po_number(value: str) -> None: ...

po_number = property(get_po_number, set_po_number)

Default Value

Remarks

The P.O. number for this invoice or credit memo.

qb_connection_string Property

An aggregate consisting of various QuickBooks connection properties.

Syntax

def get_qb_connection_string() -> str: ...
def set_qb_connection_string(value: str) -> None: ...

qb_connection_string = property(get_qb_connection_string, set_qb_connection_string)

Default Value

Remarks

QBConnectionString allows the user to customize the application's interaction with QuickBooks.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:


ApplicationName	The name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access.
CompanyFile	The name of the company file to open. If QuickBooks is not currently open with a company file, QuickBooks will be automatically opened in the background with the file specified. Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the application UI, only that company file may be used. This setting is not applicable when communicating with QB Connector.
URL	The URL for the Remote Connector, e.g., 'http://localhost:2080'. If the URL is specified, the class will not communicate directly with QuickBooks, and will instead send a request to the specified web address. QuickBooks and the Remote Connector should be installed at the remote location, and if the connector is listening on the specified port, it will communicate the class's request to QuickBooks, and return the response.
User	A username for the Remote Connector connection (if required on the Connector side)
Password	A password for the Remote Connector connection (if required on the Connector side)
Timeout	A timeout, in seconds, for the Remote Connector connection. If the Connector does not finish and respond within the chosen length of time, the class will generate an exception instead of hanging.
DelayAfterClose	A delay, in milliseconds, to be applied after each time a connection to QuickBooks is closed. If QuickBooks is generating internal errors (in particular with automatic login) setting this delay to a positive value may solve the problem.
FirewallHost	Contains the name or IP address of firewall. If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
FirewallPassword	Contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
FirewallPort	Contains the TCP port for the firewall FirewallHost. Note this is set automatically when FirewallType is set to a valid value.
FirewallType	Determines the type of firewall to connect through. Supported values are: 0 - no firewall (default), 1 - Tunneling proxy, 2 - SOCKS4 proxy, and 3 - SOCKS5 proxy. For the Tunneling proxy (1), the FirewallPort defaults to 80. For SOCKS4 (2) and SOCKS5 (3) the FirewallPort defaults to 1080.
FirewallUser	Contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
ProxyAuthorization	Supported values are 0 - Basic authorization, 1 - Digest authentication, 3 - No authentication, and 4 - NTLM authentication.
ProxyPassword	Contains a password if authentication is to be used for the proxy.
ProxyPort	Contains the TCP port for a ProxyServer; (default 80).
ProxySSL	Determines when to use SSL for the connection to the proxy. The applicable values are 0 - Automatic (SSL for https URLs, non-SSL for http URLs), 1 - The connection is always SSL-enabled, 2 - SSL is not enabled for any connection, and 3 - Connection is through a tunneling proxy.
ProxyServer	If a ProxyServer is specified, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the ProxyServer is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer is set to the corresponding address. If the search is not successful, an error is returned.
ProxyUser	Contains a user name, if authentication is to be used for the proxy.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the class binds.
UseRDS	Whether to connect using Remote Data Sharing (RDS). If set to True, the class will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. The default value is False.

qb_request_aggregate Property

The request aggregate.

Syntax

def get_qb_request_aggregate() -> str: ...
def set_qb_request_aggregate(value: str) -> None: ...

qb_request_aggregate = property(get_qb_request_aggregate, set_qb_request_aggregate)

Default Value

Remarks

This property will be populated when qb_request_mode is set to rmOffline and a method is called. This is used when working with the QBWCServer class to generate requests to be sent to QuickBooks Web Connector.

qb_request_id Property

The Id of the next message to be sent to QuickBooks.

Syntax

def get_qb_request_id() -> str: ...
def set_qb_request_id(value: str) -> None: ...

qb_request_id = property(get_qb_request_id, set_qb_request_id)

Default Value

Remarks

The next message Id to be sent to QuickBooks. Message Id's are used by check_request_status to check on the status of previously made requests.

This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with check_request_status allows the user to query this internal list.

To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, check_request_status should be called with this value of QBRequestId to find whether the request was processed before the system failed.

Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See check_request_status for more information on error recovery.

qb_request_mode Property

Defines whether the request is made online or stored offline.

Syntax

def get_qb_request_mode() -> int: ...
def set_qb_request_mode(value: int) -> None: ...

qb_request_mode = property(get_qb_request_mode, set_qb_request_mode)

Default Value

Remarks

This property defines the behavior of the class when calling a method. Possible values are:


0 (rmOnline - default)	The request is made normally.
1 (rmOffline)	The request is generated but not sent, and qb_request_aggregate is populated.

The use of offline mode is required when using the QBWCServer class. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer class.

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

qb_response_aggregate Property

The last QBXML response aggregate received from QuickBooks.

Syntax

def get_qb_response_aggregate() -> str: ...
def set_qb_response_aggregate(value: str) -> None: ...

qb_response_aggregate = property(get_qb_response_aggregate, set_qb_response_aggregate)

Default Value

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

qbxml_version Property

The version of QBXML used in the outgoing message.

Syntax

def get_qbxml_version() -> str: ...
def set_qbxml_version(value: str) -> None: ...

qbxml_version = property(get_qbxml_version, set_qbxml_version)

Default Value

"3.0"

Remarks

The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.

With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:


QuickBooks 2002	1.0, 1.1
QuickBooks 2003	2.0
QuickBooks 2004	3.0
QuickBooks 2005	4.0, 4.1
QuickBooks 2006	5.0
QuickBooks 2007	6.0
QuickBooks 2008	7.0
QuickBooks 2009	8.0
QuickBooks 2010	9.0
QuickBooks 2011	10.0
QuickBooks 2012	11.0
QuickBooks 2013	12.0
QuickBooks 2014	13.0
QuickBooks 2015	14.0
QuickBooks 2016	15.0

In addition, versions of QuickBooks outside of the U.S. released before Quickbooks 2008 adhere to a different version of the QuickBooks SDK. These versions were updated with less frequency than the U.S. SDK, and may omit features introduced in later releases:


QuickBooks Canadian 2003	CA2.0
QuickBooks Canadian 2004 to 2007	CA3.0
QuickBooks UK 2003	UK2.0
QuickBooks UK 2004 to 2007	UK3.0
QuickBooks Australian 2003	OZ2.0
QuickBooks Australian 2004 to 2007	AU3.0

With the exception of Province in Address (set State) or EligibleForT4A in Vendor (set EligibleFor1099), Canadian-only fields are read-only and may be accessed with config.

ref_id Property

An alphanumerical identifier generated by the server.

Syntax

def get_ref_id() -> str: ...

ref_id = property(get_ref_id, None)

Default Value

Remarks

An Id is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.

This property is read-only.

ref_number Property

Reference number for the transaction.

Syntax

def get_ref_number() -> str: ...
def set_ref_number(value: str) -> None: ...

ref_number = property(get_ref_number, set_ref_number)

Default Value

Remarks

This is the reference number assigned to a transaction. Depending on the type of transaction, it appears in the QuickBooks user interface as Bill Number, Invoice Number, etc.

Reference numbers are alphanumeric strings and are not limited to actually being numbers.

For some types of transactions, if RefNumber is not assigned, QuickBooks will automatically assign a unique one. Reference numbers should generally be unique, but are not guaranteed to be so. It is recommended that applications generating their own reference numbers take steps to ensure their uniqueness.

sales_rep_id Property

Reference to (initials of) sales rep.

Syntax

def get_sales_rep_id() -> str: ...
def set_sales_rep_id(value: str) -> None: ...

sales_rep_id = property(get_sales_rep_id, set_sales_rep_id)

Default Value

Remarks

A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

This property appears in the Customer class as well as some transaction classs. When found in a Customer class this property is unsupported for Update operations.

sales_rep_name Property

Reference to (initials of) sales rep.

Syntax

def get_sales_rep_name() -> str: ...
def set_sales_rep_name(value: str) -> None: ...

sales_rep_name = property(get_sales_rep_name, set_sales_rep_name)

Default Value

Remarks

A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

This property appears in the Customer class as well as some transaction classs. When found in a Customer class this property is unsupported for Update operations.

sales_tax_total Property

Total amount of sales tax.

Syntax

def get_sales_tax_total() -> str: ...

sales_tax_total = property(get_sales_tax_total, None)

Default Value

Remarks

The total amount of sales tax charged in this transaction.

Not used with Canadian editions of QuickBooks.

The amount should be formatted as a string in dollars.

This property is read-only.

ship_date Property

Date of shipping.

Syntax

def get_ship_date() -> str: ...
def set_ship_date(value: str) -> None: ...

ship_date = property(get_ship_date, set_ship_date)

Default Value

Remarks

The date when goods were, or will be, shipped to the Customer.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

ship_method_id Property

Reference to preferred method of shipping.

Syntax

def get_ship_method_id() -> str: ...
def set_ship_method_id(value: str) -> None: ...

ship_method_id = property(get_ship_method_id, set_ship_method_id)

Default Value

Remarks

Reference to the preferred method of shipping, e.g., UPS.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

ship_method_name Property

Reference to preferred method of shipping.

Syntax

def get_ship_method_name() -> str: ...
def set_ship_method_name(value: str) -> None: ...

ship_method_name = property(get_ship_method_name, set_ship_method_name)

Default Value

Remarks

Reference to the preferred method of shipping, e.g., UPS.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

shipping_address Property

Address to ship to.

Syntax

def get_shipping_address() -> str: ...
def set_shipping_address(value: str) -> None: ...

shipping_address = property(get_shipping_address, set_shipping_address)

Default Value

Remarks

The address to whom goods were shipped, or are to be shipped.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

subtotal Property

Gross subtotal; doesn't count taxes/amount already paid.

Syntax

def get_subtotal() -> str: ...

subtotal = property(get_subtotal, None)

Default Value

Remarks

The total of the amounts in all the lines of an invoice, credit memo, or sales receipt, before taxes or payments are applied.

The amount should be formatted as a string in dollars.

This property is read-only.

tax_item_id Property

Reference to detailed taxation information.

Syntax

def get_tax_item_id() -> str: ...
def set_tax_item_id(value: str) -> None: ...

tax_item_id = property(get_tax_item_id, set_tax_item_id)

Default Value

Remarks

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a tax_item might represent sales tax for a particular city.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

This property appears in the Customer class as well as some transaction classs. When found in a Customer class this property is unsupported for Update operations.

Not used with Canadian editions of QuickBooks.

tax_item_name Property

Reference to detailed taxation information.

Syntax

def get_tax_item_name() -> str: ...
def set_tax_item_name(value: str) -> None: ...

tax_item_name = property(get_tax_item_name, set_tax_item_name)

Default Value

Remarks

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a tax_item might represent sales tax for a particular city.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

This property appears in the Customer class as well as some transaction classs. When found in a Customer class this property is unsupported for Update operations.

terms_id Property

Reference to terms of payment.

Syntax

def get_terms_id() -> str: ...
def set_terms_id(value: str) -> None: ...

terms_id = property(get_terms_id, set_terms_id)

Default Value

Remarks

A reference to terms of payment, predefined within QuickBooks. A typical example might be "2% 10 Net 60", i.e., payment due within 60 days, with a 2% discount if payment is made within 10 days.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

terms_name Property

Reference to terms of payment.

Syntax

def get_terms_name() -> str: ...
def set_terms_name(value: str) -> None: ...

terms_name = property(get_terms_name, set_terms_name)

Default Value

Remarks

A reference to terms of payment, predefined within QuickBooks. A typical example might be "2% 10 Net 60", i.e., payment due within 60 days, with a 2% discount if payment is made within 10 days.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

total_amount Property

Subtotal + SalesTaxTotal.

Syntax

def get_total_amount() -> str: ...

total_amount = property(get_total_amount, None)

Default Value

Remarks

The total amount of the CreditMemo or SalesReceipt. Will be equal to subtotal + sales_tax_total.

The amount should be formatted as a string in dollars.

This property is read-only.

transaction_date Property

Date of transaction.

Syntax

def get_transaction_date() -> str: ...
def set_transaction_date(value: str) -> None: ...

transaction_date = property(get_transaction_date, set_transaction_date)

Default Value

Remarks

The date of the transaction.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

This property is required in Accounts Payable (Bill and VendorCredit) transactions. In other kinds of transactions this property is optional.

add Method

Adds the record into QuickBooks.

Syntax

def add() -> None: ...

Remarks

Add is used to add the object to QuickBooks.

If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The qb_response_aggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

For example, read-only properties such as ref_ids will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.

If QuickBooks is not able to add the object, a trappable error will occur.

cancel Method

Cancels (voids) the transaction.

Syntax

def cancel() -> None: ...

Remarks

Cancel causes the transaction to be voided in QuickBooks. The amount of the transaction and all line item quantities are changed to zero, and the memo is changed to "VOID:". The transaction will not, however, be deleted.

The transaction canceled in QuickBooks is the one specified by ref_id. If the value of ref_id is known then get should first be called to retrieve the transaction. Otherwise the ObjSearch class should be used to search for the desired transaction in the QuickBooks database.

As the QuickBooks response to Cancel does not include the updated transaction, the values of all properties are instead set to their defaults. To get a copy of the updated transaction, the value of ref_id should first be stored, and then get should be called.

check_request_status Method

Checks whether or not the specified request was processed by QuickBooks.

Syntax

def check_request_status(request_id: str) -> str: ...

Remarks

This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of qb_request_ids for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.

The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."

See qb_request_id for more information on error recovery.

close_qb_connection Method

Closes a persistent connection to QuickBooks.

Syntax

def close_qb_connection() -> None: ...

Remarks

Invoking close_qb_connection closes the QuickBooks connection specified in qb_connection_string. After the connection has been closed, the class will revert to its default behavior, and a new connection will be established for each request until qb_connection_string is invoked again.

In case the connection is already closed invoking close_qb_connection will have no effect. Moreover, if multiple connections are open close_qb_connection will only close the connection specified in qb_connection_string.

Be sure to always invoke this method after calling open_qb_connection.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

delete Method

Deletes the record from QuickBooks.

Syntax

def delete() -> None: ...

Remarks

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by ref_id. This read-only property may be assigned either by calling get or by assigning the value of qb_response_aggregate.

A typical example: Customer.GetByName("John Smith") 'this will assign the RefId Customer.Delete() Deleting entity objects (Customer, Employee, and Vendor) requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

get Method

Gets a single record from QuickBooks.

Syntax

def get(id: str) -> None: ...

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its ref_id. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the class will be set to the information retrieved from QuickBooks. The qb_response_aggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The ref_id of any class, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.Get( Invoice.CustomerId )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose ref_id is not known, or to perform more advanced searches the ObjSearch class may be used.

get_custom_field Method

Gets a custom field value from QuickBooks.

Syntax

def get_custom_field(field_name: str) -> str: ...

Remarks

This method will get the value of a custom field, which has been defined by the user from within the QuickBooks UI.

To read the values of custom fields, be sure to set qbxml_version to at least "2.0" when retrieving data from QuickBooks. Then, QuickBooks will return custom field information, and it will be accessible through this method.

You may also invoke config to read the value of custom fields. However, to set the value of custom fields you must set qbxml_version to at least "3.0" and invoke set_custom_field.

import_qbxml Method

Imports a QBXML response aggregate.

Syntax

def import_qbxml(xml_data: str) -> None: ...

Remarks

This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

open_qb_connection Method

Opens a persistent connection to QuickBooks.

Syntax

def open_qb_connection() -> None: ...

Remarks

Invoking open_qb_connection will open a persistent connection to QuickBooks. After invoking open_qb_connection, all requests such as get, add, etc. will use the established connection until close_qb_connection is invoked.

The effect of open_qb_connection is to increase performance. If open_qb_connection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the class communicates with QuickBooks. Using open_qb_connection will be faster, particularly in the case of automatic login.

After open_qb_connection is invoked, QuickBooks will issue a connection ticket, and it will be stored in qb_connection_string. When close_qb_connection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke close_qb_connection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

reset Method

Resets all properties to their defaults.

Syntax

def reset() -> None: ...

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the class may be reused as if it were newly created.

set_custom_field Method

Sets a custom field value within QuickBooks.

Syntax

def set_custom_field(field_name: str, field_value: str) -> None: ...

Remarks

This method requires QuickBooks 2004 or above, with qbxml_version set to at least "3.0".

This method will immediately set the value of a QuickBooks custom field, which has been defined by the user from within the QuickBooks UI. Before calling this method, the preceding operation must retrieve the object from QuickBooks, using get, ObjSearch, etc. Then, you may use set_custom_field to set custom field values (the fields will be modified or added, as appropriate).

Note that invoking this method will create a connection to QuickBooks if one is not already in place.

update Method

Updates the bill in QuickBooks.

Syntax

def update() -> None: ...

Remarks

This method will update the bill in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The bill will have its information updated based on the various property values.

If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The qb_response_aggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

qbxml_version must be set to "3.0" or greater to update a bill. Moreover, qbxml_version should be set to the same value when retrieving the bill from QuickBooks (either through ObjSearch or through the get method).

on_error Event

Information about errors during data delivery.

Syntax

class CreditMemoErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class CreditMemo:
@property
def on_error() -> Callable[[CreditMemoErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[CreditMemoErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class CreditMemoSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class CreditMemo:
@property
def on_ssl_server_authentication() -> Callable[[CreditMemoSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[CreditMemoSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class CreditMemoSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class CreditMemo:
@property
def on_ssl_status() -> Callable[[CreditMemoSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[CreditMemoSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

on_status Event

Shows the progress of the QuickBooks connection.

Syntax

class CreditMemoStatusEventParams(object):
  @property
  def message() -> str: ...

# In class CreditMemo:
@property
def on_status() -> Callable[[CreditMemoStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[CreditMemoStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

on_warning Event

Fired when a warning occurs.

Syntax

class CreditMemoWarningEventParams(object):
  @property
  def code() -> int: ...

  @property
  def description() -> str: ...

# In class CreditMemo:
@property
def on_warning() -> Callable[[CreditMemoWarningEventParams], None]: ...
@on_warning.setter
def on_warning(event_hook: Callable[[CreditMemoWarningEventParams], None]) -> None: ...

Remarks

The Warning event is fired when the class has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the class. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.


510*	Object added successfully, but cannot now be read.
520*	Insufficient permissions to get all data.
801	Unable to update field (name).
802	Unable to parse name.

Unlisted QuickBooks warnings will cause the class to throw an exception instead.

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

CreditMemo Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

CreditMemo Config Settings

AppendAfter: Appends an XML tag after the specified QBXML element.

Write-only; Appends the specified text after the specified QBXML element (whether the QBXML element is present). This may be useful to extend the functionality of the component beyond what is provided. Example: Control1.Config("AppendAfter:ListID=<WeirdNewField>abc</WeirdNewField>")

AuthFlags: Connection Flags (use for QuickBooks Simple Start).

Since 2006, QuickBooks has allowed AuthFlags to be set before connecting to QuickBooks. By default, the class can connect to Pro, Premier, and Enterprise editions of QuickBooks. However, because QuickBooks Simple Start contains only a subset of the functionality that other desktop versions provide, Intuit does not allow COM connection to Simple Start unless these AuthFlags explicitly indicate you wish to support it.

A list of allowable AuthFlags is provided below.


"" or 0	Do not send any auth flags
0x01	Support QB Simple Start
0x02	Support QB Pro
0x04	Support QB Premier
0x08	Support QB Enterprise
0x80000000	Force Auth Dialog

To specify support for multiple editions, OR together the values for each edition.

NOTE: If the version of QuickBooks being used does not support AuthFlags, the contents of this config will be ignored. However, if QuickBooks does support this feature, setting "AuthFlags=1" (Support for Simple Start only) on a machine running QuickBooks 2013 Pro will result in an error message indicating that the Request Processor cannot be found.

ClassId: A reference to the class of transaction.

ClassName: A reference to the class of transaction.

CreditRemaining: Available Credit.

Returns the remaining credit that has not been applied to a transaction.

CustomerSalesTaxId: Reference to sales tax information for the CUSTOMER.

CustomerSalesTaxName: Reference to sales tax information for the CUSTOMER.

EditSequence: An identifier for this copy of the object.

Indicates the state of an object when doing an Update.

EnforceMaxLength: Indicates whether to enforce max lengths for QB Fields.

If you change this setting to False, the class will no longer check (or error) when the length of a property exceeds the maximum length specified in the QuickBooks SDK.

ExchangeRate: Indicates the exchange rate for the transaction.

Exchange Rate is a floating-point number stored with five digits after the decimal place. The exchange rate is multiplied by the foreign currency amount to get the home currency amount; that is,

ExchangeRate x (foreign currency amount) = (home currency amount).

(The foreign currency and home currency are set in the QuickBooks application)

FirstName: A first name.

FOB: Freight On Board: the place from where shipped.

GetHighestVersion: Highest QBXMLVersion supported by the installed instance of QuickBooks.

If QuickBooks is installed on the system, this setting will retrieve the highest qbxml_version that may be used for sending transactions to QuickBooks.

GetRequestProcessorDLLVersion: Returns the version of the QB Request Processor that is installed on your system.

GetSupportedVersions: Returns a list of QBXMLVersions that are supported by QuickBooks.

If QuickBooks is installed on the system, this setting will retrieve a list of all supported qbxml_versions that may be used for sending transactions to QuickBooks. While GetHighestVersion config returns only the highest qbxml_version supported, this config returns ALL supported qbxml_versions. The list is delimited with '\n' (linefeed) characters.

IsReadOnly: This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.

The default value is false.

IsToBeEmailed: When true, if no email address is on file for the customer the transaction will fail.

If this is set to true, at runtime the customer referenced in this transaction will be checked for a valid email address. If there is no valid email address, the request will fail. If there is a valid email address currently in QuickBooks for the customer, and the request succeeds, the transaction will be added to QuickBook's list of forms to be emailed, possibly in a batch.

Notice that setting this field to true does not actually perform the emailing. Only the QuickBooks user can do that from within QuickBooks. This cannot be done from the SDK. Setting this field to false does not prevent the QuickBooks user from emailing the transaction later. It simply results in the transaction NOT being placed in the list of transactions to be emailed.

This field is only available when qbxml_version is "6.0" or higher.

Items[index].OverrideItemAccountId: An account which will override the default account for the line item.

qbxml_version must be 2.0 or higher to use this configuration setting.

Items[index].OverrideItemAccountName: An account which will override the default account for the line item.

qbxml_version must be 2.0 or higher to use this configuration setting.

LastName: A last name.

MiddleInitial: A middle initial.

PersonalDataPref: Whether the connecting application will require access to personal data such as SSN or credit card information.

This setting allows you to let the user know immediately whether your application requires access to personal data or not.

A list of available values is provided below.


pdpOptional	Causes the QuickBooks authorization dialog to display a checkbox for user selection asking whether the user wants to allow the application to access personal data.
pdpRequired	Causes the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display a warning that the application needs to access personal data.
pdpNotNeeded	Causes the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display an informational message that the application will NOT access personal data.

The default value is pdpOptional.

QBConnectionMode: The mode of connection to QuickBooks.

Specifies whether the integrated application logs in using single-user or multi-user mode.

The following values are permitted:


0	Don't Care
1	Single-User Mode
2	Multi-User Mode

About Single-User and Multi-User Modes

If the connection to QuickBooks is made in single-user mode, QuickBooks will give exclusive access to the connecting application. It will lock out all other integrated applications; if QuickBooks and the company file are not already open in single-user mode by the QuickBooks user, the user will be locked out as well.

If the connection is made in multi-user mode, QuickBooks will allow all other integrated applications access. QuickBooks end users on other machines will also be allowed to access the file. However, if the application (rather than the end user) starts QuickBooks automatically, end users on the same machine will still be locked out.

If cmDontCare is specified, an appropriate connection mode will be chosen automatically. If a company file is open in either single-user or multi-user mode, the integrated application will accept that connection mode. If no company file is open, QuickBooks will login automatically in multi-user mode.

About Integrated and Automatic Login

Note that your application's login to QuickBooks might be either automatic or interactive. Interactive login is used when QuickBooks is already open. Access will be shared between the integrated application and the QuickBooks end user, and if multi-user mode is specified, other applications and users will have access as well. When a connection is made, QuickBooks will show a dialog window to the user, and ask the user if he/she wants to permit the connection.

Automatic login is used when QuickBooks is not already open. QuickBooks will be opened in the background, and will run until your application has finished its connection with QuickBooks. The QuickBooks user interface will not be displayed, and end-users on the same machine will be locked out. End-users on other machines, however, will be allowed access if multi-user mode is specified.

By default integrated applications do not have permission to login automatically. The first time an application interacts with QuickBooks, it must do so interactively, with QuickBooks and the company file open. The QuickBooks end user may then grant automatic login permission through Edit Preferences - Integrated Applications in the QuickBooks user interface. Click on the name of the application and then "Properties", and you may allow the application to login automatically.

For automatic login the CompanyFile must be specified. CompanyFile, ApplicationName, and other properties relating to the QuickBooks connection may be edited through qb_connection_string.

QBFileStatus: The status of the company file as it pertains to accepting connections.

This setting may be queried before attempting to connect to QuickBooks to determine the current company file status. When queried the class will attempt to determine whether a subsequent connection using the provided qb_connection_string value would succeed. Possible return values are:


0	The company file will accept the connection. This indicates that no company file is open, or the desired company file is already open.
1	The company file will not accept the connection. This indicates a different company file is already open.

QBOpenCompanyFile: The file currently open in QuickBooks.

The name of the file currently open in QuickBooks, specified completely with the path. This field is read-only.

A query is submitted to QuickBooks when the value of this property is read. The empty string will be returned if no file is open, if QuickBooks is open in an access mode incompatible with QBConnectionMode, or if an error occurs.

If the value of this property is nonempty, the class may interact exclusively with the open file.

SalesTaxPercentage: Percent paid as sales tax.

This setting is read-only.

Salutation: A salutation, such as Mr., Mrs., etc.

SendRawXML: Sends specified XML to quickbooks without modification.

Available for write only. Immediately sends the specified XML over the current or default QuickBooks connection (as specified elsewhere), and returns the QBXML response. Syntax: Control1.Config("SendRawXML=<?xml version="1.0" ?>...")

SeparateContact: A contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName.

SSLAcceptServerCert: The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).

The Base-64 encoded certificate being used by the Remote Connector (you may get this certificate from the Remote Connector by going to the Security tab, and clicking Export.)

This is only necessary if using a self-signed certificate, or any other certificate that has not been signed by a Certificate Authority (CA) trusted by the system.

SSLAcceptServerCertFile: The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).

If your public key certificate is stored in a file, you may set this configuration setting to the full path of the certificate, and it will be immediately read from disk and stored in SSLAcceptServerCert. Equivalent to setting SSLAcceptServerCert to file contents.

Reading the value of this setting will return an empty string.

StopOnError: Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.

If StopOnError is True (default), QuickBooks will stop processing when an error occurs. Requests that have already been processed will not be rolled back. An error is returned for the operation that caused the error condition. If StopOnError is False, QuickBooks will continue processing the remaining requests if an error occurs.

Tax1Total: Canadian field used for Goods and Services Tax, or GST.

qbxml_version must be set to "CA2.0", "OZ2.0", "UK2.0", or "AU2.0" to use this property.

Note: U.K. editions of QuickBooks use Tax1 for Value Added Tax (VAT) and do not use Tax2Total at all.

Tax2Total: Canadian field used for Provincial Sales Taxes, or PST.

qbxml_version must be set to "CA2.0", "OZ2.0", "UK2.0", or "AU2.0" to use this property.

Note: U.K. editions of QuickBooks use Tax1 for Value Added Tax (VAT) and do not use Tax2Total at all.

TemplateId: The ID of an existing template to apply to the transaction.

TemplateName: The name of an existing template to apply to the transaction.

TimeCreated: The time the object was created.

This config setting is read-only.

TimeModified: The time the object was created.

This config setting is read-only.

UnattendedModePref: Whether connecting while QuickBooks is closed is required or optional for the user.

This setting allows you to let the user know immediately whether your application requires the ability to access QuickBooks while QuickBooks is closed.

A list of available values is provided below.


umpOptional	Causes the QuickBooks authorization dialog to display its default selections and let the user pick. Use this setting if you do not need unattended mode.
umpRequired	Causes the QuickBooks authorization dialog to display only the selection choices of "No" (no authorization) or "Yes, allow access even if QuickBooks is not running" (authorize unattended mode).

The default value is umpOptional.

WarningCodes: A comma-separated list of QuickBooks warning codes that should not result in an exception.

By default, the class will throw an exception when a status code with severity "Warn" is returned in a QuickBooks response. Set this field to a comma-separated list of status codes that should not throw an exception if returned. Note that the QuickBooks response code is not necessarily the same as the exception code from the resulting exception.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation.

When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to True tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

CreditMemo Errors

Errors

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

CreditMemo Errors

101   String too long.
103   Invalid date format (YYYY-MM-DD is standard).
104   Invalid value for enumerated field.
105   Invalid integer.
106   Invalid dollar amount.
107   Invalid boolean value (must be 'true' or 'false').
108   Invalid number.
111   Invalid special characters in string.
112   Invalid special field syntax.
181   Could not load certificate file.
201   Required field unspecified.
211   Unsupported field specified.
301   Array line count must be nonnegative.
302   Array index out of bounds.
303   Invalid field index.
401   Field not accessible as a special field.
402   Write access attempted of readonly field.
403   Read access attempted of writeonly field.
421   The object cannot be modified.
511   The qb_request_id has been previously used. Please generate a new one.
601   Could not access QuickBooks.
602   Could not open specified file.
603   The version of QuickBooks currently being used is not supported.
604   QuickBooks has not been installed properly.
605   The specified file was of an incorrect version.
606   Could not start QuickBooks.
607   QuickBooks is open in a mode different than the one requested.
608   QuickBooks cannot currently be accessed.
609   An application name must be specified.
610   A file name must be specified if one is not currently open in QuickBooks.
611   Access denied.
612   QuickBooks is busy and cannot open your application in the mode requested.
699   The connection to QuickBooks has failed for an unknown reason.
702   The object requested does not exist in QuickBooks.
751   Unsupported QBXML version.
752   The qbxml_version chosen is insufficient to execute the request.
801   A QuickBooks internal error has occurred.
802   QuickBooks is not available due to a system-related problem.
803   The Id specified is invalid.
804   Invalid object name.
805   The name already exists in QuickBooks.
807   An object could not be found in QuickBooks.
808   A reference did not refer to an object that exists in QuickBooks.
809   The object is currently in use by the QuickBooks end user.
810   The object may not be added.
811   The object may not be updated because it is obsolete.
812   The address is invalid.
813   Permission to perform this operation is not granted.
814   The request has not been processed.
815   Time creation mismatch.
816   The feature is turned off or not enabled.
817   Permission level configured is insufficient for access.
818    The item specified was of an unknown type.
819   The object may not be changed.
820   An internal QuickBooks error has occurred.
821   An attempt was made to use a connection that was not properly initiated.
822   An attempt was made to use a connection that is invalid or was previously closed.
823   Not enough memory.
824   Unable to lock the necessary information to allow this application access to the company file. Try again later.
850   An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
851   The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
861   Server error on WebExport (details follow).
862   The WebExport is impossible: an HTTP context was not found.
871   You may not set the value of QBConnectionTicket. This value is readonly.
880   Interrupted by the user.
881   An error has occurred connecting to a remote machine.
899   An unknown QuickBooks error has occurred. The message contains more details.
901   XML Parser Error. Should not occur under normal circumstances.


	101 String too long.
	103 Invalid date format (YYYY-MM-DD is standard).
	104 Invalid value for enumerated field.
	105 Invalid integer.
	106 Invalid dollar amount.
	107 Invalid boolean value (must be 'true' or 'false').
	108 Invalid number.
	111 Invalid special characters in string.
	112 Invalid special field syntax.
	181 Could not load certificate file.
	201 Required field unspecified.
	211 Unsupported field specified.
	301 Array line count must be nonnegative.
	302 Array index out of bounds.
	303 Invalid field index.
	401 Field not accessible as a special field.
	402 Write access attempted of readonly field.
	403 Read access attempted of writeonly field.
	421 The object cannot be modified.
	511 The qb_request_id has been previously used. Please generate a new one.
	601 Could not access QuickBooks.
	602 Could not open specified file.
	603 The version of QuickBooks currently being used is not supported.
	604 QuickBooks has not been installed properly.
	605 The specified file was of an incorrect version.
	606 Could not start QuickBooks.
	607 QuickBooks is open in a mode different than the one requested.
	608 QuickBooks cannot currently be accessed.
	609 An application name must be specified.
	610 A file name must be specified if one is not currently open in QuickBooks.
	611 Access denied.
	612 QuickBooks is busy and cannot open your application in the mode requested.
	699 The connection to QuickBooks has failed for an unknown reason.
	702 The object requested does not exist in QuickBooks.
	751 Unsupported QBXML version.
	752 The qbxml_version chosen is insufficient to execute the request.
	801 A QuickBooks internal error has occurred.
	802 QuickBooks is not available due to a system-related problem.
	803 The Id specified is invalid.
	804 Invalid object name.
	805 The name already exists in QuickBooks.
	807 An object could not be found in QuickBooks.
	808 A reference did not refer to an object that exists in QuickBooks.
	809 The object is currently in use by the QuickBooks end user.
	810 The object may not be added.
	811 The object may not be updated because it is obsolete.
	812 The address is invalid.
	813 Permission to perform this operation is not granted.
	814 The request has not been processed.
	815 Time creation mismatch.
	816 The feature is turned off or not enabled.
	817 Permission level configured is insufficient for access.
	818 The item specified was of an unknown type.
	819 The object may not be changed.
	820 An internal QuickBooks error has occurred.
	821 An attempt was made to use a connection that was not properly initiated.
	822 An attempt was made to use a connection that is invalid or was previously closed.
	823 Not enough memory.
	824 Unable to lock the necessary information to allow this application access to the company file. Try again later.
	850 An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	851 The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	861 Server error on WebExport (details follow).
	862 The WebExport is impossible: an HTTP context was not found.
	871 You may not set the value of QBConnectionTicket. This value is readonly.
	880 Interrupted by the user.
	881 An error has occurred connecting to a remote machine.
	899 An unknown QuickBooks error has occurred. The message contains more details.
	901 XML Parser Error. Should not occur under normal circumstances.