CData Python Connector for QuickBooks

Build 24.0.8963

VendorCreditLineItems

Create, update, delete, and query QuickBooks Vendor Credit Line Items.

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 the VendorCredits table 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 VenderCreditLineItems 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. All Line Item columns can be used for inserting multiple Line Items for a new VendorCredit transaction. For example, the following will insert a new VendorCredit with two Line Items:

INSERT INTO VendorCreditLineItems#TEMP (VendorName, ItemName, ItemQuantity) VALUES ('A Cheung Limited', 'Repairs', 1)
INSERT INTO VendorCreditLineItems#TEMP (VendorName, ItemName, ItemQuantity) VALUES ('A Cheung Limited', 'Removal', 2)
INSERT INTO VendorCreditLineItems (VendorName, ItemName, ItemQuantity) SELECT VendorName, ItemName, ItemQuantity FROM VendorCreditLineItems#TEMP

Columns

Name Type ReadOnly References ColumnSize Description
ID [KEY] String True 255

The unique identifier in the format VendorCreditId|ItemLineId.

VendorCreditId String False

VendorCredits.ID

255

The Id of the VendorCredit transaction.

VendorName String False 1000

Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting.

VendorId String False

Vendors.ID

255

Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting.

Date Date False

Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value.

TxnNumber Integer True

The transaction number. An identifying number for the transaction, different from the QuickBooks-generated Id.

ReferenceNumber String False 21

Reference number for the transaction.

AccountsPayable String False 1000

Reference to the accounts-payable account.

AccountsPayableId String False

Accounts.ID

255

Reference to the accounts-payable account.

Amount Decimal True

Amount of the transaction.

Memo String False 5000

Memo for the transaction.

IsTaxIncluded Boolean False

Determines if tax is included in the transaction amount.

TaxCode String False 3

The type of sales tax that will be charged for this vendor credit.

TaxCodeId String False

SalesTaxCodes.ID

255

The type of sales tax that will be charged for this vendor credit.

ExchangeRate String False

Indicates the exchange rate for the transaction.

ItemLineId String True 255

The line item identifier.

ItemLineNumber String True 255

The line item number.

ItemAmount Decimal False

The total amount of this vendor credit line item. This should be a positive number.

ItemClass String False 1000

Specifies the class of the vendor credit line item.

ItemClassId String False

Class.ID

255

Specifies the class of the vendor credit line item.

ItemTaxCode String False 3

Sales tax information for this item (taxable or non-taxable).

ItemTaxCodeId String False

SalesTaxCodes.ID

255

Sales tax information for this item (taxable or non-taxable).

ItemName String False

The item name.

ItemId String False

Items.ID

255

The item Id.

ItemGroup String False 100

Item group name. Reference to a group of line items this item is part of.

ItemGroupId String False

Items.ID

255

Item group name. Reference to a group of line items this item is part of.

ItemDescription String False 5000

A description of the item.

ItemQuantity Double False

The quantity of the item or item group specified in this line.

ItemUnitOfMeasure String False 31

In a transaction line item, the name of the unit of measure is selected from within the item's available units. If the company file is enabled only for single unit of measure per item, this must be the base unit. Only available in QBXML Version 7.0 and above.

ItemCost Double False

The unit cost for an item.

ItemBillableStatus String False 13

Billing status of the item.

使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED

デフォルト値はEMPTYです。

ItemCustomer String False 1000

The name of the customer who ordered the item.

ItemCustomerId String False

Customers.ID

255

The Id of the customer who ordered the item.

ItemInventorySiteId String False

InventorySites.ID

31

The inventory site Id of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ItemInventorySiteName String False 255

The inventory site name of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ItemInventorySiteLocationId String False 31

The inventory site location Id of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ItemInventorySiteLocationName String False 255

The inventory site location name of this item. This requires QBXML version at least 10.0 and the Advanced Inventory add-on.

ExpirationDateForSerialLotNumber String True 1099

The expiration date for serial lot number of this item. It is supported from QB Desktop 2023 version 3 (USA & Canada) and SDK 16.0.

CustomFields String False

Custom fields returned from QuickBooks and formatted into XML.

EditSequence String True 16

An identifier for this copy of the object.

TimeModified Datetime True

When the vendor credit was last modified.

TimeCreated Datetime True

When the vendor credit was created.

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.

Name Type Description
ItemOverrideAccount String

The Account Name used to override the default Account for the Item. This is only available during inserts and updates.

ItemOverrideAccountId String

The Account Id used to override the default Account for the Item. This is only available during inserts and updates.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963