4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

AdjustInventory Component

Properties   Methods   Events   Configuration Settings   Errors  

The AdjustInventory component is used to adjust your inventory.

Syntax

DPayments.DAccountingSDK.Adjustinventory

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. Once you have added list of inventory adjustment transactions using the Adjustments collection, set the AccountName and you may 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 (ItemId or ItemName), plus an NewQuantity and/or NewValue.

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

Example

component.AccountName = "Inventory Asset"  '*
component.Memo = "Small warehouse fire."
component.Adjustments.Add(New Adjustment())
component.Adjustments(0).ItemName = "Hardware:Brass Hinges"  '*
component.Adjustments(0).NewQuantity(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.

AccountIdReference to account from which funds are being drawn.
AccountNameReference to account from which funds are being drawn.
AdjustmentsNumber of adjustments for this transaction.
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 component 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 component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the QuickBooks connection.
WarningFired 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].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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Accounting SDK 2020 .NET Edition - Version 20.0 [Build 7887]