A Check is used to record point-of-receipt payments.
A Check is used to pay Vendors or other entities whom the QuickBooks company owes money. The Check component corresponds to a standard check in QuickBooks, and allows the QuickBooks user to record the receipt of goods or services at the time they are paid for. The Check component does not correspond to QuickBooks payroll, sales tax, or bill payment checks, and should not be used for any of these purposes.
Required Fields (Add): Account*, Payee*, TransactionDate, Items or Expenses
Supported Methods: Add, Get (Id), Cancel, Delete
Check1.PayeeName = "ACME Inc." '* Check1.AccountName = "Checking" '* Check1.TransactionDate = "1/17/03" Check1.LineItems.Add(New StandardItem()) Check1.LineItems(0).ItemName = "ACME Widget X" '* Check1.LineItems(0).Amount = "299.95" Check1.Expenses.Add(New ExpenseLine()) Check1.Expenses(0).AccountName = Expenses '* Check1.Expenses(0).Amount = "12.00" Check1.Add() '*: Item must already exist in QuickBooks.
Payee refers to the entity from whom merchandise was purchased, typically but not always a Vendor. The Account is the account from which funds are being drawn; for example, "Checking" or "Corporate MasterCard". The Payee and Account must already be specified in QuickBooks. Amount is the total of the item lines and (if present) expense lines. It is computed automatically, and should never be set.
Item Lines: Item lines are used to track the purchase of goods or services. Line items may be added by first setting ItemCount. Then, for each line set the Item ID (or Name), Cost, Quantity, Description, Class, Customer, and Amount.
Note: For advanced users, the entire XML item structure may be set and retrieved through the Item's Aggregate field. However, it is up to the developer to ensure that this aggregate is formatted correctly.
Expense Lines: Expense lines are used to track portions of the total amount to expense accounts. Each expense will be tracked to the account specified in ExpenseAccount. The ExpenseAmount should also be specified for each expense; optionally, the ExpenseClass, ExpenseCustomer, and ExpenseMemo fields may be set as well.
The Check 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 Checks, respectively. The ObjSearch Component may be used to search for Checks in the QuickBooks database.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|AccountId||Reference to account from which funds are being drawn.|
|AccountName||Reference to account from which funds are being drawn.|
|Address||Address printed on the check.|
|Amount||Amount of transaction.|
|Expenses||Collection of line items indicating individual expenses.|
|IsToBePrinted||Whether this transaction is to be printed.|
|LineItems||Collection of line items.|
|Memo||Memo to appear on internal reports only.|
|PayeeId||Reference to payee of check.|
|PayeeName||Reference to payee of check.|
|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.|
The following is the full list of the methods of the component 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.|
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
|Error||Information about errors during data delivery.|
|SSLServerAuthentication||Fired after the server presents its certificate to the client.|
|SSLStatus||Shows the progress of the secure connection.|
|Status||Shows the progress of the QuickBooks connection.|
|Warning||Fired when a warning occurs.|
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
|AppendAfter||Appends an XML tag after the specified QBXML element.|
|ApplyCheckToTxnAmount||The amount of the transaction to be paid by this check.|
|ApplyCheckToTxnId||Identifies the transaction to be paid by this check.|
|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.|
|ExchangeRate||Indicates the exchange rate for the transaction.|
|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.|
|Items[index].OverrideItemAccountId||An account which will override the default account for the line item.|
|Items[index].OverrideItemAccountName||An account which will override the default account 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 QuickBooks Gateway (aka Remote Connector).|
|SSLAcceptServerCertFile||The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).|
|StopOnError||Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.|
|Tax1Total||Canadian field used for Goods and Services Tax, or GST.|
|Tax2Total||Canadian field used for Provincial Sales Taxes, or PST.|
|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.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|LicenseInfo||Information about the current license.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|