Xero + icon

Xero +

Consume Xero API

Bank Transaction → Get Many

AI-generated

Summary

Retrieve multiple bank transactions from a specified Xero organization, optionally filtered, sorted, and paginated according to user-supplied parameters.

Inputs

  • Organization Name or ID (required) — Select the Xero organization from which to retrieve bank transactions.
  • Custom Where Clause — A string to filter bank transactions using an advanced custom filter expression.
  • If-Modified-Since — Only return bank transactions created or updated since this date/time.
  • Order By — Field to order the results by (Date, Reference, Total, Type, or Updated Date). Defaults to Date.
  • Sort Order — Sort direction, ascending (ASC) or descending (DESC). Defaults to DESC.
  • Page — Page number to retrieve in paginated results, starting at 1. Defaults to 1.
  • Page Size — Number of transactions to return per page (maximum 1000). Defaults to 100.
  • Statuses — Filter transactions by status such as Authorised or Deleted.
  • Types — Filter transactions by type, including receive or spend money variants.
  • Where Filters — Structured filters to specify criteria on fields like Bank Account Code, Contact, Date Range, Reconciliation Status, Reference, Status, Total Range, or Type.

Output shape

a list of bank transaction records matching the specified filters

Results are paginated and can be controlled via 'Page' and 'Page Size' inputs. To retrieve associated line items, these pagination parameters must be set explicitly. Filters can be combined using either the custom where clause or structured filters, but care should be taken to construct valid expressions. Returned data includes bank transactions created or modified based on input criteria.

Examples

Example 1: Fetch all authorised spend money transactions updated since January 1, 2023

Set 'Organization Name or ID' to desired organization, 'Types' filter to 'Spend Money', 'Statuses' to 'Authorised', and 'If-Modified-Since' to 2023-01-01T00:00:00Z, optionally set pagination to control number of results per request.

Links

Discussion