Xero: Retrieves report for bank summary

← Accounting operations · Get started

Operation xero.getreportbanksummary

Provider route: GET /api.xro/2.0/Reports/BankSummary. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/xero with npm, or alter-sdk-xero with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { XeroIntegration } from "@alter-ai/xero";

async function execute(input: Parameters<XeroIntegration["accounting"]["getReportBankSummary"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new XeroIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.accounting.getReportBankSummary(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_xero import XeroIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = XeroIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.accounting.get_report_bank_summary(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.fromDate	string	Optional	Format: date
query.toDate	string	Optional	Format: date
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Retrieves report for balancesheet — response body

Referenced models: Retrieves report for balancesheet — response body

Schemas

Retrieves report for balancesheet — response body

Field	Type	Presence	Description and constraints
$	object	Root
Reports	array	Optional
Reports[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item

Referenced models: Retrieves report for balancesheet — response body — Reports item

Retrieves report for balancesheet — response body — Reports item

Field	Type	Presence	Description and constraints
$	JSON	Root
Fields	array	Optional
Fields[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Fields item
ReportDate	string	Optional	Date of report
ReportID	string	Optional	ID of the Report
ReportName	string	Optional	Name of the report
ReportTitle	string	Optional	Title of the report
ReportTitles	array	Optional	Report titles array (3 to 4 strings with the report name, orgnisation name and time frame of report)
ReportTitles[]	string	Each item
ReportType	string	Optional	The type of report (BalanceSheet,ProfitLoss, etc)
Rows	array	Optional
Rows[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item
UpdatedDateUTC	string	Optional	Updated Date Read only: true

Referenced models: Retrieves report for balancesheet — response body — Reports item Fields item, Retrieves report for balancesheet — response body — Reports item Rows item

Retrieves report for balancesheet — response body — Reports item Fields item

Field	Type	Presence	Description and constraints
$	object	Root
Description	string	Optional
FieldID	string	Optional
Value	string	Optional

Retrieves report for balancesheet — response body — Reports item Rows item

Field	Type	Presence	Description and constraints
$	object	Root
Cells	array	Optional
Cells[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item Cells item
RowType	string	Optional	Known values: Header, Section, Row, SummaryRow
Rows	array	Optional
Rows[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item Rows item
Title	string	Optional

Referenced models: Retrieves report for balancesheet — response body — Reports item Rows item Cells item, Retrieves report for balancesheet — response body — Reports item Rows item Rows item

Retrieves report for balancesheet — response body — Reports item Rows item Cells item

Field	Type	Presence	Description and constraints
$	object	Root
Attributes	array	Optional
Attributes[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item Cells item Attributes item
Value	string	Optional

Referenced models: Retrieves report for balancesheet — response body — Reports item Rows item Cells item Attributes item

Retrieves report for balancesheet — response body — Reports item Rows item Rows item

Field	Type	Presence	Description and constraints
$	object	Root
Cells	array	Optional
Cells[]	Model	Each item	Expand Retrieves report for balancesheet — response body — Reports item Rows item Cells item
RowType	string	Optional	Known values: Header, Section, Row, SummaryRow
Title	string	Optional

Referenced models: Retrieves report for balancesheet — response body — Reports item Rows item Cells item

Retrieves report for balancesheet — response body — Reports item Rows item Cells item Attributes item

Field	Type	Presence	Description and constraints
$	JSON	Root
Id	string	Optional
Value	string	Optional

Policy, approvals and errors

SDK function policy ID: xero.getreportbanksummary. Catalog operation: getReportBankSummary. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source