VendorCredits

Handles QuickBooks Vendor Credits, supporting creation, updates, deletion, and queries for managing vendor refunds or adjustments.

Table Specific Information

VendorCredits may be inserted, updated, or queried via the VendorCredits, VendorCreditExpenseItems, or VendorCreditLineItems tables. VendorCredits may be deleted by using the VendorCredits table.

This table has a Custom Fields column. See the Custom Fields page for more information.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for VendorCredits are Id, Date, TimeModified, VendorName, VendorId, AccountsPayableId, and AccountsPayableName. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:

SELECT * FROM VendorCredits WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a VendorCredit, specify a Vendor and at least one Expense or Line Item. The ItemAggregate and ExpenseAggregate columns may be used to specify an XML aggregate of Line Item or Expense Item data. The columns that may be used in these aggregates are defined in the VendorCreditLineItems and VendorCreditExpenseItems tables and it starts with Item and Expense. For example, the following will insert a new VendorCredit with two Line Items:

INSERT INTO VendorCredits (VendorName, ItemAggregate) 
VALUES ('A Cheung Limited', 
'<VendorCreditLineItems>
<Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row>
<Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row>
</VendorCreditLineItems>')

To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'

Columns


Name	Type	ReadOnly	References	ColumnSize	Description
ID [KEY]	String	True			The unique identifier (refId) of the vendor credit record.
VendorName	String	False		1000	The name of the vendor associated with this transaction. Either VendorName or VendorId must be specified when inserting.
VendorId	String	False	Vendors.ID	255	The unique identifier of the vendor associated with this transaction. Either VendorName or VendorId must be specified when inserting.
Date	Date	False			The date of the vendor credit transaction in the format YYYY-MM-DD. Overrides StartDate and EndDate pseudo columns when used in a WHERE clause.
TxnNumber	Integer	True			A unique transaction number assigned to the vendor credit, different from the Quickbooks generated ID.
ReferenceNumber	String	False		21	A reference number provided for the vendor credit transaction.
AccountsPayable	String	False		1000	The name of the accounts-payable account associated with this vendor credit.
AccountsPayableId	String	False	Accounts.ID	255	The unique identifier of the accounts-payable account associated with this vendor credit.
Amount	Decimal	True			The total amount of the vendor credit transaction.
Memo	String	False		5000	An optional note or memo for the vendor credit transaction.
IsTaxIncluded	Boolean	False			Indicates whether the transaction amount includes tax.
TaxCode	String	False		3	The name of the sales tax code applicable to this vendor credit.
TaxCodeId	String	False	SalesTaxCodes.ID	255	The unique identifier of the sales tax code applicable to this vendor credit.
ExchangeRate	String	False			The exchange rate applied to this transaction for converting foreign currency to the home currency.
ItemCount	Integer	True			The total number of line items included in this vendor credit.
ItemAggregate	String	False		5000	An XML aggregate containing data for all line items in this vendor credit transaction. Useful for bulk insertions or updates.
ExpenseItemCount	Integer	True			The total number of expense line items included in this vendor credit.
ExpenseItemAggregate	String	False		5000	An XML aggregate containing data for all expense items in this vendor credit transaction. Useful for bulk insertions or updates.
TransactionCount	Integer	True			The total number of transactions related to this vendor credit.
TransactionAggregate	String	True		5000	An XML aggregate containing details of all linked transactions associated with this vendor credit.
CustomFields	String	False			Custom fields returned from QuickBooks, formatted as XML for additional metadata.
TimeModified	Datetime	True			The date and time when this vendor credit record was last modified, formatted as YYYY-MM-DD HH:MM:SS.
TimeCreated	Datetime	True			The date and time when this vendor credit record was created, formatted as YYYY-MM-DD HH:MM:SS.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.