v51

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

BankFeeds

Retrieve single statement based on unique id provided

By passing in a statement id, you can search for matching statements

get/Statements/{statementId}

Path parameters

statementIdstring uuid required

statement id for single object

Response

search results matching id for single statement

idstring uuid

GUID used to identify the Statement.

feedConnectionIdstring uuid

The Xero generated feed connection Id that identifies the Xero Bank Account Container into which the statement should be delivered. This is obtained by calling GET FeedConnections.

status'PENDING' | 'REJECTED' | 'DELIVERED'

Current status of statements

startDatestring date

Opening balance date (can be no older than one year from the current date) ISO-8601 YYYY-MM-DD

endDatestring date

Closing balance date ISO-8601 YYYY-MM-DD

statementLineCountinteger

Example response

{
  "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
}