Xero | Operate As Docs

Website: xero.com
Connects by: Signing in with Xero
Category: Accounting
Services: 1
Tools: 213

Service	Key	Base URL
Xero	`xero`	`https://api.xero.com/api.xro/2.0`

Connecting

Your client presses Connect on their link and approves on Xero's own screen. Operate As never sees their password.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "xero"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "xero"    ]  }]

Permissions

What the client reads	Permission it asks for
See and change invoices, bills and payments	`accounting.transactions`
See and change your contacts	`accounting.contacts`
See your chart of accounts and settings	`accounting.settings.read`

Tools

Install Xero's typed package for your language:

pip install operate-as-xero

pip install operate-as-xero

Run xero.create_account

curl -X POST https://api.operate.as/v1/actions/xero.create_account \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {}
  }'

curl -X POST https://api.operate.as/v1/actions/xero.create_account \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {}  }'

Every input, with its JSON Schema: GET /v1/actions/xero.create_account

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

Pass-through

Paths continue from https://api.xero.com/api.xro/2.0. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../xero/..." \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../xero/..." \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

Operate As renews the sign-in before it runs out and checks it daily. If Xero refuses to renew it, the service shows Expired, you're alerted, and your client reconnects from the same link.

See Keeping access alive and Removing access.

Calls answer

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "detail": "Miller Dental's Xero access ended. Send them their link to reconnect."
}

HTTP/1.1 409 ConflictContent-Type: application/json{  "detail": "Miller Dental's Xero access ended. Send them their link to reconnect."}

Your webhook receives

{
  "id": "evt_3f9a1c…",
  "type": "connection.expired",
  "createdAt": "2026-10-16T08:00:00+00:00",
  "data": {
    "clientId": "6f1c2a7e-...",
    "clientName": "Miller Dental",
    "provider": "xero",
    "services": [
      "xero"
    ],
    "reconnectUrl": "https://…"
  }
}

{  "id": "evt_3f9a1c…",  "type": "connection.expired",  "createdAt": "2026-10-16T08:00:00+00:00",  "data": {    "clientId": "6f1c2a7e-...",    "clientName": "Miller Dental",    "provider": "xero",    "services": [      "xero"    ],    "reconnectUrl": "https://…"  }}