Find general summary reports
find_general_summary_reportsThe General Summary Reports category is the largest category for summary reports. In addition to common customizations, the reports within this category can be customized by the number of columns that are returned and by period comparisons for the data in the report.
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
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"general_summary_report_type": "<general_summary_report_type>"
},
"name": "find_general_summary_reports"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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`. | |
| return_rows | No | Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status. | |
| report_basis | No | ||
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| report_period | No | If you omit both `to_report_date` and `from_report_date`, the report will cover the current fiscal year to date. Choose at most one of: `report_period`, or `report_date_macro`. | |
| display_report | No | Set `display_report` to true to display this report within the QuickBooks UI. (Default is false.) | |
| return_columns | No | Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status. | |
| report_calendar | No | Specifies the type of year that will be used for this report. | |
| report_date_macro | No | The time period covered by this report. Choose at most one of: `report_period`, or `report_date_macro`. | |
| include_subcolumns | No | The default value is false, which means that the report won’t include any subcolumn information. To include all available types of subcolumns for this report, set `include_subcolumns` to true. | |
| report_item_filter | No | Allows you to query for a specified item type (for example, discount, inventory, or non-inventory) or query for specific list elements. | |
| report_class_filter | No | Allows you to query for a specified class. Classes can be used to separate transactions into meaningful categories. | |
| report_entity_filter | No | Allows you to query for a specified name type (customer, employee, vendor, or other) or query for specific list elements. | |
| summarize_columns_by | No | `summarize_columns_by` determines which data the report calculates and how the columns will be labeled across the top of the report. | |
| report_account_filter | No | Allows you to query for a specified account type or for specific list elements. | |
| report_txn_type_filter | No | Allows you to report on specific transaction types (for example, charge, check, deposit, or estimate). | |
| report_detail_level_filter | No | The level of detail to include in the report. | |
| general_summary_report_type | Yes | The type of general summary report being queried. The report types listed below map almost directly to named reports in QuickBooks. | |
| report_posting_status_filter | No | Allows you to query for posting reports, non-posting reports, or reports that are either one. | |
| report_modified_date_range_macro | No | The time period covered by this report. Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`. | |
| report_modified_date_range_filter | No | Returns reports that were modified between these two dates (inclusive). Choose at most one of: `report_modified_date_range_filter`, or `report_modified_date_range_macro`. |
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). |