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

class inqb.ItemReceipt

Remarks

This functionality requires qbxml_version 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 link_to_txn_id 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 (vendor_name or vendor_id), and either line_items or link_to_txn_id.

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.
ap_account_id	Reference to the Accounts Payable account where money goes.
ap_account_name	Reference to the Accounts Payable account.
expense_count	The number of records in the Expense arrays.
expense_account_id	A reference to the account to which this expense is be charged.
expense_account_name	A reference to the account to which this expense is be charged.
expense_amount	The total amount of this expense line.
expense_billable_status	The billing status of this expense line.
expense_class_id	A reference to the class of this expense.
expense_class_name	A reference to the class of this expense.
expense_customer_id	The customer associated with this expense line.
expense_customer_name	The customer associated with this expense line.
expense_line_id	Identification number of the expense line, used for Updates.
expense_memo	A memo for this expense line, which will appear to the QuickBooks user only.
expense_tax_code_id	Line item property: Sales tax information for this item.
expense_tax_code_name	Line item property: Sales tax information for this item.
include_linked_txns	Indicates whether to include linked transactions in the response.
item_count	The number of records in the Item arrays.
item_aggregate	Contains an XML aggregate of the line item.
item_amount	Line item property: the total amount of this item.
item_billable_status	Line item property: Billing status of this item.
item_class_id	Line item property: Reference to the class of the item.
item_class_name	Line item property: Reference to the class of the item.
item_cost	Line item property: Unit cost for item.
item_customer_id	Line item property: A reference to customer for whom the item was ordered.
item_customer_name	Line item property: A reference to customer for whom the item was ordered.
item_description	Line item property: Description of item.
item_group_id	Reference to a group of line items.
item_group_name	Reference to a group of line items.
item_id	Line item property: Reference to the kind of item.
item_name	Line item property: Reference to the kind of item.
item_line_id	Identification number of the transaction line, used for Updates.
item_override_account_id	An account which will override the default account for the line item.
item_override_account_name	An account which will override the default account for the line item.
item_quantity	Line item property: Quantity of item or item group.
item_tax_code_id	Line item property: Sales tax information for this item.
item_tax_code_name	Line item property: Sales tax information for this item.
item_unit_of_measure	Unit of measure describing the Quantity .
linked_txn_count	The number of records in the LinkedTxn arrays.
linked_txn_amount	The amount of the linked transaction.
linked_txn_date	The date of the linked transaction.
linked_txn_link_type	Indicates the nature of the link between the transactions.
linked_txn_ref_number	This is the reference number assigned to the linked transaction.
linked_txn_id	This property can be used by another class to reference the original transaction which is linked to the current response.
linked_txn_type	This property indicates which type of linked transaction has been returned.
link_to_txn_id	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.
qb_connection_string	An aggregate consisting of various QuickBooks connection properties.
qb_request_aggregate	The request aggregate.
qb_request_id	The Id of the next message to be sent to QuickBooks.
qb_request_mode	Defines whether the request is made online or stored offline.
qb_response_aggregate	The last QBXML response aggregate received from QuickBooks.
qbxml_version	The version of QBXML used in the outgoing message.
ref_id	An alphanumerical identifier generated by the server.
ref_number	Reference number for the transaction.
transaction_date	Date of transaction.
vendor_id	Reference to the vendor for this transaction.
vendor_name	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.
check_request_status	Checks whether or not the specified request was processed by QuickBooks.
close_qb_connection	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.
get_custom_field	Gets a custom field value from QuickBooks.
import_qbxml	Imports a QBXML response aggregate.
open_qb_connection	Opens a persistent connection to QuickBooks.
reset	Resets all properties to their defaults.
set_custom_field	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.


on_error	Information about errors during data delivery.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.
on_status	Shows the progress of the QuickBooks connection.
on_warning	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.