Search: 
Available in: QUICKBOOKS
VendorCredit Component [IBiz Integrator for QuickBooks - V4]

Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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

Online Edition: Leave out APAccount*. Add only expense lines (no item lines).

Example

   
VendorCredit1.VendorName = "ACME Inc."            '*
VendorCredit1.TransactionDate = "1/17/03"
VendorCredit1.ItemCount = 1
VendorCredit1.ItemName(0) = "ACME Widget X"  '*
VendorCredit1.ItemAmount(0) = 29995 'number of cents
VendorCredit1.ExpenseCount = 1
VendorCredit1.ExpenseAccountName(0) = "Shipping"       '*
VendorCredit1.ExpenseAmount(0) = 1200
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 Item* (ItemId or ItemName) or ItemGroup*, and optionally ItemCost, ItemQuantity, ItemDescription, ItemClass*;, ItemCustomer*, and/or ItemAmount.

Note: For advanced users, the entire XML item structure may be set and retrieved through the "ItemsAggregate" configuration setting. Setting this will override the Item properties and will remove restrictions on updating Item Groups. 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 complete descriptions.

APAccountId Reference to the Accounts Payable account where money goes.
APAccountName Reference to the Accounts Payable account.
Amount Amount of transaction.
ExpenseAccountId Expense line property: the account for this expense.
ExpenseAccountName Expense line property: the account for this expense.
ExpenseAmount Expense line property: amount of the expense.
ExpenseBillableStatus Expense line property: Billing status of this expense line.
ExpenseClassId Expense line property: class of the expense.
ExpenseClassName Expense line property: class of the expense.
ExpenseCount Expense line property: Number of expenses.
ExpenseCustomerId Expense line property: The customer for whom the expense was undertaken.
ExpenseCustomerName Expense line property: The customer for whom the expense was undertaken.
ExpenseMemo Expense line property: Memo for this line.
IncludeLinkedTxns Indicates whether to include linked transactions in the response.
ItemAmount Line item property: the total amount of this line.
ItemBillableStatus Line item property: Billing status of this item.
ItemClassId Line item property: Reference to the class of the item.
ItemClassName Line item property: Reference to the class of the item.
ItemCost Line item property: Unit cost for item.
ItemCount Number of line items.
ItemCustomerId Line item property: A reference to customer for whom the item was ordered.
ItemCustomerName Line item property: A reference to customer for whom the item was ordered.
ItemDescription Line item property: Description of item.
ItemGroupId Line item property: Reference to a group of line items.
ItemGroupName Line item property: Reference to a group of line items.
ItemId Line item property: Reference to the kind of item.
ItemName Line item property: Reference to the kind of item.
ItemQuantity Line item property: Quantity of item or item group.
LinkedTxnAmount Linked Transaction property: The amount of the transaction.
LinkedTxnCount Linked Transaction property: Number of linked transactions.
LinkedTxnDate Linked Transaction property: The date of the transaction.
LinkedTxnId Linked Transaction property: Reference to the kind of item.
LinkedTxnLinkType Linked Transaction property: Indicates the nature of the link between the transactions.
LinkedTxnRefNumber Linked Transaction property: Reference number for the linked transaction.
LinkedTxnType Linked Transaction property: The type of the transaction.
Memo Memo to appear on internal reports only.
QBAddRequestAggregate Request aggregate for an Add.
QBConnectionMode The mode of connection to QuickBooks.
QBConnectionString An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile The file currently open in QuickBooks.
QBRequestId The Id of the next message to be sent to QuickBooks.
QBResponseAggregate The last XML 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 complete descriptions.

AXMExport Exports the object.
AXMImport Imports the object.
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 component configuration setting.
Delete Deletes the record from QuickBooks.
Get Gets a single record from QuickBooks.
GetCustomField Gets a custom field value from QuickBooks.
OpenQBConnection Opens a persistent connection to QuickBooks.
Reset Resets all properties to their defaults.
SetCustomField Sets a custom field value within QuickBooks.
WebExport Exports the object to a web client.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Error Information about errors during data delivery.
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 complete descriptions.

AppendAfter Appends an xml tag after the specified QBXML element.
AuthFlags Connection Flags (use for QuickBooks Simple Start).
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
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.
GetHighestVersion Highest QBXMLVersion supported by the installed instance of Quickbooks.
IgnoreQBOEWarnings Ignores warnings returned from QuickBooks Online.
IncludeLinkedTxns Indicates to QuickBooks whether to return transactions linked to this request.
ItemsAggregate Allows the user to set the item xml directly.
SSLAcceptServerCert The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile The SSL certificate file being used by the Remote Connector
SendRawXML Sends specified XML to quickbooks without modification.
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.
{Expenses[index].BillableStatus} Whether the expense is billable to ExpenseCustomer.
{Items[index].Amount} The amount in dollars for the line item at the specified index.
{Items[index].BillableStatus} Whether the line is billable to ItemCustomer.
{Items[index].Cost} The cost in dollars for the line item at the specified index.
{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.
{Items[index].Quantity} The quantity for the line item at the specified index.
{Items[index].Rate} The rate in dollars for the line item at the specified index.

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.