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 Balance Sheet Report
AI-generatedSummary
Retrieve a Balance Sheet report from a specified Xero organization for a given date and with various optional filters and formatting preferences.
Inputs
- Organization Name or ID (required) — Select the Xero organization from which to fetch the report; can be chosen from a list or specified via an expression.
- Date — The date for which to generate the balance sheet, returning the report for the end of that date's month.
- Format Report in Simple Format — Choose to simplify the complex Xero report structure into flat arrays of line items.
- Payments Only — Limit the report to cash transactions only, suitable for Cash Basis Accounting.
- Periods — Number of comparative periods to include, between 1 and 11.
- Standard Layout — Indicate whether to apply only the standard Xero report layout, disabling custom layouts.
- Timeframe — Specify the period size to compare: Month, Quarter, or Year.
- Tracking Option ID 1 — Filter the balance sheet by a first tracking category option if provided.
- Tracking Option ID 2 — Optionally filter the balance sheet by a second tracking category option.
Output shape
a structured report object representing the balance sheet data as returned by Xero's API, optionally formatted into simple line item arrays
The balance sheet corresponds to the end of the specified date's month, includes optional multiple periods comparison (up to 11), and can be filtered by tracking categories. Formatting simplifies the output when requested. Errors or empty data depend on API response and provided parameters.