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.
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 |
The Id of the Estimate. | |
SyncToken | String | True | False | False |
Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. | |
MetaData_CreateTime | Datetime | True | True | True |
The time the record was created. | |
MetaData_LastUpdatedTime | Datetime | True | True | True |
The time the record was last updated. | |
DocNumber | String | False | True | True |
The reference number for the transaction. | |
TxnDate | Date | False | True | True |
The date when this transaction occurred. | |
DepartmentRef | String | False |
Departments.Id | False | False |
The Id of the department, which stores the location of the transaction as defined using location tracking in QuickBooks Online. |
DepartmentRef_Name | String | True |
Departments.Name | False | False |
The name of the department, which stores the location of the transaction as defined using location tracking in QuickBooks Online. |
PrivateNote | String | False | False | False |
A private note, which will not appear on the transaction records. | |
TxnStatus | String | False | False | False |
The status of the transaction. 使用できる値は次のとおりです。Accepted, Closed, Pending, Rejected | |
LinkedTxnAggregate | String | False | False | False |
An XML aggregate of transactions linked to the estimate. | |
LineAggregate | String | False | False | False |
An XML aggregate of line items associated with the transaction. other:childtable= | |
TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
The tax code for the transaction. |
TxnTaxDetail_TotalTax | String | False | False | False |
The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list. | |
TxnTaxDetail_TaxLineAggregate | String | False | False | False |
An XML aggregate of tax line items. | |
CustomerRef | String | False |
Customers.Id | True | False |
The Id of the customer. |
CustomerRef_Name | String | True |
Customers.DisplayName | False | False |
The name of the customer. |
CustomerMemo | String | False | False | False |
A message to the customer, which appears in the invoice and in the printed invoice. | |
BillAddr_Id | String | False | False | False |
The Id of the entity for the billing address, mainly used for modifying the address. This field is assigned by the data service. | |
BillAddr_Line1 | String | False | False | False |
First line of the billing address. | |
BillAddr_Line2 | String | False | False | False |
Second line of the billing address. | |
BillAddr_Line3 | String | False | False | False |
Third line of the billing address. | |
BillAddr_Line4 | String | False | False | False |
Fourth line of the billing address. | |
BillAddr_Line5 | String | False | False | False |
Fifth line of the billing address. | |
BillAddr_City | String | False | False | False |
City name. | |
BillAddr_Country | String | False | False | False |
Country name. | |
BillAddr_CountrySubDivisionCode | String | False | False | False |
Country region. For example, the state name for the USA or the province name for Canada. | |
BillAddr_PostalCode | String | False | False | False |
Postal code. The zip code for the USA and Canada. | |
BillAddr_Note | String | False | False | False |
Note for the customer. | |
BillAddr_Lat | String | False | False | False |
The latitude coordinate of the geocoded billing address. | |
BillAddr_Long | String | False | False | False |
The longitude coordinate of the geocoded billing address. | |
ShipAddr_Id | String | False | False | False |
The Id of the entity for the shipping address, mainly used for modifying the address. This field is assigned by the data service. | |
ShipAddr_Line1 | String | False | False | False |
First line of the shipping address. | |
ShipAddr_Line2 | String | False | False | False |
Second line of the shipping address. | |
ShipAddr_Line3 | String | False | False | False |
Third line of the shipping address. | |
ShipAddr_Line4 | String | False | False | False |
Fourth line of the shipping address. | |
ShipAddr_Line5 | String | False | False | False |
Fifth line of the shipping address. | |
ShipAddr_City | String | False | False | False |
City name. | |
ShipAddr_Country | String | False | False | False |
Country name. | |
ShipAddr_CountrySubDivisionCode | String | False | False | False |
Country region. For example, the state name for the USA or the province name for Canada. | |
ShipAddr_PostalCode | String | False | False | False |
Postal code. For example, the zip code for the USA and Canada. | |
ShipAddr_Note | String | False | False | False |
Note for the customer. | |
ShipAddr_Lat | String | False | False | False |
The latitude coordinate of the geocoded shipping address. | |
ShipAddr_Long | String | False | False | False |
The longitude coordinate of the geocoded shipping address. | |
ClassRef | String | False |
Class.Id | True | False |
The Id of the class associated with the transaction. |
ClassRef_Name | String | True |
Class.FullyQualifiedName | False | False |
The name of the class associated with the transaction. |
SalesTermRef | String | False |
Terms.Id | False | False |
The Id of the sales terms associated with the transaction. |
SalesTermRef_Name | String | True |
Terms.Name | False | False |
The name of the sales terms associated with the transaction. |
DueDate | Date | False | True | False |
The due date for the invoice, 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 |
The Id of the shipping method associated with the transaction. | |
ShipMethodRef_Name | String | True | False | False |
The name of the shipping method associated with the transaction. | |
ShipDate | Date | False | False | False |
The date for delivery of goods or services. | |
TrackingNum | String | False | False | False |
The tracking number for the shipping provider for the delivery of the goods associated with the transaction. | |
TotalAmt | Decimal | True | True | True |
The total amount of the transaction. This includes the total of all the charges, allowances, and taxes. | |
PrintStatus | String | False | False | False |
The print status of the invoice. 使用できる値は次のとおりです。NotSet, NeedToPrint, PrintComplete デフォルト値はNotSetです。 | |
EmailStatus | String | False | False | False |
The email status of the invoice. 使用できる値は次のとおりです。NotSet, NeedToSend, EmailSent デフォルト値はNotSetです。 | |
BillEmail_Address | String | False | False | False |
The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input. | |
Balance | Decimal | False | True | True |
This column sets whether the transaction is a finance charge. | |
ExpirationDate | Date | False | False | False |
The date when the estimate becomes invalid. | |
AcceptedBy | String | False | False | False |
The name of the customer who accepted the estimate. | |
AcceptedDate | Date | False | False | False |
The date the estimate was accepted. | |
ApplyTaxAfterDiscount | Boolean | False | False | False |
This field sets whether discounts are applied before the tax is calculated. | |
CurrencyRef | String | False | False | False |
The Id of the currency used in the transaction. | |
CurrencyRef_Name | String | True | False | False |
The name of the currency used in the transaction. | |
ExchangeRate | Decimal | False | False | False |
The currency exchange rate. This field is valid only if the company file is set up to use 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 |
The method used to apply taxes. This field is valid in the UK, AU, and CA editions. 使用できる値は次のとおりです。TaxExcluded, TaxInclusive, NotApplicable | |
HomeTotalAmt | Decimal | True | False | False |
The total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions. |