QuickBooks Integrator 2020 Node.js Edition

Questions / Feedback?

ItemReceipt Class

Properties   Methods   Events   Configuration Settings   Errors  

the ITEMRECEIPT class allows you to add and edit an item receipt transaction, which is a transaction entered in QuickBooks when a shipment is received from a vendor.

Syntax

inqb.itemreceipt()

Remarks

This functionality requires QBXMLVersion to be set to "4.0" or greater. If this property is not set, the class will fail with an error.

To access item receipts in the QuickBooks UI, select Lists->Chart of Accounts, and then select an Accounts Payable account. If you use PurchaseOrders to order from the vendor, you can link the item receipt to a purchase order using the LinkToTxnId property. This will retrieve the items against the purchase orders to automatically update (and eventually close) the purchase orders. This linking also saves you having to re-create line items as they are pulled in automatically from the purchase order. You can do this linking only in the item receipt Add, not in the Update.

Required Fields (Add): Vendor (VendorName or VendorId), and either LineItems or LinkToTxnId.

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

Example:

ItemReceipt1.QBXMLVersion = "4.0"
ItemReceipt1.VendorName = "Daigle Lighting"
ItemReceipt1.ItemCount = 1 
ItemReceipt1.ItemName(0) = "Hardware"
ItemReceipt1.ItemAmount(0) = "12.00";
ItemReceipt1.ItemQuantity(0) = "4";
ItemReceipt1.ItemCustomerName(0) = "Baker, Chris"
ItemReceipt1.Add()
The 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 ItemReceipts, respectively. The ObjSearch Class may be used to search for ItemReceipts 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.

AmountAmount of transaction.
APAccountIdReference to the Accounts Payable account where money goes.
APAccountNameReference to the Accounts Payable account.
ExpenseCountThe number of records in the Expense arrays.
ExpenseAccountIdA reference to the account to which this expense is be charged.
ExpenseAccountNameA reference to the account to which this expense is be charged.
ExpenseAmountThe total amount of this expense line.
ExpenseBillableStatusThe billing status of this expense line.
ExpenseClassIdA reference to the class of this expense.
ExpenseClassNameA reference to the class of this expense.
ExpenseCustomerIdThe customer associated with this expense line.
ExpenseCustomerNameThe customer associated with this expense line.
ExpenseLineIdIdentification number of the expense line, used for Updates.
ExpenseMemoA memo for this expense line, which will appear to the QuickBooks user only.
ExpenseTaxCodeIdLine item property: Sales tax information for this item.
ExpenseTaxCodeNameLine item property: Sales tax information for this item.
IncludeLinkedTxnsIndicates whether to include linked transactions in the response.
ItemCountThe number of records in the Item arrays.
ItemAggregateContains an XML aggregate of the line item.
ItemAmountLine item property: the total amount of this item.
ItemBillableStatusLine item property: Billing status of this item.
ItemClassIdLine item property: Reference to the class of the item.
ItemClassNameLine item property: Reference to the class of the item.
ItemCostLine item property: Unit cost for item.
ItemCustomerIdLine item property: A reference to customer for whom the item was ordered.
ItemCustomerNameLine item property: A reference to customer for whom the item was ordered.
ItemDescriptionLine item property: Description of item.
ItemGroupIdReference to a group of line items.
ItemGroupNameReference to a group of line items.
ItemIdLine item property: Reference to the kind of item.
ItemNameLine item property: Reference to the kind of item.
ItemLineIdIdentification number of the transaction line, used for Updates.
ItemOverrideAccountIdAn account which will override the default account for the line item.
ItemOverrideAccountNameAn account which will override the default account for the line item.
ItemQuantityLine item property: Quantity of item or item group.
ItemTaxCodeIdLine item property: Sales tax information for this item.
ItemTaxCodeNameLine item property: Sales tax information for this item.
ItemUnitOfMeasureUnit of measure describing the Quantity .
LinkedTxnCountThe number of records in the LinkedTxn arrays.
LinkedTxnAmountThe amount of the linked transaction.
LinkedTxnDateThe date of the linked transaction.
LinkedTxnLinkTypeIndicates the nature of the link between the transactions.
LinkedTxnRefNumberThis is the reference number assigned to the linked transaction.
LinkedTxnIdThis property can be used by another class to reference the original transaction which is linked to the current response.
LinkedTxnTypeThis property indicates which type of linked transaction has been returned.
LinkToTxnIdThe LinkToTxnId property allows you to link to an entire transaction, pulling in all of its line items.
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.
VendorIdReference to the vendor for this transaction.
VendorNameReference to the vendor for this 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 record 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.
UpdateUpdates the bill in 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.

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 class with short descriptions. Click on the links for further details.

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.
ExpenseLineAggregate[index]Contains the XML aggregate of the expense line item.
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.
ItemLineLinkToTxnId[index]A link to an existing PURCHASEORDER transaction.
ItemLineLinkToTxnLineId[index]A link to a specific line of an existing PURCHASEORDER transaction.
ItemLineLotNumber[index]The lot number for the line item.
ItemLineSerialNumber[index]The serial number for the line item.
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.
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 Node.js Edition - Version 20.0 [Build 7941]