Actions35
- Account Actions
- Attachment Actions
- Bank Transaction Actions
- Bank Transfer Actions
- Contact Actions
- History and Note Actions
- Invoice Actions
- Manual Journal Actions
- Organisation Actions
- Report Actions
Report → Get Budget Summary Report
AI-generatedSummary
Retrieve the Budget Summary Report from a specified Xero organization, optionally customizing the report by date, comparison periods, timeframe, and output format.
Inputs
- Organization Name or ID (required) — Select the target Xero organization by name or ID to fetch the budget summary report for.
- Options — Configure optional parameters including report date (to specify the month end), number of periods to compare (1-11), period size as month, quarter, or year, and whether to output the report in a simplified flat array format.
Output shape
a JSON object representing the budget summary report data fetched from Xero's API, optionally transformed into a simplified flat structure if requested
If 'Format Report in Simple Format' is enabled, the complex Xero report structure is converted to flat arrays of line items; otherwise, the raw Xero report JSON is returned. Pagination is not applicable.