Xero + icon

Xero +

Consume Xero API

Report → Get Trial Balance Report

AI-generated

Summary

Retrieve a Trial Balance report from a specified Xero organization, optionally filtered by date, cash basis payments, and output format.

Inputs

  • Organization Name or ID (required) — Select the Xero organization by name or ID to retrieve the report from.
  • Date — Specify the date (ISO format) to get the Trial Balance at the end of that month.
  • Payments Only — Enable to retrieve cash transactions only, reflecting cash basis accounting.
  • Format Report in Simple Format — Enable to convert the complex Xero report structure into a simplified flat array of line items.

Output shape

a single JSON object representing the Trial Balance report, either in Xero's original nested structure or a simplified flat array format, depending on the 'Format Report' option.

The report corresponds to the organization's trial balance at the specified date or current date if none given. Enabling 'Payments Only' filters to cash transactions. If 'Format Report in Simple Format' is false or omitted, the report preserves Xero's native nested structure.

Examples

Example 1: Get Trial Balance for a specific organization at end of April 2024 with all data in complex structure

Set Organization Name or ID to desired tenant, Date to 2024-04-30, leave other options false or empty.

Example 2: Get Trial Balance for organization's current date with only cash payments and simplified report formatting

Set Organization Name or ID, enable 'Payments Only' and 'Format Report in Simple Format' options.

Links

Discussion