QuickBooks Online Connector リファレンス

QuickBooks Online はコアビジネスプロセス、ERP 財務、E コマース、在庫などを組織で管理できるようにするクラウドベースの会計ソフトウェアを提供しています。

QuickBooks Online Connector では、 API マイナーバージョン 62 Leaving the Site を使用します。

Connections (接続)

システムに接続するには、それがデータの取得元であるかデータの取得先であるかに関係なく、そのシステムに必要なログイン情報を使用して接続を作成する必要があります。通常、フロー内の異なるシステムに接続し、接続が必要になるたびに各接続を再利用できます。

このシステムでは、接続のために次のログイン情報が必要です。

Connection Name (接続名): この接続の詳細を把握するのに役立つ接続名を入力します。 1 つのフローおよび複数のフローで接続を複数回再利用できます。接続の作成後、ログイン情報は非表示になります。そのため、この接続を他の接続と簡単に区別できる名前を付けると役立ちます。

接続は自分にのみ表示されます。コンポーザーアプリケーションの他のユーザーは、独自の接続を作成する必要があります。
Username (ユーザー名): QuickBooks Online にログインするために使用する OAuth ユーザー名。
Password (パスワード): QuickBooks Online にログインするために使用する OAuth パスワード。

トリガー

各フローは、スケジューラーまたはトリガーによって開始します。スケジューラーはデフォルトの頻度である 15 分に設定されます。トリガー (例:「each time a new record is created (新規レコードが作成されるたび)」) はユーザーが定義し、システム内のデータに関連する複数のオプションがあります。

トリガーは、ポーリングプロセスを使用して外部システムからの最新情報を能動的にチェックします。ポーリングの頻度は 15 秒に 1 回です。

このシステムでは、次のトリガーオプションが提供されます。

New Invoice: 新しい請求書が作成されたときにトリガーします。
New or Update Invoice (新規または更新済み請求書): 請求書が作成されたとき、または既存の請求書が更新されたときにトリガーします。
New Customer: 新しい顧客が作成されたときにトリガーします。
New or Updated Customer (新規または更新済み顧客): 顧客が作成されたとき、または既存の顧客が更新されたときにトリガーします。
New Item: 新しい項目が作成されたときにトリガーします。
New or Updated Item (新規または更新済み項目): 項目が作成されたとき、または既存の項目が更新されたときにトリガーします。
New Estimate (新規見積): 見積が作成されたときにトリガーします。
New or Updated Estimate (新規または更新済み見積): 見積が作成されたとき、または既存の見積が更新されたときにトリガーします。

Polling Frequency (ポーリング頻度)

このコネクタのトリガーでは、[Polling Frequency (ポーリング頻度)] 項目が必須です。この項目により、アクティブなフローのレコードの変更を検索するためにコンポーザーが基盤となるシステム API に対して要求を実行する頻度を選択できます。組織のフローごとに異なるポーリング頻度を選択できます。頻度が短くなると、フローの実行頻度は高くなりますが、より多くの『API コール』がコンシュームされます。たとえば、注文管理フローがある場合、15 秒のポーリング間隔 (5760 API コール/日) で達成できるほぼリアルタイムの更新が必要になる可能性があります。これに対して、フローで価格設定カタログを更新する場合、1 時間ごと (24 API コール/日) にフローをポーリングすれば済みます。

アクション

システムに接続してトリガーを定義するか、スケジューラーを設定した後に、フローが実行するアクション (Workday から Salesforce へのレコードのコピーなど) を定義します。実行できるアクションは、接続しているシステムによって異なります。

このシステムでは次のアクションが提供されます。

Create Invoice

新しい請求書を作成します。[Customer ID (顧客 ID)] の値を指定します。

Update Invoice

既存の請求書を更新します。[Invoice ID (請求書 ID)] の値を指定します。

Create Customer

新しい顧客を作成します。

Update Customer

既存の顧客を更新します。[Customer ID (顧客 ID)] の値を指定します。

Create Item

新しい項目を作成します。次の項目は必須です。

Name (名前)
Type (型)
[Track Quantity on Hand (手持ち数量を追跡)] の値が True の場合、次の項目は必須です。
- Asset Account Reference (アセットアカウント参照)
- Invoice Start Date (請求書開始日)
- Quantity on Hand (手持ち数量)

Update Item

既存の項目を更新します。次の項目は必須です。

Item ID (項目 ID)
[Track Quantity on Hand (手持ち数量を追跡)] の値が True の場合、次の項目は必須です。
- Asset Account Reference (アセットアカウント参照)
- Invoice Start Date (請求書開始日)
- Quantity on Hand (手持ち数量)

Query Invoice

既存の請求書を検索します。結果を返すには、次の 1 つ以上の項目に入力する必要があります。

Invoice ID Equals (請求書 ID が次に等しい)
Customer ID Equals (顧客 ID が次に等しい)
Due Date Greater Or Equal (期日が次以上)
Date Created Greater or Equal (作成日が次以上)
Last Updated Date Greater or Equal (最終更新日が次以上)

Query Customer

既存の顧客を検索します。結果を返すには、次の 1 つ以上の項目に入力する必要があります。

Customer ID Equals (顧客 ID が次に等しい)
Customer Display Name Equals (顧客表示名が次に等しい)
Customer Display Name Like (顧客表示名が次に似ている)
Active Equals (アクティブが次に等しい)
Primary Email Address Equals (プライマリメールアドレスが次に等しい)
Primary Email Address Like (プライマリメールアドレスが次に似ている)
Balance Greater Or Equal (残高が次以上)
Date Created Greater or Equal (作成日が次以上)
Last Updated Date Greater or Equal (最終更新日が次以上)

Query Item

既存の項目を検索します。結果を返すには、次の 1 つ以上の項目に入力する必要があります。

Item ID Equals (項目 ID が次に等しい)
Name Equals (名前が次に等しい)
Name Like (名前が次に似ている)
Active Equals (アクティブが次に等しい)
Type Equals (種別が次に等しい)
Date Created Greater or Equal (作成日が次以上)
Last Updated Date Greater or Equal (最終更新日が次以上)

Get Invoice

請求書を返します。[Customer ID (顧客 ID)] の値を指定します。

Get Customer

顧客を返します。 [Customer ID (顧客 ID)] の値を指定します。

Get Item

項目を返します。[Item ID (項目 ID)] の値を指定します。

Create Estimate (見積の作成)

見積レコードを作成します。次の項目の値を指定します。

Customer ID
Estimate Parameters (見積パラメーター)

Get Estimate (見積の取得)

見積を返します。[Estimate ID (見積 ID)] の値を指定します。

Update Estimate (見積の更新)

見積レコードを更新します。次の項目の値を指定します。

Estimate ID (見積 ID)
Estimate Parameters (見積パラメーター)

カスタム項目

MuleSoft Composer を使用して、Quickbooks Online レコードで設定したアクションとトリガーのカスタム項目値にアクセスできます。

QuickBooks Online API は、string 型で作成されている最初の 3 つのカスタム項目のみを返します。それ以降の string 型のカスタム項目と、他のデータ型 (date や picklist など) の項目は、コンポーザーでは書き込み可能な項目ではありません。詳細は、 Quickbooks Online のドキュメント Leaving the Site を参照してください。