CData Python Connector for QuickBooks Online

Build 25.0.9454

VendorCreditLineItems

Captures line-level details of vendor credits, including items or expenses credited, amounts, and accounts to properly offset vendor balances.

Table Specific Information

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

Select

All filterable columns support the following operators:

  • =
  • !=
  • >=
  • <=
  • >
  • <
  • IN
  • LIKE
  • CONTAINS

The driver processes other filters client-side within the driver.

Insert

To add a VendorCredit, specify the Vendor, TotalAmt, and at least one Line Item. The following shows an example of inserting multiple VendorCredits, each with a single line. To insert a VendorCredit with multiple lines, see the example on the VendorCredits table. 

INSERT INTO VendorCreditLineItems#TEMP (VendorRef, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_CustomerRef, Line_AccountBasedExpenseLineDetail_AccountRef, TotalAmt) VALUES ('21', 0.01, 'AccountBasedExpenseLineDetail', '4', '41', 0.03)
INSERT INTO VendorCreditLineItems#TEMP (VendorRef, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_CustomerRef, Line_AccountBasedExpenseLineDetail_AccountRef, TotalAmt) VALUES ('21', 0.02, 'AccountBasedExpenseLineDetail', '4', '41', 0.03)
INSERT INTO VendorCreditLineItems (VendorRef, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_CustomerRef, Line_AccountBasedExpenseLineDetail_AccountRef, TotalAmt) SELECT VendorRef, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_CustomerRef, Line_AccountBasedExpenseLineDetail_AccountRef, TotalAmt FROM VendorCreditLineItems#TEMP

Columns

Name Type ReadOnly References Filterable Sortable Description
LineId [KEY] String True False True

The unique identifier (Id) of the individual line item on the vendor-credit transaction. This field is required to reference, update, or delete a specific line item.

VendorCreditId [KEY] String False

VendorCredits.Id

True False

The unique Id of the vendor-credit transaction that this line item belongs to. This Id forms the foreign-key relationship back to the VendorCredit object.

SyncToken String True False False

The version control token for this vendor-credit line item that is used to prevent conflicting updates. QuickBooks Online increments this sync token each time the line or parent vendor credit is modified, and only the latest sync token is accepted for edits.

MetaData_CreateTime Datetime True True True

The date and time stamp (Coordinated Universal Time) when QuickBooks Online created this vendor-credit line item record.

MetaData_LastUpdatedTime Datetime True True True

The date and time stamp (Coordinated Universal Time) when this vendor-credit line item record was last modified in QuickBooks Online.

DocNumber String False True True

The primary document number that is assigned to this vendor-credit transaction. If a number is not provided, QuickBooks Online automatically generates the next sequential document number based on the company's numbering settings.

TxnDate Date False True True

The transaction date of this vendor credit. This date determines when the vendor credit is posted in the general ledger. That date can match the creation date or be backdated for accounting purposes.

PrivateNote String False False False

An internal note about this vendor-credit transaction. These notes are organization-private, not shown on vendor-facing forms, and are intended for internal tracking.

DepartmentRef String False

Departments.Id

False False

The unique Id of the department or location that is linked to this vendor-credit transaction. This Id is used when location tracking is enabled in QuickBooks Online.

DepartmentRef_Name String True

Departments.Name

False False

The display name of the department or location that is linked to this vendor-credit transaction.

Line_Id String False False False

The unique Id of the line item within this vendor credit. This field is distinct from LineId and may be used in nested line detail structures.

Line_Description String False False False

The description of the goods, services, or adjustments recorded in this line item. This description can appear on printed or exported versions of the vendor credit.

Line_Amount Decimal False False False

The total monetary amount for this line item. This amount includes charges and allowances but excludes any applicable tax amounts.

Line_DetailType String False False False

The detail type of this line item that specifies what kind of entry it represents (for example, Account-based expense or Item-based expense).

Line_AccountBasedExpenseLineDetail_CustomerRef String False

Customers.Id

False False

The unique Id of the customer that is associated with this account-based expense line. This Id is used to track expenses by customer or project.

Line_AccountBasedExpenseLineDetail_CustomerRef_Name String True

Customers.DisplayName

False False

The display name of the customer that is associated with this account-based expense line.

Line_AccountBasedExpenseLineDetail_ClassRef String False

