Search: 
Available in: QUICKBOOKS
Estimate Component [IBiz Integrator for QuickBooks - V4]

Properties   Methods   Events   Configuration Settings  

An Estimate is a description of a sale that the company proposes to make to a CUSTOMER.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

An Estimate is a description of a sale that the company proposes to make to a CUSTOMER. An Estimate uses nearly the same fields as an INVOICE. However, the transaction is non-posting; it will not affect any of the company's account balances unless the QuickBooks user converts it into an INVOICE.

Required Fields (Add): Customer*, Items

Supported Methods: Add, Get (Id), Cancel, Delete

This component is not supported for QuickBooks Online Edition. Example

   
Estimate1.CustomerName = "John Q. Customer"             '*
Estimate1.TransactionDate = "1/17/03"
Estimate1.ItemCount = 1
Estimate1.ItemName(0) = "Our Company's Product"         '*
Estimate1.ItemMarkupRatePercent(0) = 20 
Estimate1.Add()

'*: Item must already exist in QuickBooks.

The total Amount of an Estimate is the total of its item lines.

Item Lines: Item lines are used to track the goods or services offered for sale. Line items may be added by first setting ItemCount. Then, for each line, set Item* (ItemId or ItemName) or ItemGroup*, and optionally ItemRate, ItemRatePercent, ItemMarkupRate, ItemMarkupRatePercent, ItemQuantity, ItemDescription, ItemClass*, ItemTaxCode*, and ItemAmount as well.

The component supports a variety of other operations as well. The component's Get,and Delete methods may be used to retrieve, and delete Estimates, respectively. The OBJSEARCH component may be used to search for Estimates in the QuickBooks database.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

Amount Amount of transaction.
BillingAddress Address to bill to.
CustomerId A reference to the customer or customer job.
CustomerMessageId Reference to message to appear to customer.
CustomerMessageName Reference to message to appear to customer.
CustomerName A reference to the customer or customer job.
DueDate Date when payment is due.
IncludeLinkedTxns Indicates whether to include linked transactions in the response.
ItemAmount Line item property: the total amount of this line.
ItemClassId Line item property: Reference to the class of the item.
ItemClassName Line item property: Reference to the class of the item.
ItemCount Number of line items.
ItemDescription Line item property: Description of item.
ItemGroupId Line item property: Reference to a group of line items.
ItemGroupName Line item property: Reference to a group of line items.
ItemId Line item property: Reference to the kind of item.
ItemMarkupRate Line item property: A markup rate for the item.
ItemMarkupRatePercent Line item property: A markup rate percent for the item.
ItemName Line item property: Reference to the kind of item.
ItemQuantity Line item property: Quantity of item or item group.
ItemRate Unit rate of item.
ItemRatePercent Line item property: A markup or discount percentage.
ItemTaxCodeId Line item property: Sales tax information for this item.
ItemTaxCodeName Line item property: Sales tax information for this item.
LinkedTxnAmount Linked Transaction property: The amount of the transaction.
LinkedTxnCount Linked Transaction property: Number of linked transactions.
LinkedTxnDate Linked Transaction property: The date of the transaction.
LinkedTxnId Linked Transaction property: Reference to the kind of item.
LinkedTxnLinkType Linked Transaction property: Indicates the nature of the link between the transactions.
LinkedTxnRefNumber Linked Transaction property: Reference number for the linked transaction.
LinkedTxnType Linked Transaction property: The type of the transaction.
Memo Memo to appear on internal reports only.
PONumber P.O. number.
QBAddRequestAggregate Request aggregate for an Add.
QBConnectionMode The mode of connection to QuickBooks.
QBConnectionString An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile The file currently open in QuickBooks.
QBRequestId The Id of the next message to be sent to QuickBooks.
QBResponseAggregate The last XML response aggregate received from QuickBooks.
QBUpdateRequestAggregate Request aggregate for an Update.
QBXMLVersion The version of QBXML used in the outgoing message.
RefId An alphanumerical identifier generated by the server.
RefNumber Reference number for the transaction.
SalesRepId Reference to (initials of) sales rep.
SalesRepName Reference to (initials of) sales rep.
SalesTaxTotal Total amount of sales tax.
Subtotal Gross subtotal; doesn't count taxes/amount already paid.
TaxItemId Reference to detailed taxation information.
TaxItemName Reference to detailed taxation information.
TermsId Reference to terms of payment.
TermsName Reference to terms of payment.
TransactionDate Date of transaction.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

AXMExport Exports the object.
AXMImport Imports the object.
Add Adds the record into QuickBooks.
CheckRequestStatus Checks whether or not the specified request was processed by QuickBooks.
CloseQBConnection Closes a persistent connection to QuickBooks.
Config Sets or retrieves a component configuration setting.
Delete Deletes the record from QuickBooks.
Get Gets a single record from QuickBooks.
GetCustomField Gets a custom field value from QuickBooks.
OpenQBConnection Opens a persistent connection to QuickBooks.
Reset Resets all properties to their defaults.
SetCustomField Sets a custom field value within QuickBooks.
Update Updates the estimate in QuickBooks.
WebExport Exports the object to a web client.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Error Information about errors during data delivery.
Status Shows the progress of the QuickBooks connection.
Warning Fired when a warning occurs.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AppendAfter Appends an xml tag after the specified QBXML element.
AuthFlags Connection Flags (use for QuickBooks Simple Start).
ClassId A reference to the class of transaction.
ClassName A reference to the class of transaction.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
CustomerSalesTaxId Reference to sales tax information for the .
CustomerSalesTaxName Reference to sales tax information for the .
EditSequence An identifier for this copy of the object.
EnforceMaxLength Indicates whether to enforce max lengths for QB Fields
ExchangeRate Indicates the exchange rate for the transaction.
FOB Freight On Board: the place from where shipped.
GetHighestVersion Highest QBXMLVersion supported by the installed instance of Quickbooks.
IgnoreQBOEWarnings Ignores warnings returned from QuickBooks Online.
IncludeLinkedTxns Indicates to QuickBooks whether to return transactions linked to this request.
ItemsAggregate Allows the user to set the item xml directly.
SSLAcceptServerCert The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile The SSL certificate file being used by the Remote Connector
SalesTaxPercentage Percent paid as sales tax.
SendRawXML Sends specified XML to quickbooks without modification.
Tax1Total Canadian field used for Goods and Services Tax, or GST.
Tax2Total Canadian field used for Provincial Sales Taxes, or PST.
TemplateId The ID of an existing template to apply to the transaction.
TemplateName The name of an existing template to apply to the transaction.
TimeCreated The time the object was created.
TimeModified The time the object was created.
{Items[index].Amount} The amount in dollars for the line item at the specified index.
{Items[index].Quantity} The quantity for the line item at the specified index.
{Items[index].Rate} The rate in dollars for the line item at the specified index.

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.