Xero · Schema

FeedConnection

AccountingBank FeedsFinanceFinancial-ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
id string GUID used to identify the Account.
accountToken string This account identifier is generated by the financial institute (FI). This must be unique for your financial institute.
accountNumber string String(40) when AccountType is BANK String(4) when AccountType is CREDITCARD The Account Number is used to match the feed to a Xero Bank Account. The API will create a new Xero Bank Account if a match
accountName string The Account Name will be used for the creation of a new Xero Bank Account if a matching Xero Bank Account is not found.
accountId string Xero identifier for a bank account in Xero. Must be included if AccountNumber is not specified.
accountType object High level bank account type - BANK CREDITCARD BANK encompasses all bank account types other than credit cards.
currency object
country object
status string the current status of the feed connection
error object
View JSON Schema on GitHub

JSON Schema

xero-feedconnection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FeedConnection",
  "title": "FeedConnection",
  "externalDocs": {
    "url": "https://developer.xero.com/documentation/bank-feeds-api/feed-connections"
  },
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "example": "0d3cf8d-95dc-4466-8dc0-47e6d1197e28",
      "description": "GUID used to identify the Account."
    },
    "accountToken": {
      "type": "string",
      "example": "10000123",
      "maximum": 50,
      "description": "This account identifier is generated by the financial institute (FI). This must be unique for your financial institute."
    },
    "accountNumber": {
      "type": "string",
      "example": "3809087654321500",
      "maximum": 40,
      "description": "String(40) when AccountType is BANK String(4) when AccountType is CREDITCARD The Account Number is used to match the feed to a Xero Bank Account. The API will create a new Xero Bank Account if a match to an existing Xero Bank Account is not found. Only the last 4 digits must be supplied for Credit Card numbers. Must be included if AccountId is not specified."
    },
    "accountName": {
      "type": "string",
      "example": "Joe's Savings Account",
      "maximum": 30,
      "description": "The Account Name will be used for the creation of a new Xero Bank Account if a matching Xero Bank Account is not found."
    },
    "accountId": {
      "type": "string",
      "format": "uuid",
      "example": "079a88ea-276d-41fb-a1f1-366ef3e22921",
      "description": "Xero identifier for a bank account in Xero. Must be included if AccountNumber is not specified."
    },
    "accountType": {
      "enum": [
        "BANK",
        "CREDITCARD"
      ],
      "example": "BANK",
      "description": "High level bank account type - BANK CREDITCARD BANK encompasses all bank account types other than credit cards."
    },
    "currency": {
      "$ref": "#/components/schemas/CurrencyCode"
    },
    "country": {
      "$ref": "#/components/schemas/CountryCode"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "REJECTED"
      ],
      "example": "REJECTED",
      "description": "the current status of the feed connection"
    },
    "error": {
      "$ref": "#/components/schemas/Error"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/xero-feedconnection"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.