AdjustInventory Class
Properties Methods Events Config Settings Errors
The AdjustInventory class is used to adjust your inventory.
Syntax
AdjustInventory
Remarks
The AdjustInventory class is used to adjust your current inventory levels within QuickBooks by sending an Inventory Adjustment transaction. This class does not directly manipulate inventory items, but rather it sends and retrieves Inventory Adjustment transactions. Each Inventory Adjustment Transaction that is added to or retrieved from QuickBooks may contain one or more Adjustment Line Items. Each adjustment line is represented by a number of properties, each prefixed by "Adjustment". Any number of different inventory items may added to the Adjustment Line Items by simply increasing the AdjustmentCount and setting the Adjustment properties for each AdjustmentIndex.
When you have all the inventory items added to the Adjustment Line Items properties, set the AccountName and you can then Add the transaction to QuickBooks. Please note that only pre-existing inventory items may be adjusted. To add, get, or modify existing inventory items, please use the Item Class.
Required Fields (Add): AccountId or AccountName, and at least one Inventory Item (AdjustmentItemId or AdjustmentItemName), plus an AdjustmentNewQuantity and/or AdjustmentNewValue.
Supported Methods:Add, Get (Id), Cancel, Delete
Example
class.AccountName = "Inventory Asset" '*
class.Memo = "Small warehouse fire."
class.AdjustmentCount = 1
class.AdjustmentItemName(0) = "Hardware:Brass Hinges" '*
class.AdjustmentItemNewQuantity(0) = "130"
class.Add()
'*: Item must already exist in QuickBooks.
Note: The QuickBooks company file must be open in single-user mode. You cannot adjust the inventory while the company file is open in multi-user mode. Also, the QuickBooks Inventory Adjustment form must not be open, or you will receive an error.
The AdjustInventory class supports a variety of other operations as well. The class's Get, Cancel, and Delete methods may be used to retrieve, cancel, and delete Inventory Adjustment transactions. The ObjSearch Class may be used to search for Inventory Adjustments in the QuickBooks database.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AccountId | Reference to account from which funds are being drawn. |
AccountName | Reference to account from which funds are being drawn. |
AdjustmentCount | The number of records in the Adjustment arrays. |
AdjustmentItemId | Line item property: Reference to the kind of item to be adjusted. |
AdjustmentItemName | Line item property: Reference to the kind of item to be adjusted. |
AdjustmentLineId | Identification number of the transaction line, returned in the response. |
AdjustmentNewQuantity | Line item property: The new quantity for this adjustment. |
AdjustmentNewValue | Line item property: New value of this adjustment. |
AdjustmentQuantityDifference | Line item property: The change in quantity for this adjustment. |
AdjustmentValueDifference | Line item property: The change in total value for this adjustment. |
ClassId | Reference to the class of the Inventory Adjustment. |
ClassName | Reference to the class of the Inventory Adjustment. |
CustomerId | A reference to the customer or customer job. |
CustomerName | A reference to the customer or customer job. |
Memo | Memo to appear on internal reports only. |
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. |
RefNumber | Reference number for the transaction. |
TransactionDate | Date of transaction. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Add | Adds the Inventory Adjustment into QuickBooks. |
Cancel | Cancels (voids) the transaction. |
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. |
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. |
Event List
The following is the full list of the events fired by the class 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. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
Adjustments[i].NewQuantity | Used to set the AdjustmentNewQuantity at index i as a string. |
Adjustments[i].QuantityDifference | Used to set the AdjustmentQuantityDifference at index i as a string. |
AppendAfter | Appends an XML tag after the specified QBXML element. |
AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
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. |
GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
QBConnectionMode | The mode of connection to QuickBooks. |
QBFileStatus | The status of the company file as it pertains to accepting connections. |
QBOpenCompanyFile | The file currently open in QuickBooks. |
SendRawXML | Sends specified XML to quickbooks without modification. |
SSLAcceptServerCert | The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector). |
SSLAcceptServerCertFile | The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector). |
StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
TimeCreated | The time the object was created. |
TimeModified | The time the object was created. |
UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
UpdateAdjustInventory | Updates the inventory adjustment in QuickBooks. |
WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
AccountId Property (AdjustInventory Class)
Reference to account from which funds are being drawn.
Syntax
ANSI (Cross Platform) char* GetAccountId();
int SetAccountId(const char* lpszAccountId); Unicode (Windows) LPWSTR GetAccountId();
INT SetAccountId(LPCWSTR lpszAccountId);
char* inqb_adjustinventory_getaccountid(void* lpObj);
int inqb_adjustinventory_setaccountid(void* lpObj, const char* lpszAccountId);
QString GetAccountId();
int SetAccountId(QString qsAccountId);
Default Value
""
Remarks
A reference to an Expense or Income account from which the Inventory Adjustment affects. For example, "Inventory Asset". Id/Name Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.
Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.
Setting the value of this property will set the corresponding Name property to an empty string. This property is required.
Data Type
String
AccountName Property (AdjustInventory Class)
Reference to account from which funds are being drawn.
Syntax
ANSI (Cross Platform) char* GetAccountName();
int SetAccountName(const char* lpszAccountName); Unicode (Windows) LPWSTR GetAccountName();
INT SetAccountName(LPCWSTR lpszAccountName);
char* inqb_adjustinventory_getaccountname(void* lpObj);
int inqb_adjustinventory_setaccountname(void* lpObj, const char* lpszAccountName);
QString GetAccountName();
int SetAccountName(QString qsAccountName);
Default Value
""
Remarks
A reference to an Expense or Income account from which the Inventory Adjustment affects. For example, "Inventory Asset". Name/Id Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.
Setting the value of this property will set the corresponding Id property to an empty string. This property is required.
Data Type
String
AdjustmentCount Property (AdjustInventory Class)
The number of records in the Adjustment arrays.
Syntax
ANSI (Cross Platform) int GetAdjustmentCount();
int SetAdjustmentCount(int iAdjustmentCount); Unicode (Windows) INT GetAdjustmentCount();
INT SetAdjustmentCount(INT iAdjustmentCount);
int inqb_adjustinventory_getadjustmentcount(void* lpObj);
int inqb_adjustinventory_setadjustmentcount(void* lpObj, int iAdjustmentCount);
int GetAdjustmentCount();
int SetAdjustmentCount(int iAdjustmentCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- AdjustmentItemId
- AdjustmentItemName
- AdjustmentLineId
- AdjustmentNewQuantity
- AdjustmentNewValue
- AdjustmentQuantityDifference
- AdjustmentValueDifference
This property is not available at design time.
Data Type
Integer
AdjustmentItemId Property (AdjustInventory Class)
Line item property: Reference to the kind of item to be adjusted.
Syntax
ANSI (Cross Platform) char* GetAdjustmentItemId(int iAdjustmentIndex);
int SetAdjustmentItemId(int iAdjustmentIndex, const char* lpszAdjustmentItemId); Unicode (Windows) LPWSTR GetAdjustmentItemId(INT iAdjustmentIndex);
INT SetAdjustmentItemId(INT iAdjustmentIndex, LPCWSTR lpszAdjustmentItemId);
char* inqb_adjustinventory_getadjustmentitemid(void* lpObj, int adjustmentindex);
int inqb_adjustinventory_setadjustmentitemid(void* lpObj, int adjustmentindex, const char* lpszAdjustmentItemId);
QString GetAdjustmentItemId(int iAdjustmentIndex);
int SetAdjustmentItemId(int iAdjustmentIndex, QString qsAdjustmentItemId);
Default Value
""
Remarks
Line item property: Reference to the kind of item to be adjusted.
Adjustment Line items represent either quantity or value adjustments made on an inventory item. The AdjustmentItemId or AdjustmentItemName represent which inventory item the adjustment is acting on, and AdjustmentNewQuantity and AdjustmentNewValue properties are used to indicate how much you wish to change either the quantity or the value of the specified inventory item. AdjustmentValueDifference and AdjustmentQuantityDifference will be filled after a successful Get or Add.
The AdjustmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AdjustmentCount property.
This property is not available at design time.
Data Type
String
AdjustmentItemName Property (AdjustInventory Class)
Line item property: Reference to the kind of item to be adjusted.
Syntax
ANSI (Cross Platform) char* GetAdjustmentItemName(int iAdjustmentIndex);
int SetAdjustmentItemName(int iAdjustmentIndex, const char* lpszAdjustmentItemName); Unicode (Windows) LPWSTR GetAdjustmentItemName(INT iAdjustmentIndex);
INT SetAdjustmentItemName(INT iAdjustmentIndex, LPCWSTR lpszAdjustmentItemName);
char* inqb_adjustinventory_getadjustmentitemname(void* lpObj, int adjustmentindex);
int inqb_adjustinventory_setadjustmentitemname(void* lpObj, int adjustmentindex, const char* lpszAdjustmentItemName);
QString GetAdjustmentItemName(int iAdjustmentIndex);
int SetAdjustmentItemName(int iAdjustmentIndex, QString qsAdjustmentItemName);
Default Value
""
Remarks
Line item property: Reference to the kind of item to be adjusted.
Adjustment Line items represent either quantity or value adjustments made on an inventory item. The AdjustmentItemId or AdjustmentItemName represent which inventory item the adjustment is acting on, and AdjustmentNewQuantity and AdjustmentNewValue properties are used to indicate how much you wish to change either the quantity or the value of the specified inventory item. AdjustmentValueDifference and AdjustmentQuantityDifference will be filled after a successful Get or Add.
The AdjustmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AdjustmentCount property.
This property is not available at design time.
Data Type
String
AdjustmentLineId Property (AdjustInventory Class)
Identification number of the transaction line, returned in the response.
Syntax
ANSI (Cross Platform) char* GetAdjustmentLineId(int iAdjustmentIndex);
int SetAdjustmentLineId(int iAdjustmentIndex, const char* lpszAdjustmentLineId); Unicode (Windows) LPWSTR GetAdjustmentLineId(INT iAdjustmentIndex);
INT SetAdjustmentLineId(INT iAdjustmentIndex, LPCWSTR lpszAdjustmentLineId);
char* inqb_adjustinventory_getadjustmentlineid(void* lpObj, int adjustmentindex);
int inqb_adjustinventory_setadjustmentlineid(void* lpObj, int adjustmentindex, const char* lpszAdjustmentLineId);
QString GetAdjustmentLineId(int iAdjustmentIndex);
int SetAdjustmentLineId(int iAdjustmentIndex, QString qsAdjustmentLineId);
Default Value
""
Remarks
Identification number of the transaction line, returned in the response.
The AdjustmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AdjustmentCount property.
This property is not available at design time.
Data Type
String
AdjustmentNewQuantity Property (AdjustInventory Class)
Line item property: The new quantity for this adjustment.
Syntax
ANSI (Cross Platform) char* GetAdjustmentNewQuantity(int iAdjustmentIndex);
int SetAdjustmentNewQuantity(int iAdjustmentIndex, const char* lpszAdjustmentNewQuantity); Unicode (Windows) LPWSTR GetAdjustmentNewQuantity(INT iAdjustmentIndex);
INT SetAdjustmentNewQuantity(INT iAdjustmentIndex, LPCWSTR lpszAdjustmentNewQuantity);
char* inqb_adjustinventory_getadjustmentnewquantity(void* lpObj, int adjustmentindex);
int inqb_adjustinventory_setadjustmentnewquantity(void* lpObj, int adjustmentindex, const char* lpszAdjustmentNewQuantity);
QString GetAdjustmentNewQuantity(int iAdjustmentIndex);
int SetAdjustmentNewQuantity(int iAdjustmentIndex, QString qsAdjustmentNewQuantity);
Default Value
""
Remarks
Line item property: The new quantity for this adjustment.
When issuing an Inventory Quantity Adjustment or Value Adjustment, this is the new quantity for the inventory item indicated by AdjustmentItemName and AdjustmentItemId.
Either AdjustmentNewQuantity and/or AdjustmentNewValue must be specified for each Adjustment, or the class will fails with an error.
The default value of "" indicates that this property is not specified, and no new quantity will be sent.
The AdjustmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AdjustmentCount property.
This property is not available at design time.
Data Type
String
AdjustmentNewValue Property (AdjustInventory Class)
Line item property: New value of this adjustment.
Syntax
ANSI (Cross Platform) char* GetAdjustmentNewValue(int iAdjustmentIndex);
int SetAdjustmentNewValue(int iAdjustmentIndex, const char* lpszAdjustmentNewValue); Unicode (Windows) LPWSTR GetAdjustmentNewValue(INT iAdjustmentIndex);
INT SetAdjustmentNewValue(INT iAdjustmentIndex, LPCWSTR lpszAdjustmentNewValue);
char* inqb_adjustinventory_getadjustmentnewvalue(void* lpObj, int adjustmentindex);
int inqb_adjustinventory_setadjustmentnewvalue(void* lpObj, int adjustmentindex, const char* lpszAdjustmentNewValue);
QString GetAdjustmentNewValue(int iAdjustmentIndex);
int SetAdjustmentNewValue(int iAdjustmentIndex, QString qsAdjustmentNewValue);
Default Value
""
Remarks
Line item property: New value of this adjustment.
The new total value of these inventory items (The new value does NOT have to equal QuantityOnHand times PurchaseCost).
If this property is specified, the component will send a ValueAdjustment request for this line. The AdjustmentNewQuantity property may be set in conjunction with the AdjustmentNewValue property, and so long as AdjustmentNewValue is not empty, a ValueAdjustment request will be sent for this line. However, if AdjustmentNewValue is empty a QuantityAdjustment will be sent instead.
Either AdjustmentNewQuantity and/or AdjustmentNewValue must be specified for each Adjustment, or the class will fails with an error.
The default value of "" indicates that this property is not specified, and no new value will be sent.
The AdjustmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AdjustmentCount property.
This property is not available at design time.
Data Type
String
AdjustmentQuantityDifference Property (AdjustInventory Class)
Line item property: The change in quantity for this adjustment.
Syntax
ANSI (Cross Platform) char* GetAdjustmentQuantityDifference(int iAdjustmentIndex);
int SetAdjustmentQuantityDifference(int iAdjustmentIndex, const char* lpszAdjustmentQuantityDifference); Unicode (Windows) LPWSTR GetAdjustmentQuantityDifference(INT iAdjustmentIndex);
INT SetAdjustmentQuantityDifference(INT iAdjustmentIndex, LPCWSTR lpszAdjustmentQuantityDifference);
char* inqb_adjustinventory_getadjustmentquantitydifference(void* lpObj, int adjustmentindex);
int inqb_adjustinventory_setadjustmentquantitydifference(void* lpObj, int adjustmentindex, const char* lpszAdjustmentQuantityDifference);
QString GetAdjustmentQuantityDifference(int iAdjustmentIndex);
int SetAdjustmentQuantityDifference(int iAdjustmentIndex, QString qsAdjustmentQuantityDifference);
Default Value
""
Remarks
Line item property: The change in quantity for this adjustment.
After a successful Add or Get this property will contain either a positive or negative number that shows the change in quantity for this inventory item.
The AdjustmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AdjustmentCount property.
This property is not available at design time.
Data Type
String
AdjustmentValueDifference Property (AdjustInventory Class)
Line item property: The change in total value for this adjustment.
Syntax
ANSI (Cross Platform) char* GetAdjustmentValueDifference(int iAdjustmentIndex);
int SetAdjustmentValueDifference(int iAdjustmentIndex, const char* lpszAdjustmentValueDifference); Unicode (Windows) LPWSTR GetAdjustmentValueDifference(INT iAdjustmentIndex);
INT SetAdjustmentValueDifference(INT iAdjustmentIndex, LPCWSTR lpszAdjustmentValueDifference);
char* inqb_adjustinventory_getadjustmentvaluedifference(void* lpObj, int adjustmentindex);
int inqb_adjustinventory_setadjustmentvaluedifference(void* lpObj, int adjustmentindex, const char* lpszAdjustmentValueDifference);
QString GetAdjustmentValueDifference(int iAdjustmentIndex);
int SetAdjustmentValueDifference(int iAdjustmentIndex, QString qsAdjustmentValueDifference);
Default Value
""
Remarks
Line item property: The change in total value for this adjustment.
After a successful Add or Get, this read-only property will contain either a positive or negative number that shows a change in the total value of the entire stock of this inventory item.
The AdjustmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AdjustmentCount property.
This property is not available at design time.
Data Type
String
ClassId Property (AdjustInventory Class)
Reference to the class of the Inventory Adjustment.
Syntax
ANSI (Cross Platform) char* GetClassId();
int SetClassId(const char* lpszClassId); Unicode (Windows) LPWSTR GetClassId();
INT SetClassId(LPCWSTR lpszClassId);
char* inqb_adjustinventory_getclassid(void* lpObj);
int inqb_adjustinventory_setclassid(void* lpObj, const char* lpszClassId);
QString GetClassId();
int SetClassId(QString qsClassId);
Default Value
""
Remarks
A reference to the class of this InventoryAdjustment. Used if class tracking is being done with the QuickBooks company.
Id/Name Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.
Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.
Setting the value of this property will set the corresponding Name property to an empty string.
Data Type
String
ClassName Property (AdjustInventory Class)
Reference to the class of the Inventory Adjustment.
Syntax
ANSI (Cross Platform) char* GetClassName();
int SetClassName(const char* lpszClassName); Unicode (Windows) LPWSTR GetClassName();
INT SetClassName(LPCWSTR lpszClassName);
char* inqb_adjustinventory_getclassname(void* lpObj);
int inqb_adjustinventory_setclassname(void* lpObj, const char* lpszClassName);
QString GetClassName();
int SetClassName(QString qsClassName);
Default Value
""
Remarks
A reference to the class of this InventoryAdjustment. Used if class tracking is being done with the QuickBooks company.
Id/Name Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.
Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.
Setting the value of this property will set the corresponding Name property to an empty string.
Data Type
String
CustomerId Property (AdjustInventory Class)
A reference to the customer or customer job.
Syntax
ANSI (Cross Platform) char* GetCustomerId();
int SetCustomerId(const char* lpszCustomerId); Unicode (Windows) LPWSTR GetCustomerId();
INT SetCustomerId(LPCWSTR lpszCustomerId);
char* inqb_adjustinventory_getcustomerid(void* lpObj);
int inqb_adjustinventory_setcustomerid(void* lpObj, const char* lpszCustomerId);
QString GetCustomerId();
int SetCustomerId(QString qsCustomerId);
Default Value
""
Remarks
The Customer property indicates the Customer who has purchased goods or services from the company.
Id/Name Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.
Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.
Setting the value of this property will set the corresponding Name property to an empty string.
Either CustomerId or CustomerName is required.
Data Type
String
CustomerName Property (AdjustInventory Class)
A reference to the customer or customer job.
Syntax
ANSI (Cross Platform) char* GetCustomerName();
int SetCustomerName(const char* lpszCustomerName); Unicode (Windows) LPWSTR GetCustomerName();
INT SetCustomerName(LPCWSTR lpszCustomerName);
char* inqb_adjustinventory_getcustomername(void* lpObj);
int inqb_adjustinventory_setcustomername(void* lpObj, const char* lpszCustomerName);
QString GetCustomerName();
int SetCustomerName(QString qsCustomerName);
Default Value
""
Remarks
The Customer property indicates the Customer who has purchased goods or services from the company.
Name/Id Reference Properties
This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.
Setting the value of this property will set the corresponding Id property to an empty string.
Either CustomerId or CustomerName is required.
Data Type
String
Memo Property (AdjustInventory Class)
Memo to appear on internal reports only.
Syntax
ANSI (Cross Platform) char* GetMemo();
int SetMemo(const char* lpszMemo); Unicode (Windows) LPWSTR GetMemo();
INT SetMemo(LPCWSTR lpszMemo);
char* inqb_adjustinventory_getmemo(void* lpObj);
int inqb_adjustinventory_setmemo(void* lpObj, const char* lpszMemo);
QString GetMemo();
int SetMemo(QString qsMemo);
Default Value
""
Remarks
A memo to appear on internal reports. Will not appear to customers, vendors, etc.
Data Type
String
QBConnectionString Property (AdjustInventory Class)
An aggregate consisting of various QuickBooks connection properties.
Syntax
ANSI (Cross Platform) char* GetQBConnectionString();
int SetQBConnectionString(const char* lpszQBConnectionString); Unicode (Windows) LPWSTR GetQBConnectionString();
INT SetQBConnectionString(LPCWSTR lpszQBConnectionString);
char* inqb_adjustinventory_getqbconnectionstring(void* lpObj);
int inqb_adjustinventory_setqbconnectionstring(void* lpObj, const char* lpszQBConnectionString);
QString GetQBConnectionString();
int SetQBConnectionString(QString qsQBConnectionString);
Default Value
""
Remarks
QBConnectionString allows the user to customize the application's interaction with QuickBooks.
The connection properties should be formatted in a sequence as follows:
propertyname = "propertyvalue" propertyname = "propertyvalue" ...
The order is irrelevant, and the whitespace around the equal sign is optional.
The following properties are currently supported:
ApplicationName | The name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access. |
CompanyFile | The name of the company file to open. If QuickBooks is not currently open with a company
file, QuickBooks will be automatically opened in the background with the file specified.
Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the
application UI, only that company file may be used.
This setting is not applicable when communicating with QB Connector. |
URL | The URL for the Remote Connector, e.g., 'http://localhost:2080'. If the URL is specified, the class will not communicate directly with QuickBooks, and will instead send a request to the specified web address. QuickBooks and the Remote Connector should be installed at the remote location, and if the connector is listening on the specified port, it will communicate the class's request to QuickBooks, and return the response. |
User | A username for the Remote Connector connection (if required on the Connector side) |
Password | A password for the Remote Connector connection (if required on the Connector side) |
Timeout | A timeout, in seconds, for the Remote Connector connection. If the Connector does not finish and respond within the chosen length of time, the class will generate an exception instead of hanging. |
DelayAfterClose | A delay, in milliseconds, to be applied after each time a connection to QuickBooks is closed. If QuickBooks is generating internal errors (in particular with automatic login) setting this delay to a positive value may solve the problem. |
FirewallHost | Contains the name or IP address of firewall. If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting. |
FirewallPassword | Contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. |
FirewallPort | Contains the TCP port for the firewall FirewallHost. Note this is set automatically when FirewallType is set to a valid value. |
FirewallType | Determines the type of firewall to connect through. Supported values are: 0 - no firewall (default), 1 - Tunneling proxy, 2 - SOCKS4 proxy, and 3 - SOCKS5 proxy. For the Tunneling proxy (1), the FirewallPort defaults to 80. For SOCKS4 (2) and SOCKS5 (3) the FirewallPort defaults to 1080. |
FirewallUser | Contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. |
ProxyAuthorization | Supported values are 0 - Basic authorization, 1 - Digest authentication, 3 - No authentication, and 4 - NTLM authentication. |
ProxyPassword | Contains a password if authentication is to be used for the proxy. |
ProxyPort | Contains the TCP port for a ProxyServer; (default 80). |
ProxySSL | Determines when to use SSL for the connection to the proxy. The applicable values are 0 - Automatic (SSL for https URLs, non-SSL for http URLs), 1 - The connection is always SSL-enabled, 2 - SSL is not enabled for any connection, and 3 - Connection is through a tunneling proxy. |
ProxyServer | If a ProxyServer is specified, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the ProxyServer is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer is set to the corresponding address. If the search is not successful, an error is returned. |
ProxyUser | Contains a user name, if authentication is to be used for the proxy. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the class binds. |
UseRDS | Whether to connect using Remote Data Sharing (RDS). If set to True, the class will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. The default value is False. |
Data Type
String
QBRequestAggregate Property (AdjustInventory Class)
The request aggregate.
Syntax
ANSI (Cross Platform) char* GetQBRequestAggregate();
int SetQBRequestAggregate(const char* lpszQBRequestAggregate); Unicode (Windows) LPWSTR GetQBRequestAggregate();
INT SetQBRequestAggregate(LPCWSTR lpszQBRequestAggregate);
char* inqb_adjustinventory_getqbrequestaggregate(void* lpObj);
int inqb_adjustinventory_setqbrequestaggregate(void* lpObj, const char* lpszQBRequestAggregate);
QString GetQBRequestAggregate();
int SetQBRequestAggregate(QString qsQBRequestAggregate);
Default Value
""
Remarks
This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer class to generate requests to be sent to QuickBooks Web Connector.
This property is not available at design time.
Data Type
String
QBRequestId Property (AdjustInventory Class)
The Id of the next message to be sent to QuickBooks.
Syntax
ANSI (Cross Platform) char* GetQBRequestId();
int SetQBRequestId(const char* lpszQBRequestId); Unicode (Windows) LPWSTR GetQBRequestId();
INT SetQBRequestId(LPCWSTR lpszQBRequestId);
char* inqb_adjustinventory_getqbrequestid(void* lpObj);
int inqb_adjustinventory_setqbrequestid(void* lpObj, const char* lpszQBRequestId);
QString GetQBRequestId();
int SetQBRequestId(QString qsQBRequestId);
Default Value
""
Remarks
The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.
This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.
QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.
To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.
Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.
This property is not available at design time.
Data Type
String
QBRequestMode Property (AdjustInventory Class)
Defines whether the request is made online or stored offline.
Syntax
ANSI (Cross Platform) int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode); Unicode (Windows) INT GetQBRequestMode();
INT SetQBRequestMode(INT iQBRequestMode);
Possible Values
RM_ONLINE(0),
RM_OFFLINE(1)
int inqb_adjustinventory_getqbrequestmode(void* lpObj);
int inqb_adjustinventory_setqbrequestmode(void* lpObj, int iQBRequestMode);
int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);
Default Value
0
Remarks
This property defines the behavior of the class when calling a method. Possible values are:
0 (rmOnline - default) | The request is made normally. |
1 (rmOffline) | The request is generated but not sent, and QBRequestAggregate is populated. |
For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.
Data Type
Integer
QBResponseAggregate Property (AdjustInventory Class)
The last QBXML response aggregate received from QuickBooks.
Syntax
ANSI (Cross Platform) char* GetQBResponseAggregate();
int SetQBResponseAggregate(const char* lpszQBResponseAggregate); Unicode (Windows) LPWSTR GetQBResponseAggregate();
INT SetQBResponseAggregate(LPCWSTR lpszQBResponseAggregate);
char* inqb_adjustinventory_getqbresponseaggregate(void* lpObj);
int inqb_adjustinventory_setqbresponseaggregate(void* lpObj, const char* lpszQBResponseAggregate);
QString GetQBResponseAggregate();
int SetQBResponseAggregate(QString qsQBResponseAggregate);
Default Value
""
Remarks
The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.
This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.
This property is not available at design time.
Data Type
String
QBXMLVersion Property (AdjustInventory Class)
The version of QBXML used in the outgoing message.
Syntax
ANSI (Cross Platform) char* GetQBXMLVersion();
int SetQBXMLVersion(const char* lpszQBXMLVersion); Unicode (Windows) LPWSTR GetQBXMLVersion();
INT SetQBXMLVersion(LPCWSTR lpszQBXMLVersion);
char* inqb_adjustinventory_getqbxmlversion(void* lpObj);
int inqb_adjustinventory_setqbxmlversion(void* lpObj, const char* lpszQBXMLVersion);
QString GetQBXMLVersion();
int SetQBXMLVersion(QString qsQBXMLVersion);
Default Value
"3.0"
Remarks
The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.
With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:
QuickBooks 2002 | 1.0, 1.1 |
QuickBooks 2003 | 2.0 |
QuickBooks 2004 | 3.0 |
QuickBooks 2005 | 4.0, 4.1 |
QuickBooks 2006 | 5.0 |
QuickBooks 2007 | 6.0 |
QuickBooks 2008 | 7.0 |
QuickBooks 2009 | 8.0 |
QuickBooks 2010 | 9.0 |
QuickBooks 2011 | 10.0 |
QuickBooks 2012 | 11.0 |
QuickBooks 2013 | 12.0 |
QuickBooks 2014 | 13.0 |
QuickBooks 2015 | 14.0 |
QuickBooks 2016 | 15.0 |
QuickBooks Canadian 2003 | CA2.0 |
QuickBooks Canadian 2004 to 2007 | CA3.0 |
QuickBooks UK 2003 | UK2.0 |
QuickBooks UK 2004 to 2007 | UK3.0 |
QuickBooks Australian 2003 | OZ2.0 |
QuickBooks Australian 2004 to 2007 | AU3.0 |
This property is not available at design time.
Data Type
String
RefId Property (AdjustInventory Class)
An alphanumerical identifier generated by the server.
Syntax
ANSI (Cross Platform) char* GetRefId(); Unicode (Windows) LPWSTR GetRefId();
char* inqb_adjustinventory_getrefid(void* lpObj);
QString GetRefId();
Default Value
""
Remarks
An Id is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.
This property is read-only and not available at design time.
Data Type
String
RefNumber Property (AdjustInventory Class)
Reference number for the transaction.
Syntax
ANSI (Cross Platform) char* GetRefNumber();
int SetRefNumber(const char* lpszRefNumber); Unicode (Windows) LPWSTR GetRefNumber();
INT SetRefNumber(LPCWSTR lpszRefNumber);
char* inqb_adjustinventory_getrefnumber(void* lpObj);
int inqb_adjustinventory_setrefnumber(void* lpObj, const char* lpszRefNumber);
QString GetRefNumber();
int SetRefNumber(QString qsRefNumber);
Default Value
""
Remarks
This is the reference number assigned to a transaction. Depending on the type of transaction, it appears in the QuickBooks user interface as Bill Number, Invoice Number, etc.
Reference numbers are alphanumeric strings and are not limited to actually being numbers.
For some types of transactions, if RefNumber is not assigned, QuickBooks will automatically assign a unique one. Reference numbers should generally be unique, but are not guaranteed to be so. It is recommended that applications generating their own reference numbers take steps to ensure their uniqueness.
Data Type
String
TransactionDate Property (AdjustInventory Class)
Date of transaction.
Syntax
ANSI (Cross Platform) char* GetTransactionDate();
int SetTransactionDate(const char* lpszTransactionDate); Unicode (Windows) LPWSTR GetTransactionDate();
INT SetTransactionDate(LPCWSTR lpszTransactionDate);
char* inqb_adjustinventory_gettransactiondate(void* lpObj);
int inqb_adjustinventory_settransactiondate(void* lpObj, const char* lpszTransactionDate);
QString GetTransactionDate();
int SetTransactionDate(QString qsTransactionDate);
Default Value
""
Remarks
The date of the transaction.
The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.
When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.
This property is required in Accounts Payable (Bill and VendorCredit) transactions. In other kinds of transactions this property is optional.
Data Type
String
Add Method (AdjustInventory Class)
Adds the Inventory Adjustment into QuickBooks.
Syntax
ANSI (Cross Platform) int Add(); Unicode (Windows) INT Add();
int inqb_adjustinventory_add(void* lpObj);
int Add();
Remarks
Add is used to add an Inventory Adjustment transaction into to QuickBooks.
If QuickBooks is able to add the Inventory Adjustment, it will return a copy of the adjustment, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.
Please note that this class is adding an inventory adjustment transaction into QuickBooks. This is fundamentally different from modifying an inventory item. QuickBooks does not allow the direct manipulation of inventory item quantities or values, but rather it maintains a history of the transactions that modify the inventory items.
Furthermore, these transactions record only the difference in value or quantity that was added or removed. Current and previous quantities and values for inventory items are not recorded or returned. Only the difference is recorded. Please see the AdjustmentQuantityDifference and AdjustmentValueDifference properties for more information.
If QuickBooks is not able to add the Inventory Adjustment, the class will fails with an error.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Cancel Method (AdjustInventory Class)
Cancels (voids) the transaction.
Syntax
ANSI (Cross Platform) int Cancel(); Unicode (Windows) INT Cancel();
int inqb_adjustinventory_cancel(void* lpObj);
int Cancel();
Remarks
Cancel causes the transaction to be voided in QuickBooks. The amount of the transaction and all line item quantities are changed to zero, and the memo is changed to "VOID:". The transaction will not, however, be deleted.
The transaction canceled in QuickBooks is the one specified by RefId. If the value of RefId is known then Get should first be called to retrieve the transaction. Otherwise the ObjSearch class should be used to search for the desired transaction in the QuickBooks database.
As the QuickBooks response to Cancel does not include the updated transaction, the values of all properties are instead set to their defaults. To get a copy of the updated transaction, the value of RefId should first be stored, and then Get should be called.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CheckRequestStatus Method (AdjustInventory Class)
Checks whether or not the specified request was processed by QuickBooks.
Syntax
ANSI (Cross Platform) char* CheckRequestStatus(const char* lpszRequestId); Unicode (Windows) LPWSTR CheckRequestStatus(LPCWSTR lpszRequestId);
char* inqb_adjustinventory_checkrequeststatus(void* lpObj, const char* lpszRequestId);
QString CheckRequestStatus(const QString& qsRequestId);
Remarks
This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.
QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.
The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."
See QBRequestId for more information on error recovery.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
CloseQBConnection Method (AdjustInventory Class)
Closes a persistent connection to QuickBooks.
Syntax
ANSI (Cross Platform) int CloseQBConnection(); Unicode (Windows) INT CloseQBConnection();
int inqb_adjustinventory_closeqbconnection(void* lpObj);
int CloseQBConnection();
Remarks
Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the class will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.
In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.
Be sure to always invoke this method after calling OpenQBConnection.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (AdjustInventory Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* inqb_adjustinventory_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Delete Method (AdjustInventory Class)
Deletes the record from QuickBooks.
Syntax
ANSI (Cross Platform) int Delete(); Unicode (Windows) INT Delete();
int inqb_adjustinventory_delete(void* lpObj);
int Delete();
Remarks
Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.
The object deleted in QuickBooks is the one specified by RefId. This read-only property may be assigned either by calling Get or by assigning the value of QBResponseAggregate.
A typical example:
Customer.GetByName("John Smith") 'this will assign the RefId
Customer.Delete()
Deleting entity objects (Customer, Employee, and Vendor) requires that
QuickBooks be open in single-user mode. Transaction objects, however, may be deleted
while QuickBooks is in any mode.
Use this method with caution, as there is no way to recover deleted objects.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Get Method (AdjustInventory Class)
Gets a single record from QuickBooks.
Syntax
ANSI (Cross Platform) int Get(const char* lpszId); Unicode (Windows) INT Get(LPCWSTR lpszId);
int inqb_adjustinventory_get(void* lpObj, const char* lpszId);
int Get(const QString& qsId);
Remarks
Get may be used to retrieve a single Inventory Adjustment transaction from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the class will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.
Please note that this class is retrieving an inventory adjustment transaction from QuickBooks. This is fundamentally different from retrieving an inventory item. QuickBooks does not allow the direct manipulation of inventory item quantities or values, but rather it maintains a history of the transactions that modify the inventory items.
Therefore this Get operation takes the Id of a previous Inventory Adjustment Add, and returns all of the adjustments made in that transaction in the Adjustment line item properties. Any quantity or value differences for a particular inventory item will show up in the AdjustmentQuantityDifference and AdjustmentValueDifference properties.
You can not set the Id parameter to the Id for an inventory item. This will result in an error. You must use the Item or ObjSearch classs to retrieve inventory items.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetCustomField Method (AdjustInventory Class)
Gets a custom field value from QuickBooks.
Syntax
ANSI (Cross Platform) char* GetCustomField(const char* lpszFieldName); Unicode (Windows) LPWSTR GetCustomField(LPCWSTR lpszFieldName);
char* inqb_adjustinventory_getcustomfield(void* lpObj, const char* lpszFieldName);
QString GetCustomField(const QString& qsFieldName);
Remarks
This method will get the value of a custom field, which has been defined by the user from within the QuickBooks UI.
To read the values of custom fields, be sure to set QBXMLVersion to at least "2.0" when retrieving data from QuickBooks. Then, QuickBooks will return custom field information, and it will be accessible through this method.
You may also invoke Config to read the value of custom fields. However, to set the value of custom fields you must set QBXMLVersion to at least "3.0" and invoke SetCustomField.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ImportQBXML Method (AdjustInventory Class)
Imports a QBXML response aggregate.
Syntax
ANSI (Cross Platform) int ImportQBXML(const char* lpszXMLData); Unicode (Windows) INT ImportQBXML(LPCWSTR lpszXMLData);
int inqb_adjustinventory_importqbxml(void* lpObj, const char* lpszXMLData);
int ImportQBXML(const QString& qsXMLData);
Remarks
This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
OpenQBConnection Method (AdjustInventory Class)
Opens a persistent connection to QuickBooks.
Syntax
ANSI (Cross Platform) int OpenQBConnection(); Unicode (Windows) INT OpenQBConnection();
int inqb_adjustinventory_openqbconnection(void* lpObj);
int OpenQBConnection();
Remarks
Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.
The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the class communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.
After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.
Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (AdjustInventory Class)
Resets all properties to their defaults.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int inqb_adjustinventory_reset(void* lpObj);
int Reset();
Remarks
This method resets the values of all properties (and all special fields) to their defaults.
After calling this method, the class may be reused as if it were newly created.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetCustomField Method (AdjustInventory Class)
Sets a custom field value within QuickBooks.
Syntax
ANSI (Cross Platform) int SetCustomField(const char* lpszFieldName, const char* lpszFieldValue); Unicode (Windows) INT SetCustomField(LPCWSTR lpszFieldName, LPCWSTR lpszFieldValue);
int inqb_adjustinventory_setcustomfield(void* lpObj, const char* lpszFieldName, const char* lpszFieldValue);
int SetCustomField(const QString& qsFieldName, const QString& qsFieldValue);
Remarks
This method requires QuickBooks 2004 or above, with QBXMLVersion set to at least "3.0".
This method will immediately set the value of a QuickBooks custom field, which has been defined by the user from within the QuickBooks UI. Before calling this method, the preceding operation must retrieve the object from QuickBooks, using Get, ObjSearch, etc. Then, you may use SetCustomField to set custom field values (the fields will be modified or added, as appropriate).
Note that invoking this method will create a connection to QuickBooks if one is not already in place.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (AdjustInventory Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(AdjustInventoryErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } AdjustInventoryErrorEventParams;
Unicode (Windows) virtual INT FireError(AdjustInventoryErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } AdjustInventoryErrorEventParams;
#define EID_ADJUSTINVENTORY_ERROR 1 virtual INT INQB_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class AdjustInventoryErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(AdjustInventoryErrorEventParams *e);
// Or, subclass AdjustInventory and override this emitter function. virtual int FireError(AdjustInventoryErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
SSLServerAuthentication Event (AdjustInventory Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(AdjustInventorySSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } AdjustInventorySSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(AdjustInventorySSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } AdjustInventorySSLServerAuthenticationEventParams;
#define EID_ADJUSTINVENTORY_SSLSERVERAUTHENTICATION 2 virtual INT INQB_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class AdjustInventorySSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(AdjustInventorySSLServerAuthenticationEventParams *e);
// Or, subclass AdjustInventory and override this emitter function. virtual int FireSSLServerAuthentication(AdjustInventorySSLServerAuthenticationEventParams *e) {...}
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (AdjustInventory Class)
Shows the progress of the secure connection.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(AdjustInventorySSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } AdjustInventorySSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(AdjustInventorySSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } AdjustInventorySSLStatusEventParams;
#define EID_ADJUSTINVENTORY_SSLSTATUS 3 virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);
class AdjustInventorySSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(AdjustInventorySSLStatusEventParams *e);
// Or, subclass AdjustInventory and override this emitter function. virtual int FireSSLStatus(AdjustInventorySSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Status Event (AdjustInventory Class)
Shows the progress of the QuickBooks connection.
Syntax
ANSI (Cross Platform) virtual int FireStatus(AdjustInventoryStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } AdjustInventoryStatusEventParams;
Unicode (Windows) virtual INT FireStatus(AdjustInventoryStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } AdjustInventoryStatusEventParams;
#define EID_ADJUSTINVENTORY_STATUS 4 virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);
class AdjustInventoryStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Status(AdjustInventoryStatusEventParams *e);
// Or, subclass AdjustInventory and override this emitter function. virtual int FireStatus(AdjustInventoryStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Warning Event (AdjustInventory Class)
Fired when a warning occurs.
Syntax
ANSI (Cross Platform) virtual int FireWarning(AdjustInventoryWarningEventParams *e);
typedef struct {
int Code;
const char *Description; int reserved; } AdjustInventoryWarningEventParams;
Unicode (Windows) virtual INT FireWarning(AdjustInventoryWarningEventParams *e);
typedef struct {
INT Code;
LPCWSTR Description; INT reserved; } AdjustInventoryWarningEventParams;
#define EID_ADJUSTINVENTORY_WARNING 5 virtual INT INQB_CALL FireWarning(INT &iCode, LPSTR &lpszDescription);
class AdjustInventoryWarningEventParams { public: int Code(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Warning(AdjustInventoryWarningEventParams *e);
// Or, subclass AdjustInventory and override this emitter function. virtual int FireWarning(AdjustInventoryWarningEventParams *e) {...}
Remarks
The Warning event is fired when the class has produced, or will produce, possibly unexpected results.
Warnings may be generated by QuickBooks or the class. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.
510* | Object added successfully, but cannot now be read. |
520* | Insufficient permissions to get all data. |
801 | Unable to update field (name). |
802 | Unable to parse name. |
Warning 801 will be thrown if the user attempts to Update properties
that cannot be updated. For example, the following code will cause this warning
to be fired:
Customer1.GetByName("Joe Smith")
Customer1.Email = "joe@abc.com" 'ok
Customer1.CreditLimit = "200.00" 'Not used in Update operations!
Customer1.Update()
Only the email address will be updated, and the credit limit will be unchanged.
Each property description for entity objects lists whether or not it is used
in Update operations.
Config Settings (AdjustInventory Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.AdjustInventory Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Adjustments[i].NewQuantity: Used to set the AdjustmentNewQuantity at index i as a string.Used when a fractional or string-based quantity is necessary. For example, "1.5" lbs. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Adjustments[i].QuantityDifference: Used to set the AdjustmentQuantityDifference at index i as a string.Used when a fractional or string-based quantity is necessary. For example, "1.5" lbs. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AppendAfter: Appends an XML tag after the specified QBXML element.Write-only; Appends the specified text after the specified QBXML element (whether the QBXML element is present). This may be useful to extend the functionality of the component beyond what is provided. Example: Control1.Config("AppendAfter:ListID=<WeirdNewField>abc</WeirdNewField>") | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AuthFlags:
Connection Flags (use for QuickBooks Simple Start).Since 2006, QuickBooks has allowed AuthFlags to be set before connecting to QuickBooks. By
default, the class can connect to Pro, Premier, and Enterprise editions of QuickBooks. However, because QuickBooks
Simple Start contains only a subset of the functionality that other desktop versions provide, Intuit does
not allow COM connection to Simple Start unless these AuthFlags explicitly indicate you wish to support it.
A list of allowable AuthFlags is provided below.
To specify support for multiple editions, OR together the values for each edition. NOTE: If the version of QuickBooks being used does not support AuthFlags, the contents of this config will be ignored. However, if QuickBooks does support this feature, setting "AuthFlags=1" (Support for Simple Start only) on a machine running QuickBooks 2013 Pro will result in an error message indicating that the Request Processor cannot be found. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EditSequence: An identifier for this copy of the object.Indicates the state of an object when doing an Update. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EnforceMaxLength: Indicates whether to enforce max lengths for QB Fields.If you change this setting to False, the class will no longer check (or error) when the length of a property exceeds the maximum length specified in the QuickBooks SDK. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GetHighestVersion: Highest QBXMLVersion supported by the installed instance of QuickBooks.If QuickBooks is installed on the system, this setting will retrieve the highest QBXMLVersion that may be used for sending transactions to QuickBooks. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GetRequestProcessorDLLVersion: Returns the version of the QB Request Processor that is installed on your system. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GetSupportedVersions: Returns a list of QBXMLVersions that are supported by QuickBooks.If QuickBooks is installed on the system, this setting will retrieve a list of all supported QBXMLVersions that may be used for sending transactions to QuickBooks. While GetHighestVersion config returns only the highest QBXMLVersion supported, this config returns ALL supported QBXMLVersions. The list is delimited with '\n' (linefeed) characters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IsReadOnly: This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.The default value is false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PersonalDataPref:
Whether the connecting application will require access to personal data such as SSN or credit card information.This setting allows you to let the user know immediately whether your application requires access to personal data or not.
A list of available values is provided below.
The default value is pdpOptional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QBConnectionMode:
The mode of connection to QuickBooks.Specifies whether the integrated application logs in using single-user or multi-user mode.
The following values are permitted:
About Single-User and Multi-User Modes If the connection to QuickBooks is made in single-user mode, QuickBooks will give exclusive access to the connecting application. It will lock out all other integrated applications; if QuickBooks and the company file are not already open in single-user mode by the QuickBooks user, the user will be locked out as well. If the connection is made in multi-user mode, QuickBooks will allow all other integrated applications access. QuickBooks end users on other machines will also be allowed to access the file. However, if the application (rather than the end user) starts QuickBooks automatically, end users on the same machine will still be locked out. If cmDontCare is specified, an appropriate connection mode will be chosen automatically. If a company file is open in either single-user or multi-user mode, the integrated application will accept that connection mode. If no company file is open, QuickBooks will login automatically in multi-user mode. About Integrated and Automatic Login Note that your application's login to QuickBooks might be either automatic or interactive. Interactive login is used when QuickBooks is already open. Access will be shared between the integrated application and the QuickBooks end user, and if multi-user mode is specified, other applications and users will have access as well. When a connection is made, QuickBooks will show a dialog window to the user, and ask the user if he/she wants to permit the connection. Automatic login is used when QuickBooks is not already open. QuickBooks will be opened in the background, and will run until your application has finished its connection with QuickBooks. The QuickBooks user interface will not be displayed, and end-users on the same machine will be locked out. End-users on other machines, however, will be allowed access if multi-user mode is specified. By default integrated applications do not have permission to login automatically. The first time an application interacts with QuickBooks, it must do so interactively, with QuickBooks and the company file open. The QuickBooks end user may then grant automatic login permission through Edit Preferences - Integrated Applications in the QuickBooks user interface. Click on the name of the application and then "Properties", and you may allow the application to login automatically. For automatic login the CompanyFile must be specified. CompanyFile, ApplicationName, and other properties relating to the QuickBooks connection may be edited through QBConnectionString. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QBFileStatus:
The status of the company file as it pertains to accepting connections.This setting may be queried before attempting to connect to QuickBooks to determine the current company file status. When
queried the class will attempt to determine whether a subsequent connection using the provided QBConnectionString
value would succeed. Possible return values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QBOpenCompanyFile:
The file currently open in QuickBooks.The name of the file currently open in QuickBooks, specified completely with
the path. This field is read-only.
A query is submitted to QuickBooks when the value of this property is read. The empty string will be returned if no file is open, if QuickBooks is open in an access mode incompatible with QBConnectionMode, or if an error occurs. If the value of this property is nonempty, the class may interact exclusively with the open file. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SendRawXML: Sends specified XML to quickbooks without modification.Available for write only. Immediately sends the specified XML over the current or default QuickBooks connection (as specified elsewhere), and returns the QBXML response. Syntax: Control1.Config("SendRawXML=<?xml version="1.0" ?>...") | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLAcceptServerCert:
The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).
The Base-64 encoded certificate being used by the Remote Connector (you may get this
certificate from the Remote Connector by going to the Security tab, and clicking Export.)
This is only necessary if using a self-signed certificate, or any other certificate that has not been signed by a Certificate Authority (CA) trusted by the system. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLAcceptServerCertFile:
The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
If your public key certificate is stored in a file, you may set this configuration setting
to the full path of the certificate, and it will be immediately read from disk and stored in
SSLAcceptServerCert. Equivalent to setting SSLAcceptServerCert to file contents.
Reading the value of this setting will return an empty string. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StopOnError: Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. If StopOnError is True (default), QuickBooks will stop processing when an error occurs. Requests that have already been processed will not be rolled back. An error is returned for the operation that caused the error condition. If StopOnError is False, QuickBooks will continue processing the remaining requests if an error occurs. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TimeCreated: The time the object was created.This config setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TimeModified: The time the object was created.This config setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UnattendedModePref:
Whether connecting while QuickBooks is closed is required or optional for the user.This setting allows you to let the user know immediately whether your application
requires the ability to access QuickBooks while QuickBooks is closed.
A list of available values is provided below.
The default value is umpOptional. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UpdateAdjustInventory:
Updates the inventory adjustment in QuickBooks.This config will immediately build and send an update request for the inventory adjustment to QuickBooks. The inventory adjustment will have its information updated based on the various property values.
If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks. QBXMLVersion must be set to "9.0" or greater to update an inventory adjustment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WarningCodes: A comma-separated list of QuickBooks warning codes that should not result in an exception.By default, the class will throw an exception when a status code with severity "Warn" is returned in a QuickBooks response. Set this field to a comma-separated list of status codes that should not throw an exception if returned. Note that the QuickBooks response code is not necessarily the same as the exception code from the resulting exception. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section. |
Trappable Errors (AdjustInventory Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ErrorsThe following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.
AdjustInventory Errors
101 String too long. | |
103 Invalid date format (YYYY-MM-DD is standard). | |
104 Invalid value for enumerated field. | |
105 Invalid integer. | |
106 Invalid dollar amount. | |
107 Invalid boolean value (must be 'true' or 'false'). | |
108 Invalid number. | |
111 Invalid special characters in string. | |
112 Invalid special field syntax. | |
181 Could not load certificate file. | |
201 Required field unspecified. | |
211 Unsupported field specified. | |
301 Array line count must be nonnegative. | |
302 Array index out of bounds. | |
303 Invalid field index. | |
401 Field not accessible as a special field. | |
402 Write access attempted of readonly field. | |
403 Read access attempted of writeonly field. | |
421 The object cannot be modified. | |
511 The QBRequestId has been previously used. Please generate a new one. | |
601 Could not access QuickBooks. | |
602 Could not open specified file. | |
603 The version of QuickBooks currently being used is not supported. | |
604 QuickBooks has not been installed properly. | |
605 The specified file was of an incorrect version. | |
606 Could not start QuickBooks. | |
607 QuickBooks is open in a mode different than the one requested. | |
608 QuickBooks cannot currently be accessed. | |
609 An application name must be specified. | |
610 A file name must be specified if one is not currently open in QuickBooks. | |
611 Access denied. | |
612 QuickBooks is busy and cannot open your application in the mode requested. | |
699 The connection to QuickBooks has failed for an unknown reason. | |
702 The object requested does not exist in QuickBooks. | |
751 Unsupported QBXML version. | |
752 The QBXMLVersion chosen is insufficient to execute the request. | |
801 A QuickBooks internal error has occurred. | |
802 QuickBooks is not available due to a system-related problem. | |
803 The Id specified is invalid. | |
804 Invalid object name. | |
805 The name already exists in QuickBooks. | |
807 An object could not be found in QuickBooks. | |
808 A reference did not refer to an object that exists in QuickBooks. | |
809 The object is currently in use by the QuickBooks end user. | |
810 The object may not be added. | |
811 The object may not be updated because it is obsolete. | |
812 The address is invalid. | |
813 Permission to perform this operation is not granted. | |
814 The request has not been processed. | |
815 Time creation mismatch. | |
816 The feature is turned off or not enabled. | |
817 Permission level configured is insufficient for access. | |
818 The item specified was of an unknown type. | |
819 The object may not be changed. | |
820 An internal QuickBooks error has occurred. | |
821 An attempt was made to use a connection that was not properly initiated. | |
822 An attempt was made to use a connection that is invalid or was previously closed. | |
823 Not enough memory. | |
824 Unable to lock the necessary information to allow this application access to the company file. Try again later. | |
850 An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit. | |
851 The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system. | |
861 Server error on WebExport (details follow). | |
862 The WebExport is impossible: an HTTP context was not found. | |
871 You may not set the value of QBConnectionTicket. This value is readonly. | |
880 Interrupted by the user. | |
881 An error has occurred connecting to a remote machine. | |
899 An unknown QuickBooks error has occurred. The message contains more details. | |
901 XML Parser Error. Should not occur under normal circumstances. |