PriceLevel Bean
Properties Methods Events Configuration Settings Errors
A PriceLevel is used to specify custom pricing.
Syntax
InQB.Pricelevel
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
Example
PriceLevel1.PriceLevelName = "Employee Discount" PriceLevel1.FixedPercentage = "-15.0" PriceLevel1.Add()
Price Levels may also be added on a per-item basis using the Items property. 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 bean with short descriptions. Click on the links for further details.
FixedPercentage | Fixed price level. |
IsActive | Whether or not entity is active. |
Items | Collection of price level items. |
PriceLevelName | The name of this price level. |
PriceLevelType | Indicates the type of PriceLevel returned. |
QBConnectionString | An aggregate consisting of various QuickBooks connection properties. |
QBRequestAggregate | The request aggregate. |
QBRequestId | The Id of the next message to be sent to QuickBooks. |
QBRequestMode | Defines whether the request is made online or stored offline. |
QBResponseAggregate | The last QBXML response aggregate received from QuickBooks. |
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 bean with short descriptions. Click on the links for further details.
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 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. |
importQBXML | Imports a QBXML response aggregate. |
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. |
Event List
The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
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 bean with short descriptions. Click on the links for further details.
SendRawXML | Sends specified XML to quickbooks without modification. |
AppendAfter | Appends an XML tag after the specified QBXML element. |
TimeCreated | The time the object was created. |
TimeModified | The time the object was created. |
EditSequence | An identifier for this copy of the object. |
IsActive | Indicates whether the object is currently enabled for use by QuickBooks. |
StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
SSLAcceptServerCert | The SSL certificate being used by the Remote Connector. |
SSLAcceptServerCertFile | The SSL certificate file being used by the Remote Connector. |
EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
QBOpenCompanyFile | The file currently open in QuickBooks. |
QBConnectionMode | The mode of connection to QuickBooks. |
QBFileStatus | The status of the company file as it pertains to accepting connections. |
WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
CodePage | The system code page used for Unicode to Multibyte translations. |