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.


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	A reference to the account to which this expense is be charged.
ExpenseAccountName	A reference to the account to which this expense is be charged.
ExpenseAmount	The total amount of this expense line.
ExpenseBillableStatus	The billing status of this expense line.
ExpenseClassId	A reference to the class of this expense.
ExpenseClassName	A reference to the class of this expense.
ExpenseCustomerId	The customer associated with this expense line.
ExpenseCustomerName	The customer associated with this expense line.
ExpenseLineId	Identification number of the expense line, used for Updates.
ExpenseMemo	A memo for this expense line, which will appear to the QuickBooks user only.
ExpenseTaxCodeId	Line item property: Sales tax information for this item.
ExpenseTaxCodeName	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.
ItemLineId	Identification number of the transaction line, used for Updates.
ItemAggregate	Contains an XML aggregate of the line item.
ItemName	Line item property: Reference to the kind of item.
ItemId	Line item property: Reference to the kind of item.
ItemDescription	Line item property: Description of item.
ItemQuantity	Line item property: Quantity of item or item group.
ItemUnitOfMeasure	Unit of measure describing the Quantity .
ItemCost	Line item property: Unit cost for item.
ItemAmount	Line item property: the total amount of this item.
ItemCustomerName	Line item property: A reference to customer for whom the item was ordered.
ItemCustomerId	Line item property: A reference to customer for whom the item was ordered.
ItemClassName	Line item property: Reference to the class of the item.
ItemClassId	Line item property: Reference to the class of the item.
ItemTaxCodeName	Line item property: Sales tax information for this item.
ItemTaxCodeId	Line item property: Sales tax information for this item.
ItemBillableStatus	Line item property: Billing status of this item.
ItemOverrideAccountName	An account which will override the default account for the line item.
ItemOverrideAccountId	An account which will override the default account for the line item.
ItemGroupId	Reference to a group of line items.
ItemGroupName	Reference to a group of line items.
LinkedTxnCount	The number of records in the LinkedTxn arrays.
LinkedTxnAmount	The amount of the linked transaction.
LinkedTxnDate	The date of the linked transaction.
LinkedTxnLinkType	Indicates the nature of the link between the transactions.
LinkedTxnRefNumber	This is the reference number assigned to the linked transaction.
LinkedTxnId	This property can be used by another component to reference the original transaction which is linked to the current response.
LinkedTxnType	This property indicates which type of linked transaction has been returned.
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 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 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.


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.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.


IsTaxIncluded	Determines if tax is included in the transaction amount.
SalesTaxCodeName	The type of sales tax that will be charged for this Purchase Order.
SalesTaxCodeId	The type of sales tax that will be charged for this Purchase Order.
SendRawXML	Sends specified XML to quickbooks without modification.
AppendAfter	Appends an XML tag after the specified QBXML element.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.
EditSequence	An identifier for this copy of the object.
ExpenseLineAggregate[index]	Contains the XML aggregate of the expense line item.
Items[index].OverrideItemAccountName	An account which will override the default account for the line item.
Items[index].OverrideItemAccountId	An account which will override the default account for the line item.
StopOnError	Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.
SSLAcceptServerCert	The SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector.
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields.
AuthFlags	Connection Flags (use for QuickBooks Simple Start).
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of QuickBooks.
GetSupportedVersions	Returns a list of QBXMLVersions that are supported by QuickBooks.
GetRequestProcessorDLLVersion	Returns the version of the QB Request Processor that is installed on your system.
IsReadOnly	This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
UnattendedModePref	Whether connecting while QuickBooks is closed is required or optional for the user.
PersonalDataPref	Whether the connecting application will require access to personal data such as SSN or credit card information.
QBOpenCompanyFile	The file currently open in QuickBooks.
QBConnectionMode	The mode of connection to QuickBooks.
QBFileStatus	The status of the company file as it pertains to accepting connections.
WarningCodes	A comma-separated list of QuickBooks warning codes that should not result in an exception.
Tax1Total	Canadian field used for Goods and Services Tax, or GST.
Tax2Total	Canadian field used for Provincial Sales Taxes, or PST.
ExchangeRate	Indicates the exchange rate for the transaction.
CodePage	The system code page used for Unicode to Multibyte translations.