基础URL

https://gateway.maton.ai/xero/{native-api-path}

将{native-api-path}替换为实际的Xero API端点路径。网关将请求代理到api.xero.com，并自动注入您的OAuth令牌和Xero-Tenant-Id标头。

认证

所有请求都需要在Authorization标头中提供Maton API密钥：

Authorization: Bearer $MATONAPIKEY

环境变量： 将您的API密钥设置为MATONAPIKEY：

bash
export MATONAPIKEY=YOURAPIKEY

获取您的API密钥

1. 1. 在maton.ai登录或创建账户
2. 前往maton.ai/settings
3. 复制您的API密钥

连接管理

在https://ctrl.maton.ai管理您的Xero OAuth连接。

列出连接

bash
python < import urllib.request, os, json
req = urllib.request.Request(https://ctrl.maton.ai/connections?app=xero&status=ACTIVE)
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

创建连接

bash
python < import urllib.request, os, json
data = json.dumps({app: xero}).encode()
req = urllib.request.Request(https://ctrl.maton.ai/connections, data=data, method=POST)
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
req.add_header(Content-Type, application/json)
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

获取连接

bash
python < import urllib.request, os, json
req = urllib.request.Request(https://ctrl.maton.ai/connections/{connection_id})
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

响应：
json
{
connection: {
connection_id: 21fd90f9-5935-43cd-b6c8-bde9d915ca80,
status: ACTIVE,
creation_time: 2025-12-08T07:20:53.488460Z,
lastupdatedtime: 2026-01-31T20:03:32.593153Z,
url: https://connect.maton.ai/?session_token=...,
app: xero,
metadata: {}
}
}

在浏览器中打开返回的url以完成OAuth授权。

删除连接

bash
python < import urllib.request, os, json
req = urllib.request.Request(https://ctrl.maton.ai/connections/{connection_id}, method=DELETE)
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

指定连接

如果您有多个Xero连接，请使用Maton-Connection标头指定要使用的连接：

bash
python < import urllib.request, os, json
req = urllib.request.Request(https://gateway.maton.ai/xero/api.xro/2.0/Contacts)
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
req.add_header(Maton-Connection, 21fd90f9-5935-43cd-b6c8-bde9d915ca80)
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

如果省略，网关将使用默认（最早）的活动连接。

API参考

联系人

列出联系人

bash
GET /xero/api.xro/2.0/Contacts

获取联系人

bash
GET /xero/api.xro/2.0/Contacts/{contactId}

创建联系人

bash
POST /xero/api.xro/2.0/Contacts
Content-Type: application/json

{
Contacts: [{
Name: John Doe,
EmailAddress: john@example.com,
Phones: [{PhoneType: DEFAULT, PhoneNumber: 555-1234}]
}]
}

发票

列出发票

bash
GET /xero/api.xro/2.0/Invoices

创建发票

bash
POST /xero/api.xro/2.0/Invoices
Content-Type: application/json

{
Invoices: [{
Type: ACCREC,
Contact: {ContactID: xxx},
LineItems: [{
Description: Service,
Quantity: 1,
UnitAmount: 100.00,
AccountCode: 200
}]
}]
}

账户

列出账户

bash
GET /xero/api.xro/2.0/Accounts

付款

列出付款

bash
GET /xero/api.xro/2.0/Payments

银行交易

列出银行交易

bash
GET /xero/api.xro/2.0/BankTransactions

报表

损益表

bash
GET /xero/api.xro/2.0/Reports/ProfitAndLoss?fromDate=2024-01-01&toDate=2024-12-31

资产负债表

bash
GET /xero/api.xro/2.0/Reports/BalanceSheet?date=2024-12-31

试算平衡表

bash
GET /xero/api.xro/2.0/Reports/TrialBalance?date=2024-12-31

组织

bash
GET /xero/api.xro/2.0/Organisation

发票类型

• - ACCREC - 应收账款（销售发票）
• ACCPAY - 应付账款（账单）

代码示例

JavaScript

javascript
const response = await fetch(
https://gateway.maton.ai/xero/api.xro/2.0/Contacts,
{
headers: {
Authorization: Bearer ${process.env.MATONAPIKEY}
}
}
);

Python

python
import os
import requests

response = requests.get(
https://gateway.maton.ai/xero/api.xro/2.0/Contacts,
headers={Authorization: fBearer {os.environ[MATONAPIKEY]}}
)

注意事项

• - Xero-Tenant-Id标头会自动注入
• 日期格式为YYYY-MM-DD
• 可以使用数组在单个请求中创建多条记录
• 使用where查询参数进行过滤
• 重要提示：使用curl命令时，如果URL包含括号（fields[]、sort[]、records[]），请使用curl -g禁用通配符解析
• 重要提示：将curl输出通过管道传递给jq或其他命令时，环境变量（如$MATONAPIKEY）在某些shell环境中可能无法正确展开。在管道传递时可能会收到Invalid API key错误。

错误处理

故障排除：API密钥问题

1. 1. 检查是否设置了MATONAPIKEY环境变量：

bash
echo $MATONAPIKEY

1. 2. 通过列出连接验证API密钥是否有效：

bash
python < import urllib.request, os, json
req = urllib.request.Request(https://ctrl.maton.ai/connections)
req.addheader(Authorization, fBearer {os.environ[MATONAPI_KEY]})
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2