Class.Id

False False

The unique Id of the class that is assigned to this account-based expense line for class tracking.

Line_AccountBasedExpenseLineDetail_ClassRef_Name String True

Class.FullyQualifiedName

False False

The display name of the class that is assigned to this account-based expense line.

Line_AccountBasedExpenseLineDetail_AccountRef String False

Accounts.Id

False False

The unique Id of the account that is associated with this account-based expense line. The account must be a valid account in QuickBooks Online.

Line_AccountBasedExpenseLineDetail_AccountRef_Name String True

Accounts.Name

False False

The display name of the account that is associated with this account-based expense line.

Line_AccountBasedExpenseLineDetail_BillableStatus String False False False

The billable status of this account-based expense line. Valid values indicate whether the expense can be billed back to a customer (Billable), has already been billed (HasBeenBilled), or is not billable (NotBillable).

Line_AccountBasedExpenseLineDetail_TaxCodeRef String False

TaxCodes.Id

False False

The unique Id of the tax code that is applied to this account-based expense line.

Line_ItemBasedExpenseLineDetail_ItemRef String False

Items.Id

False False

The unique Id of the item that is associated with this item-based expense line.

Line_ItemBasedExpenseLineDetail_ItemRef_Name String True

Items.Name

False False

The display name of the item that is associated with this item-based expense line.

Line_ItemBasedExpenseLineDetail_ClassRef String False

Class.Id

False False

The unique Id of the class that is assigned to this item-based expense line for class tracking.

Line_ItemBasedExpenseLineDetail_ClassRef_Name String True

Class.FullyQualifiedName

False False

The display name of the class that is assigned to this item-based expense line.

Line_ItemBasedExpenseLineDetail_UnitPrice Decimal False False False

The per-unit price of the item that is recorded in this item-based expense line.

Line_ItemBasedExpenseLineDetail_Qty Double False False False

The number of units for the item in this item-based expense line. This value, multiplied by the unit price, contributes to the total line amount.

Line_ItemBasedExpenseLineDetail_TaxCodeRef String False

TaxCodes.Id

False False

The unique Id of the tax code that is applied to this item-based expense line.

Line_ItemBasedExpenseLineDetail_CustomerRef String False

Customers.Id

False False

The unique Id of the customer that is associated with this item-based expense line. This Id is used to allocate item costs to a customer or project.

Line_ItemBasedExpenseLineDetail_CustomerRef_Name String True

Customers.DisplayName

False False

The display name of the customer that is associated with this item-based expense line.

Line_ItemBasedExpenseLineDetail_BillableStatus String False False False

The billable status of this item-based expense line. Valid values indicate whether the expense can be billed back to a customer (Billable), has already been billed (HasBeenBilled), or is not billable (NotBillable).

VendorRef String False

Vendors.Id

True False

The unique Id of the vendor for this vendor-credit transaction.

VendorRef_Name String True

Vendors.DisplayName

False False

The display name of the vendor for this vendor-credit transaction.

APAccountRef String False

Accounts.Id

True True

The unique Id of the accounts-payable liability account to which this vendor credit is posted. If the company uses a single accounts-payable account, QuickBooks Online implies it automatically. When specified, the account must be a Liability account with a subtype of Payables.

APAccountRef_Name String True

Accounts.Name

False False

The display name of the accounts-payable liability account to which this vendor credit is posted. If the company uses a single accounts-payable account, QuickBooks Online implies it automatically. When specified, the account must be a Liability account with a subtype of Payables.

TotalAmt Decimal False True True

The total monetary amount of the vendor-credit transaction. This value is determined by summing the amounts of all included line items, charges, allowances, taxes, and discounts.

CurrencyRef String False False False

The unique Id of the currency in which this vendor-credit transaction is recorded when multicurrency is enabled.

CurrencyRef_Name String True False False

The display name of the currency in which this vendor-credit transaction is recorded when multicurrency is enabled.

ExchangeRate Decimal False False False

The currency exchange rate that QuickBooks Online applies to convert this vendor credit amount into the home currency. This field is valid only when multicurrency is enabled. In QuickBooks Online, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. This field is available in the UK, AU, and CA editions.

GlobalTaxCalculation String False False False

The method by which QuickBooks Online applies tax to this vendor-credit transaction. This field is valid in the UK, AU, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454