--- title: "List all deposits" method: GET path: "/quickbooks-desktop/deposits" --- # List all deposits `GET /quickbooks-desktop/deposits` Returns a list of deposits. Use the `cursor` parameter to paginate through the results. ## Query parameters - `ids` string[] — Filter for specific deposits by their QuickBooks-assigned unique identifier(s). **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request. **NOTE**: If any of the values you specify in this parameter are not found, the request will return an error. - `limit` integer — The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results. - `cursor` string — The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. - `updatedAfter` string — Filter for deposits updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone. - `updatedBefore` string — Filter for deposits updated on or before this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone. - `transactionDateFrom` string, date — Filter for deposits whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD). **NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - `transactionDateTo` string, date — Filter for deposits whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD). **NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`). - `entityIds` string[] — Filter for deposits associated with these entities (customers, vendors, employees, etc.). These are the entities referenced on the deposit's manual lines. - `accountIds` string[] — Filter for deposits associated with these accounts. - `currencyIds` string[] — Filter for deposits in these currencies. - `includeLineItems` boolean — Whether to include line items in the response. Defaults to `true`. ## Headers - `Conductor-End-User-Id` string, required — The ID of the End-User to receive this request. ## Response `200` Returns a list of deposits. - object - `objectType` 'list', required — The type of object. This value is always `"list"`. - `url` string, required — The endpoint URL where this list can be accessed. - `data` QbdDeposit[], required — The array of deposits. - `id` string, required — The unique identifier assigned by QuickBooks to this deposit. This ID is unique across all transaction types. - `objectType` 'qbd_deposit', required — The type of object. This value is always `"qbd_deposit"`. - `createdAt` string, required — The date and time when this deposit was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer. - `updatedAt` string, required — The date and time when this deposit was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer. - `revisionNumber` string, required — The current QuickBooks-assigned revision number of this deposit object, which changes each time the object is modified. When updating this object, you must provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error. - `transactionDate` string, date, required — The date of this deposit, in ISO 8601 format (YYYY-MM-DD). - `depositToAccount` object, nullable, required — The account where the funds for this deposit have been deposited. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `memo` string, nullable, required — A memo or note for this deposit. - `totalAmount` string, nullable, required — The total monetary amount deposited into this deposit's destination account, represented as a decimal string. - `currency` object, nullable, required — The deposit's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `exchangeRate` number, nullable, required — The market exchange rate between this deposit's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency). - `totalAmountInHomeCurrency` string, nullable, required — This deposit's total monetary amount converted to the home currency of the QuickBooks company file, represented as a decimal string. - `cashBack` QbdDepositCashBackLine, required - `id` string, required — The unique identifier assigned by QuickBooks to this deposit cash-back line. This ID is unique across all transaction line types. - `objectType` 'qbd_deposit_cash_back_line', required — The type of object. This value is always `"qbd_deposit_cash_back_line"`. - `account` object, required — The account where this deposit cash-back line's cash-back amount is recorded, such as Petty Cash. This amount reduces the total credited to the deposit's destination account. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `memo` string, nullable, required — A memo or note for this deposit cash-back line. - `amount` string, nullable, required — The cash-back amount taken out of the deposit and recorded to this deposit cash-back line's account, represented as a decimal string. - `externalId` string, nullable, required — A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation. - `lines` QbdDepositLine[], required — The deposit's deposit lines, each representing either an existing payment selected for deposit or a manual transfer from another account into the deposit account. - `transactionType` 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment' | 'unknown', nullable, required — The type of transaction for this deposit line. - `paymentTransactionId` string, nullable, required — For payment-based deposit lines, the ID of the source payment included in this deposit line. For manual deposit lines, this is null. - `id` string, required — The unique identifier assigned by QuickBooks to this deposit line. This ID is unique across all transaction line types. - `objectType` 'qbd_deposit_line', required — The type of object. This value is always `"qbd_deposit_line"`. - `paymentTransactionLineId` string, nullable, required — For payment-based deposit lines, the line ID of the specific source payment line included in this deposit line. For manual deposit lines, this is null. - `entity` object, nullable, required — The customer, vendor, employee, or person on QuickBooks's "Other Names" list associated with this deposit line. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `account` object, nullable, required — The account associated with this deposit line. For manual deposit lines, this is the account the funds were transferred from into the deposit's destination account. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `memo` string, nullable, required — A memo or note for this deposit line. - `checkNumber` string, nullable, required — The check number of a check received for this deposit line. - `paymentMethod` object, nullable, required — The deposit line's payment method (e.g., cash, check, credit card). - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `class` object, nullable, required — The deposit line's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `amount` string, nullable, required — The amount this deposit line contributes to the deposit's destination account, represented as a decimal string. - `customFields` QbdCustomField[], required — The custom fields for the deposit object, added as user-defined data extensions, not included in the standard QuickBooks object. - `ownerId` string, required — The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects. - `name` string, required — The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI. - `type` 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type', required — The data type of this custom field. - `value` string, required — The value of this custom field. The maximum length depends on the field's data type. - `nextCursor` string, nullable, required — The `nextCursor` is a pagination token returned in the response when you use the `limit` parameter in your request. To retrieve subsequent pages of results, include this token as the value of the `cursor` request parameter in your following API calls. **NOTE**: The `nextCursor` value remains constant throughout the pagination process for a specific list instance; continue to use the same `nextCursor` token in each request to fetch additional pages. - `remainingCount` number, nullable, required — The number of objects remaining to be fetched. - `hasMore` boolean, required — Indicates whether there are more objects to be fetched. --- [API](https://skmtc.net/conductor-is/apis/conductor-api.md) · [All operations](https://skmtc.net/conductor-is/apis/conductor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductor-is/conductor-api/revisions/0b07b3ebe160/schema)