ADO.NET Provider for QuickBooks

Build 21.0.7867

DepositLineItems

Create, update, delete, and query QuickBooks Deposit Line Items. QBXMLVersion must be set to 7.0 or higher to update a deposit.

Table Specific Information

Deposits may be inserted, queried, or updated via the Deposits or DepositLineItems tables. Deposits may be deleted by using the Deposits 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 typically be used with only the equals or = comparison. The available columns for Deposits are Id, Date, TimeModified, DepositToAccount, and DepositToAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. For example:

SELECT * FROM DepositLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011'

Insert

To add a Deposit, specify the DepositToAccount field and at least one Line Item. All Line Items must have an ItemAccount specified.

All Line Item columns can be used for inserting multiple Line Items for a new Deposit transaction. For example, the following will insert a new Deposit with two Line Items:

INSERT INTO DepositLineItems#TEMP (DepositToAccount, ItemAccount, ItemAmount) VALUES ('Checking', 'Undeposited Funds', 12.25)
INSERT INTO DepositLineItems#TEMP (DepositToAccount, ItemAccount, ItemAmount) VALUES ('Checking', 'Savings', 155.35)
INSERT INTO DepositLineItems (DepositToAccount, ItemAccount, ItemAmount) SELECT DepositToAccount, ItemAccount, ItemAmount FROM DepositLineItems#TEMP

Columns

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

The unique identifier in the format DepositId|ItemLineId.

DepositId String False

Deposits.ID

255

The deposit identifier. Set this value when inserting values to an existing deposit, or leave it blank to add a new deposit.

TxnNumber Integer True

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

Date Date False

The 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.

CashBackAccount String False

Accounts.FullName

1000

Account reference to the bank or credit card company.

CashBackAccountId String False

Accounts.ID

255

Account reference to the bank or credit card company.

CashBackAmount Decimal False

Cash-back amount.

CashBackId String True 255

Id of the cash back transaction.

CashBackMemo String False 5000

Additional info for the cash back transaction.

DepositToAccount String False

Accounts.FullName

1000

Account to deposit funds to.

DepositToAccountId String False

Accounts.ID

255

Account to deposit funds to.

Memo String False 5000

Memo to appear on internal reports only.

TotalDeposit Double True

The total of the deposit.

CustomFields String False

Custom fields returned from QuickBooks and formatted into XML.

ItemLineId String True 255

The line item identifier.

ItemAccount String False

Accounts.FullName

1000

A reference to the account funds are being deposited to.

ItemAccountId String False

Accounts.ID

255

A reference to the account funds are being deposited to.

ItemAmount Decimal False

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

ItemCheckNumber String False 11

The check number for this deposit line item.

ItemClass String False

Class.FullName

1000

Specifies the class of the deposit line item.

ItemClassId String False

Class.ID

255

Specifies the class of the deposit line item.

ItemEntityName String False 209

An entity name for this deposit line item.

ItemEntityId String False 255

An entity Id for this deposit line item.

ItemMemo String False 5000

Memo for this deposit line item.

ItemPaymentMethod String False

PaymentMethods.Name

31

The payment method (funding source) for this deposit line item. For example: cash, check, or Master Card.

ItemPaymentMethodId String False

PaymentMethods.ID

255

The payment method Id for this deposit line item

ItemPaymentId String False 255

The payment transaction Id for this deposit line item. A TxnID returned from a request can be used to refer to the transaction in subsequent requests. For example ReceivePayments.Id.

ItemPaymentLineId String False 255

The payment transaction line id for this deposit line item.

ItemRefId String True 255

Identification number of the transaction associated with this deposit line.

ItemTxnType String True 100

Type of the transaction associated with this deposit line.

CurrencyName String False

Currency.Name

64

The name of the currency for this deposit. A minimum QBXML Version of 8.0 is required for this feature.

CurrencyId String False

Currency.ID

255

The unique Id of the currency for this deposit. A minimum QBXML Version of 8.0 is required for this feature.

ExchangeRate Double False

The market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the home currency.

TimeModified Datetime True

When the deposit was last modified.

TimeCreated Datetime True

When the deposit was created.

Payee String False

Vendors.Name

1000

The name of the payee for the Check.

PayeeId String False

Vendors.ID

255

The Id of the payee for the Check.

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
ItemPriceLevel String

Item price level name. QuickBooks will not return the price level.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7867