Estimates
Stores header-level information of customer estimates or quotes, such as customer details, dates, and total amounts, supporting the sales pipeline.
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.
Select
All filterable columns support the following operators:
- =
- !=
- >=
- <=
- >
- <
- IN
- LIKE
- CONTAINS
The driver processes other filters client-side within the driver.
Insert
To add an Estimate, specify a Customer and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which Estimates. For example:
INSERT INTO Estimates (CustomerRef, LineAggregate)
VALUES ('4', '
<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>
')
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| Id [KEY] | String | True | True | True |
Specifies the unique identifier (Id) of the estimate transaction. | |
| SyncToken | String | True | False | False |
Specifies the version number that is used to lock the estimate transaction object for use by one application at a time. When an application modifies an object, its sync token is incremented. Attempts to modify an object with an older sync token fail. | |
| MetaData_CreateTime | Datetime | True | True | True |
Specifies the date and time when the estimate record was created in the source domain. | |
| MetaData_LastUpdatedTime | Datetime | True | True | True |
Specifies the date and time when the estimate record was last updated in the source domain. | |
| CustomFieldAggregate | String | False | False | False |
Specifies an XML aggregate of custom field information for the estimate transaction. | |
| DocNumber | String | False | True | True |
Specifies the reference number for the estimate transaction. | |
| TxnDate | Date | False | True | True |
Specifies the date when the estimate transaction occurred. | |
| DepartmentRef | String | False |
Departments.Id | False | False |
Specifies the unique Id of the department that stores the location of the estimate transaction as defined using location tracking in QuickBooks Online. |
| DepartmentRef_Name | String | True |
Departments.Name | False | False |
Specifies the name of the department that stores the location of the estimate transaction as defined using location tracking in QuickBooks Online. |
| PrivateNote | String | False | False | False |
Specifies a private note that does not appear on the estimate transaction records. | |
| TxnStatus | String | False | False | False |
Specifies the status of the estimate transaction. The allowed values are Accepted, Closed, Pending, Rejected. | |
| LinkedTxnAggregate | String | False | False | False |
Specifies an XML aggregate of transactions linked to the estimate transaction. | |
| LineAggregate | String | False | False | False |
Specifies an XML aggregate of line items associated with the estimate transaction. | |
| TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
Specifies the tax code for the estimate transaction. |
| TxnTaxDetail_TotalTax | String | False | False | False |
Specifies the total tax calculated for the estimate transaction, excluding any tax lines manually inserted into the transaction line list. | |
| TxnTaxDetail_TaxLineAggregate | String | False | False | False |
Specifies an XML aggregate of tax line items that are associated with the estimate transaction. | |
| CustomerRef | String | False |
Customers.Id | True | False |
Specifies the unique Id of the customer associated with the estimate transaction. |
| CustomerRef_Name | String | True |
Customers.DisplayName | False | False |
Specifies the name of the customer associated with the estimate transaction. |
| CustomerMemo | String | False | False | False |
Specifies the message to the customer that appears in the invoice and in the printed invoice for the estimate transaction. | |
| BillAddr_Id | String | False | False | False |
Specifies the unique Id of the entity for the billing address, mainly used for modifying the address. | |
| BillAddr_Line1 | String | False | False | False |
Specifies the first line of the billing address. | |
| BillAddr_Line2 | String | False | False | False |
Specifies the second line of the billing address. | |
| BillAddr_Line3 | String | False | False | False |
Specifies the third line of the billing address. | |
| BillAddr_Line4 | String | False | False | False |
Specifies the fourth line of the billing address. | |
| BillAddr_Line5 | String | False | False | False |
Specifies the fifth line of the billing address. | |
| BillAddr_City | String | False | False | False |
Specifies the city name of the billing address. | |
| BillAddr_Country | String | False | False | False |
Specifies the country name of the billing address. | |
| BillAddr_CountrySubDivisionCode | String | False | False | False |
Specifies the region within the country of the billing address. This field represents the state name for the USA or the province name for Canada. | |
| BillAddr_PostalCode | String | False | False | False |
Specifies the postal code of the billing address. This field represents the ZIP code for the USA and the postal code Canada. | |
| BillAddr_Lat | String | False | False | False |
Specifies the latitude coordinate of the geocoded billing address. | |
| BillAddr_Long | String | False | False | False |
Specifies the longitude coordinate of the geocoded billing address. | |
| ShipAddr_Id | String | False | False | False |
Specifies the unique Id of the entity for the shipping address, mainly used for modifying the address. | |
| ShipAddr_Line1 | String | False | False | False |
Specifies the first line of the shipping address. | |
| ShipAddr_Line2 | String | False | False | False |
Specifies the second line of the shipping address. | |
| ShipAddr_Line3 | String | False | False | False |
Specifies the third line of the shipping address. | |
| ShipAddr_Line4 | String | False | False | False |
Specifies the fourth line of the shipping address. | |
| ShipAddr_Line5 | String | False | False | False |
Specifies the fifth line of the shipping address. | |
| ShipAddr_City | String | False | False | False |
Specifies the city name of the shipping address. | |
| ShipAddr_Country | String | False | False | False |
Specifies the country name of the shipping address. | |
| ShipAddr_CountrySubDivisionCode | String | False | False | False |
Specifies the region within the country of the shipping address. This field represents the state name for the USA or the province name for Canada. | |
| ShipAddr_PostalCode | String | False | False | False |
Specifies the postal code of the shipping address. This field represents the ZIP code for the USA and the postal code for Canada. | |
| ShipAddr_Lat | String | False | False | False |
Specifies the latitude coordinate of the geocoded shipping address. | |
| ShipAddr_Long | String | False | False | False |
Specifies the longitude coordinate of the geocoded shipping address. | |
| ClassRef | String | False |
Class.Id | True | False |
Specifies the unique Id of the class that is associated with the estimate transaction. |
| ClassRef_Name | String | True |
Class.FullyQualifiedName | False | False |
Specifies the name of the class that is associated with the estimate transaction. |
| SalesTermRef | String | False |
Terms.Id | False | False |
Specifies the unique Id of the sales term that is associated with the estimate transaction. |
| SalesTermRef_Name | String | True |
Terms.Name | False | False |
Specifies the name of the sales term that is associated with the estimate transaction. |
| DueDate | Date | False | True | False |
Specifies the due date for the estimate transaction, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used. | |
| ShipMethodRef | String | False | False | False |
Specifies the unique Id of the shipping method that is associated with the estimate transaction. | |
| ShipMethodRef_Name | String | True | False | False |
Specifies the name of the shipping method that is associated with the estimate transaction. | |
| ShipDate | Date | False | False | False |
Specifies the date for delivery of goods or services related to the estimate transaction. | |
| TrackingNum | String | False | False | False |
Specifies the tracking number from the shipping provider for the delivery of goods associated with the estimate transaction. | |
| TotalAmt | Decimal | True | True | True |
Specifies the total amount of the estimate transaction. This total includes all charges, allowances, and taxes. | |
| PrintStatus | String | False | False | False |
Specifies the print status of the estimate transaction. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet. | |
| EmailStatus | String | False | False | False |
Specifies the email status of the estimate transaction. The allowed values are NotSet, NeedToSend, EmailSent. The default value is NotSet. | |
| BillEmail_Address | String | False | False | False |
Specifies the email address where the estimate transaction is sent. If the value of EmailStatus is NeedToSend, this field is required. | |
| ExpirationDate | Date | False | False | False |
Specifies the date when the estimate becomes invalid. | |
| AcceptedBy | String | False | False | False |
Specifies the name of the customer who accepted the estimate. | |
| AcceptedDate | Date | False | False | False |
Specifies the date when the estimate was accepted. | |
| ApplyTaxAfterDiscount | Boolean | False | False | False |
Indicates whether discounts are applied before the tax is calculated for the estimate transaction. | |
| CurrencyRef | String | False | False | False |
Specifies the unique Id of the currency used in the estimate transaction. | |
| CurrencyRef_Name | String | True | False | False |
Specifies the name of the currency used in the estimate transaction. | |
| ExchangeRate | Decimal | False | False | False |
Specifies the currency exchange rate. This field is valid only if the company file is set up to use the multicurrency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. This field is available for the UK, AU, and CA editions. | |
| GlobalTaxCalculation | String | False | False | False |
Specifies the method that is used to apply taxes. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable. | |
| HomeTotalAmt | Decimal | True | False | False |
Specifies the total amount of the estimate transaction expressed in the home currency. This total includes all charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions. | |
| TransactionLocationType | String | False | False | False |
Specifies the account location. This field is valid only in the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU. | |
| ProjectRef | String | False | True | False |
Specifies the unique Id of the project that is associated with the estimate transaction. | |
| RecurDataRef | String | True | False | False |
Specifies the unique Id of the recurring transaction template from which the estimate transaction was created. | |
| TaxExemptionRef | String | True | False | False |
Specifies the tax exemption Id for the customer to which this estimate transaction is associated. This Id is typically issued by the state. | |
| FreeFormAddress | Boolean | False | False | False |
Indicates whether the ShipAddr is stored as a formatted or unformatted (free form) address. This value is system-defined based on the format of the shipping address at the time the object is created. |