Deposits
Create, update, delete, and query QuickBooks Deposits. 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, 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. | |
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 | 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 | 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. | ||
ItemCount | Integer | True |
The count of line items. | ||
ItemAggregate | String | False | 5000 |
An aggregate of the line item data which can be used for adding a deposit and its line item data. | |
CurrencyName | String | False | 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. | ||
CustomFields | String | False |
Custom fields returned from QuickBooks and formatted into XML. | ||
TimeModified | Datetime | True |
When the deposit was last modified. | ||
TimeCreated | Datetime | True |
When the deposit was created. | ||
Payee | String | False | 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 |
Item* | String |
All line-item-specific columns may be used in insertions. |