CData Python Connector for QuickBooks

Build 24.0.9175

Items

Manages QuickBooks Items, including creation, updates, deletion, and queries for inventory and service tracking.

Table Specific Information

This table has a Custom Fields column. See the Custom Fields page for more information.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for Items are Id, TimeModified, FullName, Type, and IsActive. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. FullName may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:

SELECT * FROM Items WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND FullName LIKE '%12345%'

Insert

When inserting the Item, specify the Type and Name fields. Depending on the Type, other columns may also be required in the insertion. See the list below to see which columns are required for special cases:

  • FixedAsset: Requires Name, Type, AcquiredAs, PurchaseDesc, and PurchaseDate.
  • SalesTaxGroup: Requires Name, Type, and at least one SalesTax Line Item. SalesTaxGroups must be inserted via the ItemLineItems table.

Columns

Name Type ReadOnly References ColumnSize Description
ID [KEY] String True 255

The unique identifier assigned to the item in QuickBooks.

Name String False 31

The name of the item, used for identification in QuickBooks.

FullName String True 159

The full name of the item, including the parent name if the item is a subitem, formatted as parentname:name.

Type String False 100

The category or type of the item (for example, inventory, non-inventory). Required when adding a new item.

使用できる値は次のとおりです。Unknown, Service, Inventory, NonInventory, Payment, Discount, SalesTax, SubTotal, OtherCharge, InventoryAssembly, Group, SalesTaxGroup, FixedAsset

デフォルト値はALLです。

Account String False 1000

The name of the account associated with this item.

AccountId String False

Accounts.ID

255

The unique identifier of the account associated with this item.

COGSAccount String False 1000

The Cost of Goods Sold (COGS) account linked to this item.

COGSAccountId String False

Accounts.ID

255

The unique identifier of the COGS account linked to this item.

AssetAccount String False 1000

The inventory asset account linked to this item (applicable for inventory items).

AssetAccountId String False

Accounts.ID

255

The unique identifier of the inventory asset account linked to this item.

Class String False 1000

A reference to the classification of this item.

ClassId String False

Class.ID

255

The unique identifier of the classification for this item.

DateSold Datetime False

The date the asset was sold (applicable only for fixed asset items).

PurchaseDate Date False

The date the asset was purchased (required for fixed-asset items).

ItemCount Integer False

The number of line items associated with the inventory assembly.

ParentName String False

The name of the parent item if this item is a subitem.

ParentId String False

Items.ID

255

The unique identifier of the parent item if this item is a subitem.

Description String False 5000

A detailed description of the item.

Price Double False

The sales price of the item.

PricePercent Double False

The price expressed as a percentage, used in specific pricing scenarios like labor costs as a percentage of parts costs. If set, Price is 0.

AverageCost Double True

The average cost of the item.

IsActive Boolean False

Indicates whether the item is active in QuickBooks.

PurchaseCost Double False

The cost to purchase this item.

PurchaseDescription String False 5000

A description used for purchasing this item.

ExpenseAccount String False 1000

The expense account associated with this item.

ExpenseAccountId String False

Accounts.ID

255

The unique identifier of the expense account associated with this item.

PreferredVendor String False 1000

The name of the preferred vendor for this item.

PreferredVendorId String False

Vendors.ID

255

The unique identifier of the preferred vendor for this item.

QuantityOnHand Double True

The current stock level of this inventory item.

QuantityOnOrder Double True

The quantity of this item that has been ordered from vendors but not yet received.

QuantityOnSalesOrder Double True

The quantity of this item that customers have ordered but has not yet been delivered.

InventoryDate Date False

The date this item was converted into an inventory item.

ReorderPoint Double False

The stock level at which a reorder reminder is triggered.

Barcode String False 50

The barcode associated with this item.

TaxCode String False 3

A reference to the sales tax code assigned to this item.

TaxCodeId String False

SalesTaxCodes.ID

255

The unique identifier of the sales tax code assigned to this item.

IsTaxIncluded Boolean False

Indicates if the transaction amount includes tax (only available in international editions of QuickBooks).

PurchaseTaxCode String False 3

A reference to the purchase tax code assigned to this item (available in international editions).

PurchaseTaxCodeId String False

SalesTaxCodes.ID

255

The unique identifier of the purchase tax code assigned to this item (available in international editions).

PartNumber String False 31

The manufacturer's part number for this item (requires QBXML Version 7.0 or higher).

PaymentMethodName String False 100

The payment method (for example, check, credit card) associated with this item.

PaymentMethodId String False

PaymentMethods.ID

255

The unique identifier of the payment method associated with this item.

TaxRate Double False

The tax rate applied to this item, expressed as a percentage.

TaxVendorName String False 1000

The vendor or tax agency to whom taxes for this item are paid.

TaxVendorId String False

SalesTaxItems.ID

255

The unique identifier of the vendor or tax agency to whom taxes for this item are paid.

SpecialItemType String False 50

The specific type of item when the item type is unknown. Errors occur if this type is used for adding items.

使用できる値は次のとおりです。FinanceCharge, ReimbursableExpenseGroup, ReimbursableExpenseSubtotal

VendorOrPayeeName String False 50

The name of the vendor from whom this asset was purchased.

IsPrintItemsInGroup Boolean False

Indicates whether this item's group members and amounts should appear on printed forms.

SalesExpense String False

Any expenses incurred during the sale of a fixed asset. Applicable only if the asset has been sold.

AssetAcquiredAs String False 3

Indicates if the asset was acquired new or used. If left blank, it is not included in the request.

使用できる値は次のとおりです。New, Old

AssetDescription String False 5000

A detailed description of the fixed asset.

AssetLocation String False 50

The physical location of the fixed asset.

AssetPONumber String False 30

The purchase order number associated with this asset.

AssetSerialNumber String False 5000

The serial number of the fixed asset.

AssetWarrantyExpires Date False

The date when the warranty for this asset expires.

AssetNotes String False 5000

Additional notes or details about the asset.

AssetNumber String False 10

The identifier used by QuickBooks Fixed Asset Manager to track this asset.

AssetCostBasis Decimal False

The total cost of the asset, including improvements or repairs, used to calculate depreciation.

AssetDepreciation Double False

The accumulated depreciation of the asset since purchase.

AssetBookValue Double False

An estimate of the asset's current sales value.

UnitOfMeasure String False 31

The unit of measure used for this item (requires QBXML Version 7.0 or higher).

UnitOfMeasureId String False

UnitOfMeasure.ID

255

The unique identifier of the unit of measure (requires QBXML Version 7.0 or higher).

Sublevel Integer True

The number of hierarchical levels above this item.

LineAggregate String True 5000

An aggregate of data for all line items associated with this item.

CustomFields String False

Custom fields formatted as XML and returned from QuickBooks.

EditSequence String True 16

An identifier for versioning this record in QuickBooks.

TimeModified Datetime True

The date and time when this item was last modified.

TimeCreated Datetime True

The date and time when this item was created.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175