ADO.NET Provider for QuickBooks

Build 21.0.7867

Estimates

Create, update, delete, and query QuickBooks Estimates.

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 typically be used with only the equals or = comparison. The available columns for Estimates are Id, Date, TimeModified, ReferenceNumber, 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 Estimates 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. The ItemAggregate column may be used to specify an XML aggregate of Line Item data. The columns that may be used in these aggregates are defined in the EstimateLineItems table and it starts with Item. For example, the following will insert a new Estimate with two Line Items:

INSERT INTO Estimates (CustomerName, ItemAggregate) 
VALUES ('Abercrombie, Kristy', 
'<EstimateLineItems>
<Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row>
<Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row>
</EstimateLineItems>')
To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'

Columns

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

The unique identifier.

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

Customers.FullName

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 Decimal True

Total amount for this transaction.

Message String False

CustomerMessages.Name

101

Message to the customer.

MessageId String False

CustomerMessages.ID

255

Message to the customer.

Class String False

Class.FullName

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

SalesReps.Initial

5

Reference to (initials of) the sales rep.

SalesRepId String False

SalesReps.ID

255

Reference to (ID 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 Decimal True

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

Tax Double True

Total sales tax applied to this transaction.

TaxItem String False

SalesTaxItems.Name

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 the terms of payment, predefined within QuickBooks.

TermsId String False 255

A reference to the terms of payment, predefined within QuickBooks.

Template String False

Templates.Name

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

SalesTaxCodes.Name

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.

Other String False 29

Other data associated with the estimate.

ItemCount Integer True

A count of the line items.

ItemAggregate String False 5000

An aggregate of the line item data which can be used for adding a estimates and its line item data.

TransactionCount Integer True

The count of related transactions to the estimates.

TransactionAggregate String True 5000

An aggregate of the linked transaction data.

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 estimate was last modified.

TimeCreated Datetime True

When the estimate 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
Item* String

All line-item-specific columns may be used in insertions.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7867