Find budget summary reports
find_budget_summary_reportsGenerates budget reports similar to the budget report functionality that is available within the QuickBooks UI. (From the main QB menubar select Reports->Budgets & Forecasts.) Note: the graphing functionality, forecasts, and memorized reports that available through the UI aren’t supported by the SDK. Notice that if you simply use the default instead of specifying the Fiscal Year, the report_period defaults to “year to date.” You can’t change the default to “This Fiscal Year.”
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": {
"budget_summary_report_type": "<budget_summary_report_type>",
"fiscal_year": "<fiscal_year>"
},
"name": "find_budget_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`. | |
| fiscal_year | Yes | Specify the fiscal year of the budget to be queried. | |
| 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.) | |
| budget_criterion | No | What this budget covers. | |
| report_date_macro | No | The time period covered by this report. Choose at most one of: `report_period`, or `report_date_macro`. | |
| report_class_filter | No | Allows you to query for a specified class. Classes can be used to separate transactions into meaningful categories. | |
| summarize_budget_rows_by | No | How you want rows to be labeled in the report. For example, if you set the value to sbrbAccount, the report’s row labels might be “Checking,” “Savings,” and so on. | |
| budget_summary_report_type | Yes | The type of budget report being queried. | |
| summarize_budget_columns_by | No | `summarize_budget_columns_by` determines which data the report calculates and how the columns will be labeled across the top of the report. |
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). |