QuickBooks Integrator 2020 iOS Edition

Questions / Feedback?

AdjustInventory Class

Properties   Methods   Events   Configuration Settings   Errors  

The AdjustInventory class is used to adjust your inventory.

Syntax

InQBAdjustInventory
InQBAdjustInventorySwift

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.

- accountIdReference to account from which funds are being drawn.
- accountNameReference to account from which funds are being drawn.
- adjustmentCountThe number of records in the Adjustment arrays.
- adjustmentItemId:(int)adjustmentIndexLine item property: Reference to the kind of item to be adjusted.
- adjustmentItemName:(int)adjustmentIndexLine item property: Reference to the kind of item to be adjusted.
- adjustmentLineId:(int)adjustmentIndexIdentification number of the transaction line, returned in the response.
- adjustmentNewQuantity:(int)adjustmentIndexLine item property: The new quantity for this adjustment.
- adjustmentNewValue:(int)adjustmentIndexLine item property: New value of this adjustment.
- adjustmentQuantityDifference:(int)adjustmentIndexLine item property: The change in quantity for this adjustment.
- adjustmentValueDifference:(int)adjustmentIndexLine item property: The change in total value for this adjustment.
- classIdReference to the class of the Inventory Adjustment.
- classNameReference to the class of the Inventory Adjustment.
- customerIdA reference to the customer or customer job.
- customerNameA reference to the customer or customer job.
- memoMemo to appear on internal reports only.
- QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
- QBRequestAggregateThe request aggregate.
- QBRequestIdThe Id of the next message to be sent to QuickBooks.
- QBRequestModeDefines whether the request is made online or stored offline.
- QBResponseAggregateThe last QBXML response aggregate received from QuickBooks.
- QBXMLVersionThe version of QBXML used in the outgoing message.
- refIdAn alphanumerical identifier generated by the server.
- refNumberReference number for the transaction.
- transactionDateDate 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.

- addAdds the Inventory Adjustment into QuickBooks.
- cancelCancels (voids) the transaction.
- checkRequestStatusChecks whether or not the specified request was processed by QuickBooks.
- closeQBConnectionCloses a persistent connection to QuickBooks.
- configSets or retrieves a configuration setting.
- deleteDeletes the record from QuickBooks.
- getGets a single record from QuickBooks.
- getCustomFieldGets a custom field value from QuickBooks.
- importQBXMLImports a QBXML response aggregate.
- openQBConnectionOpens a persistent connection to QuickBooks.
- resetResets all properties to their defaults.
- setCustomFieldSets 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.

- onErrorInformation about errors during data delivery.
- onSSLServerAuthenticationFired after the server presents its certificate to the client.
- onSSLStatusShows the progress of the secure connection.
- onStatusShows the progress of the QuickBooks connection.
- onWarningFired when a warning occurs.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

Adjustments[i].NewQuantityUsed to set the AdjustmentNewQuantity at index i as a string.
Adjustments[i].QuantityDifferenceUsed to set the AdjustmentQuantityDifference at index i as a string.
AppendAfterAppends an XML tag after the specified QBXML element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SendRawXMLSends specified XML to quickbooks without modification.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
UpdateAdjustInventoryUpdates the inventory adjustment in QuickBooks.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 iOS Edition - Version 20.0 [Build 7941]