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
InQBItemReceipt
InQBItemReceiptSwift
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.
- amount | Amount of transaction. |
- APAccountId | Reference to the Accounts Payable account where money goes. |
- APAccountName | Reference to the Accounts Payable account. |
- expenseCount | The number of records in the Expense arrays. |
- expenseAccountId:(int)expenseIndex | A reference to the account to which this expense is be charged. |
- expenseAccountName:(int)expenseIndex | A reference to the account to which this expense is be charged. |
- expenseAmount:(int)expenseIndex | The total amount of this expense line. |
- expenseBillableStatus:(int)expenseIndex | The billing status of this expense line. |
- expenseClassId:(int)expenseIndex | A reference to the class of this expense. |
- expenseClassName:(int)expenseIndex | A reference to the class of this expense. |
- expenseCustomerId:(int)expenseIndex | The customer associated with this expense line. |
- expenseCustomerName:(int)expenseIndex | The customer associated with this expense line. |
- expenseLineId:(int)expenseIndex | Identification number of the expense line, used for Updates. |
- expenseMemo:(int)expenseIndex | A memo for this expense line, which will appear to the QuickBooks user only. |
- expenseTaxCodeId:(int)expenseIndex | Line item property: Sales tax information for this item. |
- expenseTaxCodeName:(int)expenseIndex | Line item property: Sales tax information for this item. |
- includeLinkedTxns | Indicates whether to include linked transactions in the response. |
- itemCount | The number of records in the Item arrays. |
- itemAggregate:(int)itemIndex | Contains an XML aggregate of the line item. |
- itemAmount:(int)itemIndex | Line item property: the total amount of this item. |
- itemBillableStatus:(int)itemIndex | Line item property: Billing status of this item. |
- itemClassId:(int)itemIndex | Line item property: Reference to the class of the item. |
- itemClassName:(int)itemIndex | Line item property: Reference to the class of the item. |
- itemCost:(int)itemIndex | Line item property: Unit cost for item. |
- itemCustomerId:(int)itemIndex | Line item property: A reference to customer for whom the item was ordered. |
- itemCustomerName:(int)itemIndex | Line item property: A reference to customer for whom the item was ordered. |
- itemDescription:(int)itemIndex | Line item property: Description of item. |
- itemGroupId:(int)itemIndex | Reference to a group of line items. |
- itemGroupName:(int)itemIndex | Reference to a group of line items. |
- itemId:(int)itemIndex | Line item property: Reference to the kind of item. |
- itemName:(int)itemIndex | Line item property: Reference to the kind of item. |
- itemLineId:(int)itemIndex | Identification number of the transaction line, used for Updates. |
- itemOverrideAccountId:(int)itemIndex | An account which will override the default account for the line item. |
- itemOverrideAccountName:(int)itemIndex | An account which will override the default account for the line item. |
- itemQuantity:(int)itemIndex | Line item property: Quantity of item or item group. |
- itemTaxCodeId:(int)itemIndex | Line item property: Sales tax information for this item. |
- itemTaxCodeName:(int)itemIndex | Line item property: Sales tax information for this item. |
- itemUnitOfMeasure:(int)itemIndex | Unit of measure describing the Quantity . |
- linkedTxnCount | The number of records in the LinkedTxn arrays. |
- linkedTxnAmount:(int)linkedTxnIndex | The amount of the linked transaction. |
- linkedTxnDate:(int)linkedTxnIndex | The date of the linked transaction. |
- linkedTxnLinkType:(int)linkedTxnIndex | Indicates the nature of the link between the transactions. |
- linkedTxnRefNumber:(int)linkedTxnIndex | This is the reference number assigned to the linked transaction. |
- linkedTxnId:(int)linkedTxnIndex | This property can be used by another class to reference the original transaction which is linked to the current response. |
- linkedTxnType:(int)linkedTxnIndex | This property indicates which type of linked transaction has been returned. |
- linkToTxnId | The LinkToTxnId property allows you to link to an entire transaction, pulling in all of its line items. |
- 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. |
- vendorId | Reference to the vendor for this transaction. |
- vendorName | Reference 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.
- add | Adds the record 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. |
- update | Updates 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.
- onError | Information about errors during data delivery. |
- onSSLServerAuthentication | Fired after the server presents its certificate to the client. |
- onSSLStatus | Shows the progress of the secure connection. |
- onStatus | Shows the progress of the QuickBooks connection. |
- onWarning | Fired 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.
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. |
ExpenseLineAggregate[index] | Contains the XML aggregate of the expense line item. |
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. |
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. |
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 Remote Connector. |
SSLAcceptServerCertFile | The SSL certificate file being used by the 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. |
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. |
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. |