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

Properties   Methods   Events   Configuration Settings  

A PriceLevel is used to specify custom pricing.

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

The PriceLevel component may be used to specify custom pricing for specific customers, however you must have QuickBooks 2005 or greater to use Price Levels. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer. (You can override this automatic feature, however, when you create the invoices, sales receipts, etc.)

With QBXMLVersion set to "4.0" or higher, users can now specify a price level (either added with this component or through QuickBooks) on line items in the following components: INVOICE, SALESRECEIPT, CREDITMEMO, and SALESORDER. Please see those components for more information.

Required Fields (Add): PriceLevelName, PriceLevelFixedPercentage.

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

This component is not supported for QuickBooks Online Edition.

Example

   
PriceLevel1.PriceLevelName = "Employee Discount"
PriceLevel1.FixedPercentage = "-15.0"
PriceLevel1.Add()

Price Levels may also be added on a per-item basis using the ItemName/ItemId, ItemCustomPrice, ItemCustomPricePercent, ItemAdjustPercentage, and/or ItemAdjustRelativeTo properties. However, this functionality is only supported in the Premier and Enterprise editions of QuickBooks 2005 and greater.

The PriceLevel component supports a variety of other operations as well. The component's Get, Update, Cancel, and Delete methods may be used to retrieve, modify, cancel, and delete PriceLevels, respectively. The OBJSEARCH component may be used to search for PriceLevels 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.

FixedPercentage Fixed price level.
IsActive Whether or not entity is active.
ItemAdjustPercentage Percentage to adjust price for this item.
ItemAdjustRelativeTo Pricelevel percentage is adjusted relative to this property.
ItemCount Number of line items.
ItemCustomPrice Fixed price for this item.
ItemCustomPricePercent Discount percentage for each item.
ItemId Line item property: Reference to the kind of item.
ItemName Line item property: Reference to the kind of item.
PriceLevelName The name of this price level.
PriceLevelType Indicates the type of PriceLevel returned.
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.

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.
GetByName 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 entity object 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).
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
EditSequence An identifier for this copy of the object.
EnforceMaxLength Indicates whether to enforce max lengths for QB Fields
GetHighestVersion Highest QBXMLVersion supported by the installed instance of Quickbooks.
IgnoreQBOEWarnings Ignores warnings returned from QuickBooks Online.
IsActive Indicates whether the object is currently enabled for use by QuickBooks.
SSLAcceptServerCert The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile The SSL certificate file being used by the Remote Connector
SendRawXML Sends specified XML to quickbooks without modification.
TimeCreated The time the object was created.
TimeModified The time the object was created.

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