CData Python Connector for QuickBooks

Build 24.0.9060

EstimateLineItems

Create, update, delete, and query QuickBooks Estimate Line Items.

Table Specific Information

Estimates may be inserted, queried, or updated via the Estimates or EstimateLineItems tables. Estimates may be deleted by using the Estimates table.

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 Estimates are Id, ReferenceNumber, Date, TimeModified, CustomerName, and CustomerId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:

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

Insert

To add an Estimate, specify a Customer and at least one Line Item. All Line Item columns can be used for inserting multiple Line Items for a new Estimate transaction. For example, the following will insert a new Estimate with two Line Items:

INSERT INTO EstimateLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Repairs', 1)
INSERT INTO EstimateLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Removal', 2)
INSERT INTO EstimateLineItems (CustomerName, ItemName, ItemQuantity) SELECT CustomerName, ItemName, ItemQuantity FROM EstimateLineItems#TEMP

Columns

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

The unique identifier in the format EstimateId|ItemLineId.

EstimateId String False

Estimates.ID

255

The unique identifier of the estimate.

ReferenceNumber String False 21

Transaction reference number.

TxnNumber Integer True

The transaction number. An identifying number for the transaction, different from the QuickBooks-generated Id.

CustomerName String False 1000

Customer name this transaction is recorded under. This is required to have a value when inserting.

CustomerId String False

Customers.ID

255

Customer Id this transaction is recorded under. This is required to have a value when inserting.

Date Date False

Transaction date.

Memo String False 5000

Memo regarding this transaction.

TotalAmount Double True

Total amount for this transaction.

ItemLineID String True 255

The line item identifier.

ItemLineNumber String True 255

The line item number.

ItemName String False

The item name.

ItemId String False

Items.ID

255

The item identifier.

ItemGroup String False 100

Item group name. Reference to a group of line items this item is part of.

ItemGroupId String False

Items.ID

255

Item group Id. Reference to a group of line items this item is part of.

ItemDescription String False 5000

A description of the item.

ItemUnitOfMeasure String False 31

In a transaction line item, the name of the unit of measure is 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. Only available in QBXML Version 7.0 and above.

ItemQuantity Double False

The quantity of the item or item group specified in this line.

ItemRate Double False

The unit rate charged for this item.

ItemRatePercent Double False

The rate percent charged for this item.

ItemTaxCode String False 3

Sales tax information for this item (taxable or nontaxable).

ItemTaxCodeId String False

SalesTaxCodes.ID

255

Sales tax Id for this tax item.

ItemAmount Decimal False

Total amount for this item.

ItemClass String False 1000

The class name of the item.

ItemClassId String False

Class.ID

255

The class name of the item.

ItemInventorySiteId String False 255

The inventory site Id of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ItemInventorySiteName String False

InventorySites.ID

31

The inventory site name of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ItemMarkupRate Double False

Item markup rate, to be applied over the base purchase cost.

ItemMarkupRatePercent Double False

Item markup rate percent, to be applied over the base purchase cost.

ItemOther1 String False 29

The Other1 field of this line item. QBXMLVersion must be set to 6.0 or higher.

ItemOther2 String False 29

The Other2 field of this line item. QBXMLVersion must be set to 6.0 or higher.

ItemCustomFields String False

The custom fields for this line item.

ItemUOMSetFullName String False 1000

Indicates the price of something as a percent.

ItemUOMSetListID String False

UnitOfMeasure.ID

1000

Indicates the price of something as a percent.

ItemIsGetPrintItemsInGroup String False 1000

If true, a list of this group's individual items their amounts will appear on printed forms.

Message String False 101

Message to the customer.

MessageId String False

CustomerMessages.ID

1000

Message to the customer.

Class String False 1000

A reference to the class of the transaction.

ClassId String False

Class.ID

255

A reference to the class of the transaction.

SalesRep String False 5

Reference to (initials of) the sales rep.

SalesRepId String False

SalesReps.ID

255

Reference to (initials of) the sales rep.

FOB String False 13

Freight on board: The place to ship from.

BillingAddress String True

Full billing address returned by QuickBooks.

BillingLine1 String False 500

First line of the billing address.

BillingLine2 String False 500

Second line of the billing address.

BillingLine3 String False 500

Third line of the billing address.

BillingLine4 String False 500

Fourth line of the billing address.

BillingLine5 String False 41

Fifth line of the billing address.

BillingCity String False 255

City name for the billing address.

BillingState String False 255

State name for the billing address.

BillingPostalCode String False 30

Postal code for the billing address.

BillingCountry String False 255

Country for the billing address.

BillingNote String False 41

Note for the billing address.

ShippingAddress String True

Full shipping address returned by QuickBooks. Requires QBBXML Version 7.0 or higher.

ShippingLine1 String False 500

First line of the shipping address. Requires QBBXML Version 7.0 or higher.

ShippingLine2 String False 500

Second line of the shipping address. Requires QBBXML Version 7.0 or higher.

ShippingLine3 String False 500

Third line of the shipping address. Requires QBBXML Version 7.0 or higher.

ShippingLine4 String False 500

Fourth line of the shipping address. Requires QBBXML Version 7.0 or higher.

ShippingLine5 String False 41

Fifth line of the shipping address. Requires QBBXML Version 7.0 or higher.

ShippingCity String False 255

City name for the shipping address. Requires QBBXML Version 7.0 or higher.

ShippingState String False 255

State name for the shipping address. Requires QBBXML Version 7.0 or higher.

ShippingPostalCode String False 30

Postal code for the shipping address. Requires QBBXML Version 7.0 or higher.

ShippingCountry String False 255

Country for the shipping address. Requires QBBXML Version 7.0 or higher.

ShippingNote String False 41

Note for the shipping address. Requires QBBXML Version 7.0 or higher.

Subtotal Double True

Gross subtotal. This does not include tax/amount already paid.

Tax Double True

Total sales tax applied to this transaction.

TaxItem String False 100

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency.

TaxItemId String False

SalesTaxItems.ID

255

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency.

TaxPercent Double True

Percentage charged for sales tax.

IsActive Boolean False

Whether or not the estimate is active.

IsToBeEmailed Boolean False

Whether or not this email is to be emailed.

IsTaxIncluded Boolean False

Determines if tax is included in the transaction amount. Available in only international editions of QuickBooks.

PONumber String False 25

The purchase order number.

Terms String False 100

A reference to terms of payment, predefined within QuickBooks.

TermsId String False 255

A reference to terms of payment, predefined within QuickBooks.

Template String False 100

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

TemplateId String False

Templates.ID

255

The Id of an existing template to apply to the transaction.

CustomerSalesTaxName String False 3

Reference to sales tax information for the customer.

CustomerSalesTaxId String False

SalesTaxCodes.ID

255

Reference to sales tax information for the customer.

ExchangeRate Double False

Indicates the exchange rate for the transaction.

DueDate Date True

Date when credit is due.

CustomFields String False

Custom fields returned from QuickBooks and formatted into XML.

EditSequence String True 16

An identifier used for versioning for this copy of the object.

TimeModified Datetime True

When the credit memo was last modified.

TimeCreated Datetime True

When the credit memo was created.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ItemPriceLevel String

Item price level name. QuickBooks will not return the price level.

ItemOverrideAccount String

The Account Name used to override the default Account for the Item. This is only available during inserts and updates.

ItemOverrideAccountId String

The Account Id used to override the default Account for the Item. This is only available during inserts and updates.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060