Find transactions
find_transactionsTransactionQuery is a generic transaction query that provides functionality (e.g. filters) similar to the Advanced Find window in the QuickBooks UI. It allows you to search for transactions across different transaction types. In contrast to the other transaction-specific queries, the TransactionQuery only returns data common to all transactions, such as txn_id, type, dates, accountRef, and so on. This query does return condensed transactions.
Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3150 missing_element, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3264 merchant_services_subscription_required
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "find_transactions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| txn_id | No | `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| iterator | No | Page through every match: QuBe Sync asks QuickBooks for each page in turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by default, with pages of 100 records; send `iterator=true` with `max_returned` for another size. Off when you send `iterator=false` (every match in one answer) or `max_returned` alone (at most that many, in one answer). It pages a filtered query only: with `txn_id` every match comes back in one answer, so leave `iterator` out. | |
| meta_data | No | Use the `meta_data` attribute to control whether query responses include counts. Options are NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus objects). | |
| ref_number | No | `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| request_id | No | Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`. | |
| max_returned | No | Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `meta_data` query attribute.) The page size, with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap instead: at most this many records come back, in one answer, and QuickBooks doesn't say whether more matched. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| currency_filter | No | Filters by the specified currency. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| ref_number_filter | No | Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| include_ret_element | No | ||
| ref_number_range_filter | No | Filters by `ref_number` range. Numeric-only bounds are compared numerically; otherwise comparison is lexicographic. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_item_filter | No | Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_type_filter | No | Filters the transactions based on the transaction’s type. You can specify one or more transaction types in the filter. Notice that TimeTracking transactions aren’t supported. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_class_filter | No | Filters the transactions based on the ClassRef in the transaction or transaction line by using a specific `list_id`, or a `full_name`, or a `list_id_with_children`, or a `full_name_with_children`. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| ref_number_case_sensitive | No | Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_entity_filter | No | Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_account_filter | No | Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_date_range_filter | No | Filters the transactions based on the transaction’s date either by specifying a “from” and/or “to” date, or by using a `date_macro`. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_paid_status_filter | No | This filter allows you to search for “open” transactions, i.e. transactions with a remaining balance (for example, credits not fully applied or invoices not fully paid). Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_detail_level_filter | No | Allows you to specify the detail level of the query results. You can specify all, summary only (the default), or all except summary. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_posting_status_filter | No | Allows you to filter transactions based on posting status. Valid values are posting, non-posting, or either. The default is “either.” Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. | |
| transaction_modified_date_range_filter | No | Filters the transactions based on the transaction’s modified datetime, either by specifying a “from” and/or “to” date or by using a `date_macro`. Choose at most one of: `txn_id`, or the set (`currency_filter`, `max_returned`, `ref_number`, `ref_number_case_sensitive`, `ref_number_filter`, `ref_number_range_filter`, `transaction_account_filter`, `transaction_class_filter`, `transaction_date_range_filter`, `transaction_detail_level_filter`, `transaction_entity_filter`, `transaction_item_filter`, `transaction_modified_date_range_filter`, `transaction_paid_status_filter`, `transaction_posting_status_filter`, `transaction_type_filter`). Members of a set combine with each other, not with the other choices. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| query | Yes | The query parameters: the arguments you passed. | |
| method | Yes | ||
| headers | Yes | Send with the request. Resent unchanged when no 201 came back, it answers with the request already queued. | |
| webhook | Yes | JSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes). |