Deposits

Manages QuickBooks Deposits, allowing users to create, update, delete, and query financial deposits. Requires QBXML Version 7.0 or higher for updates.

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, 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 Deposits 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. The ItemAggregate column may be used to specify an XML aggregate of Line Item data. The columns that may be used in these aggregates are defined in the DepositLineItems table and it starts with Item. For example, the following will insert a new Deposit with two Line Items:

INSERT INTO Deposits (DepositToAccount, ItemAggregate) 
VALUES ('Checking', '<DepositLineItems>
<Row><ItemAccount>Undeposited Funds</ItemAccount><ItemAmount>12.25</ItemAmount></Row>
<Row><ItemAccount>Savings</ItemAccount><ItemAmount>155.35</ItemAmount></Row>
</DepositLineItems>')

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		255	The unique identifier for the deposit transaction.
TxnNumber	Integer	True			A unique transaction number assigned to this deposit, distinct from the Quickbooks generated ID.
Date	Date	False			The date of the deposit transaction. If specified in the WHERE clause of a SELECT query, this overrides the pseudo columns StartDate and EndDate.
CashBackAccount	String	False		1000	The account reference for the bank or credit card company associated with cash back transactions.
CashBackAccountId	String	False	Accounts.ID	255	The unique ID of the account for the bank or credit card company handling cash back transactions.
CashBackAmount	Decimal	False			The amount of cash back received in this deposit transaction.
CashBackId	String	True		255	The unique identifier for the cash back transaction.
CashBackMemo	String	False		5000	Additional details or notes about the cash back transaction.
DepositToAccount	String	False		1000	The account where the deposit funds are credited.
DepositToAccountId	String	False	Accounts.ID	255	The unique ID of the account where the deposit funds are credited.
Memo	String	False		5000	A note or comment for internal use, appearing on reports related to this deposit.
TotalDeposit	Double	True			The total monetary value of the deposit, including all line items and cash back.
ItemCount	Integer	True			The number of line items included in this deposit.
ItemAggregate	String	False		5000	An XML aggregate of line item data that can be used to add or manage deposits and their associated line items.
CurrencyName	String	False		64	The name of the currency used for this deposit. Requires QBXML Version 8.0 or higher.
CurrencyId	String	False	Currency.ID	255	The unique identifier for the currency used in this deposit. Requires QBXML Version 8.0 or higher.
ExchangeRate	Double	False			The exchange rate at which the currency can be converted into the company's home currency.
CustomFields	String	False			Custom fields for the deposit, formatted as XML and returned by QuickBooks.
TimeModified	Datetime	True			The timestamp indicating when the deposit was last modified.
TimeCreated	Datetime	True			The timestamp indicating when the deposit was created.
Payee	String	False		1000	The name of the payee associated with this deposit transaction.
PayeeId	String	False	Vendors.ID	255	The unique identifier of the payee associated with this deposit transaction.

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.