Xero RESTコネクタ

APIドキュメント

このコネクタが使用するエンティティ、where=フィルター、作成用のペイロードについては、XeroのAccounting APIリファレンスを参照してください。

認証の仕組み

この接続は、XeroのOAuth 2.0認可で認証します。PlaidCloudがOAuthアプリ自体を登録するため、クライアントIDやクライアントシークレットを取得して入力する必要はありません。Xeroに接続をクリックし、Xeroにサインインして、認可を承認するだけです。PlaidCloudは、取得したトークンを接続に保存して自動的に更新し、更新のたびに切り替わるリフレッシュトークンも保持するため、長期間使用していない接続でも引き続き機能します。

1つの認可で、承認したすべてのXero組織を対象にできます。ただし、1つの接続が対象にできる組織は1つだけです。組織ピッカーには認可で返された組織が一覧表示され、すべてのリクエストにその組織のテナントIDが付与されます。2つ目の組織に対して読み取りや転記を行うには、2つ目のXero接続を作成し、その接続で該当の組織を選択します。

XeroのDemo Companyは接続の設定ではなく、組織のプロパティです。デモ組織は他の組織と同様に組織の一覧に表示されるため、サンドボックス接続とは、その組織を指す接続のことです。

設定

フィールド	種類	説明
名前	テキスト	この接続の表示名です。
Xeroに接続	ボタン	Xeroのサインインと同意のフローを開始します。
接続ステータス	ステータス	認可が完了するまでは`Not connected`と表示され、完了後は、認可が対象とする組織の数を表示します。
組織	選択	この接続が読み取りと転記の対象とするXero組織です。認可の内容から一覧が作成されます。

レート制限

Xeroは、組織ごとに1分あたり60回、1日あたり5,000回の呼び出しに制限し、同時呼び出しは5回までです。PlaidCloudは1分あたりの制限と同時実行の制限を接続ごとに制御するため、ある組織が制限を受けても、別の接続の呼び出しが止まることはありません。また、制限を受けたレスポンスでは、XeroのRetry-Afterに従います。1日あたりの上限はお客様側で管理する必要があります。大量のデータの取得は、一度に多数を実行せず、スケジュールして実行してください。

インポートできるエンティティ

Xero: エンティティのインポートステップは、Accounting APIの11のエンティティ（accounts、contacts、invoices、credit_notes、payments、manual_journals、bank_transactions、items、tracking_categories、tax_rates、currencies）に対応しています。取得ごとに、ステータスによる絞り込み、日付範囲、更新日時による絞り込みを、任意で指定できます。フィールドの詳細は、Xero: エンティティのインポートを参照してください。

ドキュメントの転記

Xero: ドキュメントの転記ステップは、ヘッダーテーブルと明細テーブルから、手動仕訳、請求書、買掛請求書、支払、クレジットノートを、PlaidCloudの共通ERP書き込みパイプラインを通じて転記します。フィールドの詳細はXero: ドキュメントの転記を、転記の手順全体はXeroに接続するを参照してください。

既知の制限事項

制限事項	内容
結果が不明な場合、手動仕訳と支払は後から照会できない	請求書、買掛請求書、クレジットノートには、PlaidCloudが付与するドキュメント番号があり、それを使って照会できます。手動仕訳のナレーションと支払の参照は照会できないため、どちらかの書き込みで結果が不明になった場合は推測せず、隔離されます。Xeroで確認して解決してください。
取消の対象は手動仕訳と請求書のみ	手動仕訳は、借方と貸方を入れ替えた仕訳として取り消され、請求書は、元の請求書を打ち消すクレジットノートとして取り消されます。買掛請求書、支払、クレジットノートには、文書化された取消用のペイロードがないため、PlaidCloudは取消を独自に作成せず、拒否します。
フィルターは固定のフィールドであり、クエリ言語ではない	XeroのクエリAPIがエンティティごとに提供するのは、ステータスによる絞り込みと日付範囲のみで、自由なフィルター言語ではありません。そのため、インポートステップでは、フィールド／演算子／値のテーブルではなく、これらのフィールドを提供しています。
1つの接続につき組織は1つ	すべてのリクエストに、1つのテナントIDが付与されます。2つ目の組織には、2つ目の接続が必要です。