AdjustInventory Component
Properties Methods Events Configuration Settings Errors
The AdjustInventory component is used to adjust your inventory.
Syntax
TiqbAdjustInventory
Remarks
The AdjustInventory component is used to adjust your current inventory levels within QuickBooks by sending an Inventory Adjustment transaction. This component 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 Component.
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
component.AccountName = "Inventory Asset" '* component.Memo = "Small warehouse fire." component.AdjustmentCount = 1 component.AdjustmentItemName(0) = "Hardware:Brass Hinges" '* component.AdjustmentItemNewQuantity(0) = "130" component.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 component supports a variety of other operations as well. The component's Get, Cancel, and Delete methods may be used to retrieve, cancel, and delete Inventory Adjustment transactions. The ObjSearch Component 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 component 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 component 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 component with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Status | Shows the progress of the QuickBooks connection. |
Warning | Fired when a warning occurs. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
Adjustments[i].QuantityDifference | Used to set the AdjustmentQuantityDifference at index i as a string. |
Adjustments[i].NewQuantity | Used to set the AdjustmentNewQuantity at index i as a string. |
SendRawXML | Sends specified XML to quickbooks without modification. |
AppendAfter | Appends an XML tag after the specified QBXML element. |
TimeCreated | The time the object was created. |
TimeModified | The time the object was created. |
EditSequence | An identifier for this copy of the object. |
StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
SSLAcceptServerCert | The SSL certificate being used by the Remote Connector. |
SSLAcceptServerCertFile | The SSL certificate file being used by the Remote Connector. |
EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
QBOpenCompanyFile | The file currently open in QuickBooks. |
QBConnectionMode | The mode of connection to QuickBooks. |
QBFileStatus | The status of the company file as it pertains to accepting connections. |
WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
CodePage | The system code page used for Unicode to Multibyte translations. |