v51

latestOpenAPI 3.0.0MITraw.githubusercontent.com2026-07-2171334.6 KB
BankFeeds

Retrieve all statements

By passing in parameters, you can search for matching statements

get/Statements

Query parameters

pageinteger

unique id for single object

pageSizeinteger

Page size which specifies how many records per page will be returned (default 10). Example - https://api.xero.com/bankfeeds.xro/1.0/Statements?pageSize=100 to specify page size of 100.

Headers

Xero-Application-Idstring
Xero-User-Idstring

Response

success returns Statements array of objects response

Example response

{
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "pageCount": 1,
    "itemCount": 2
  },
  "items": [
    {
      "id": "ba4f3127-5e46-427d-80ea-dea2fcd26afe",
      "feedConnectionId": "87cb0dc8-fa32-409c-b622-19f8de8dcc83",
      "status": "PENDING",
      "startDate": "2018-07-27",
      "endDate": "2018-07-27",
      "statementLines": [
        {
          "postedDate": "2018-06-10",
          "description": "Description for statement line 2",
          "transactionId": "transaction-id-2",
          "payeeName": "Payee name for statement line 2",
          "reference": "Reference for statement line 2",
          "chequeNumber": "021",
          "transactionType": "Refund"
        }
      ],
      "errors": [
        {
          "title": "Invalid Application",
          "status": 403,
          "detail": "The application has not been configured to use these API endpoints.",
          "type": "invalid-application"
        }
      ],
      "statementLineCount": 1
    }
  ]
}