帳票が発行された時(トリガー)
このピースでできること楽楽明細 の接続方法ステップ 1:API トークンとベース URL を取得するステップ 2:workrun に接続を追加するピースの設定項目1. 帳票種別ID(任意)2. Web利用ステータス(任意)取得できる情報出力例(抜粋)
このピースでできること
- 楽楽明細の帳票一覧から、帳票の「作成日時」が前回の確認時刻より新しい帳票を検出したときにフローを実行します。実装では発行日ではなく作成日時を基準に判定するため、過去に作成された帳票を後日発行した場合は検出されないことがあります。
- 5分ごとに新規帳票を確認し、未検出の帳票があればトリガーします。
- 帳票種別やWeb利用ステータスで絞り込んで検出する帳票を絞り込むこともできます。
楽楽明細 の接続方法
workrun と楽楽明細を接続するには、楽楽明細の API トークン と ベース URL が必要です。
ステップ 1:API トークンとベース URL を取得する
- 楽楽明細にログインし、管理画面 > 基本設定 > API設定 を開きます。
- 新たに API キーを発行する場合は「新規作成」、発行済みの API キーを使う場合は対象の「詳細」を開きます。
- 表示された「API トークン」をコピーします。
- 楽楽明細から通知された送信先 URL( より前までの部分)を確認しておきます。
- 例:
ステップ 2:workrun に接続を追加する
- workrun で楽楽明細のアクションをフローに追加します。
- 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
- 「ベース URL」 フィールドに、ステップ 1 で確認した送信先 URL(例: )を入力します。
- 「API トークン」 フィールドに、ステップ 1 でコピーした API トークンを貼り付けます。
- 「保存」 をクリックして接続を完了します。
ピースの設定項目
1. 帳票種別ID(任意)
検出する帳票を特定の帳票種別に絞り込む場合に指定します。複数指定できます。未指定の場合は全ての種別が対象になります。
管理画面 > 基本設定 > 帳票設定 を開き、対象帳票の「詳細」ボタンを押すと、URL に のような形で確認できます。
2. Web利用ステータス(任意)
顧客のWeb利用ステータスで絞り込みます。複数選択できます。未指定の場合は全てのステータスが対象になります。
- 停止: 0
- 利用中: 1
- 開設待ち: 2
取得できる情報
楽楽明細の帳票情報取得APIから、条件を満たした帳票を1件ずつ出力します。返却項目は楽楽明細側のCSV出力設定などによって異なります。
| 主なキー | 内容・条件 |
|---|---|
| 検出の判定に使用。形式はで、日本時間として解釈します。未設定・形式不正の場合、その帳票は出力しません | |
| / / | 顧客や帳票の識別情報。設定によって含まれます |
| / | 発行日や公開状況。これらの値を新旧判定の時刻としては使用していません |
| / / / | 金額や支払期日。金額が記号・桁区切りを含む文字列の場合があります |
| / | 備考や明細。実際の形式は返却内容に依存します |
- API応答のに含まれる帳票情報を返します。帳票種別IDとWeb利用ステータスによる絞り込みができます。
- 判定基準は発行日ではなく作成日時です。すでに作成した帳票を後から発行しても、作成日時が前回確認時刻以前なら出力対象になりません。
- 取得は一覧の先頭ページが対象で、1回あたり最大300件です。大量の帳票をすべて検出できるとは限りません。
出力例(抜粋)
架空例です。項目名や値は連携先の出力設定によって異なります。