QuickBooks Integrator 2020 Delphi Edition

Questions / Feedback?

VendorCredit Component

Properties   Methods   Events   Configuration Settings   Errors  

A VendorCredit indicates that the QuickBooks company is owed money by a VENDOR . A VendorCredit is the opposite of a BILL .

Syntax

TiqbVendorCredit

Remarks

The VendorCredit component represents a credit received from a Vendor. When a credit is added, the amount of the credit is automatically entered into the Accounts Payable register.

Required Fields (Add): Vendor*, TransactionDate, Items or Expenses

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

Example

VendorCredit1.VendorName = "ACME Inc."            '*
VendorCredit1.TransactionDate = "1/17/03"
VendorCredit1.ItemCount = 1
VendorCredit1.ItemName(0) = "ACME Widget X"  '*
VendorCredit1.ItemAmount(0) = "299.95" 
VendorCredit1.ExpenseCount = 1
VendorCredit1.ExpenseAccountName(0) = "Shipping"       '*
VendorCredit1.ExpenseAmount(0) = "12.00"
VendorCredit1.Add()

'*: Item must already exist in QuickBooks.
The operation of the VendorCredit component is nearly identical to that of the Bill Component. The only difference is that VendorCredit lacks the DueDate and Terms properties of Bill.

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 property. 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. To add expense lines to the transaction, first set ExpenseCount. This will initialize the Expenses array. 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 properties may be set as well.

The VendorCredit 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 VendorCredits, respectively. The ObjSearch Component may be used to search for VendorCredits 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.

AmountAmount of transaction.
APAccountIdReference to the Accounts Payable account where money goes.
APAccountNameReference to the Accounts Payable account.
ExpensesCollection of line items indicating individual expenses.
IncludeLinkedTxnsIndicates whether to include linked transactions in the response.
LineItemsCollection of line items.
LinkedTxnsInformation used to reference a transaction that is linked to the existing transaction.
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 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 sales order 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.
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.
IsTaxIncludedDetermines if tax is included in the transaction amount.
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.
SalesTaxCodeIdThe type of sales tax that will be charged for this Purchase Order.
SalesTaxCodeNameThe type of sales tax that will be charged for this Purchase Order.
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.
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.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component 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 Delphi Edition - Version 20.0 [Build 7941]