QuickBooks Integrator 2020 .NET Edition

Questions / Feedback?

Check Component

Properties   Methods   Events   Configuration Settings   Errors  

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"

'*: 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.

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.
AddressAddress printed on the check.
AmountAmount of transaction.
ExpensesCollection of line items indicating individual expenses.
IsToBePrintedWhether this transaction is to be printed.
LineItemsCollection of line items.
MemoMemo to appear on internal reports only.
PayeeIdReference to payee of check.
PayeeNameReference to payee of check.
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 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 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.

AppendAfterAppends an XML tag after the specified QBXML element.
ApplyCheckToTxnAmountThe amount of the transaction to be paid by this check.
ApplyCheckToTxnIdIdentifies the transaction to be paid by this check.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
ExchangeRateIndicates the exchange rate for the transaction.
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.
Items[index].OverrideItemAccountIdAn account which will override the default account for the line item.
Items[index].OverrideItemAccountNameAn account which will override the default account 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 QuickBooks Gateway (aka Remote Connector).
SSLAcceptServerCertFileThe SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
Tax1TotalCanadian field used for Goods and Services Tax, or GST.
Tax2TotalCanadian field used for Provincial Sales Taxes, or PST.
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.
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) 2022 4D Payments Inc. - All rights reserved.
QuickBooks Integrator 2020 .NET Edition - Version 20.0 [Build 8076]