freee会計の取引データを取得する

このレシピについて

このレシピは、freee会計 APIリファレンス - 取引API を参考に記述されています。

freee会計の「取引データ」とは

freee会計では、法人や事業の「資産」や「負債」などの増減に関する動きを、用途（勘定科目など）や決済状況とともに「取引」として記録します。 （参考：「取引」について - freeeヘルプセンター）

freee 会計API を利用することで、指定した事業所に登録された取引データの一覧を取得できます。

freee会計の「取引データ」の構造

{
  "deals": [
    {
      "id": 101,
      "company_id": 1,
      "issue_date": "2019-12-17",
      "due_date": "2019-12-17",
      "amount": 5250,
      "due_amount": 0,
      "type": "expense",
      "partner_id": 201,
      "partner_code": "code001",
      "ref_number": "123-456",
      "status": "settled",
      "deal_origin_name": "手動",
      "details": [],
      "renews": [],
      "payments": [],
      "receipts": []
    }
  ],
  "meta": {
    "total_count": 100
  }
}

Anyflow Embedで取得する

Anyflow Embedでfreee会計の取引データを取得する手順を紹介します。

freee会計の取引データをスプレッドシートに一括追加するというシンプルなソリューションを作成し、取引先に含まれるデータを把握します。

1. Clickトリガーを設定する

Clickトリガーを設定します。

2. freee会計コネクタを設定する

freee会計コネクタを追加します。

3. 事業所の入力アシストを設定する

以下の通りエンドユーザー変数を作成します。

ウィザードの設定に移動します。 「事業所」のエンドユーザー変数の入力方法をアシストにし、事業所一覧を取得できるようにします。

4. freee会計のカスタムアクションを設定する

ソリューションエディタに戻り、freee会計コネクタを以下の通りに設定します。

設定項目名	設定値
カスタムアクション名	取引データを取得
HTTPメソッド	GET
リクエストパス	api/1/deals
リクエストヘッダー	※ 設定不要
リクエストタイプ	※ 設定不要
レスポンスヘッダー定義	※ 設定不要
レスポンスタイプ	json

「リクエストURLパラメータ」ではキーにcompany_idを、値にはエンドユーザー変数の「事業所」を設定します。

また、「レスポンスボディ定義」には以下の設定を行います。

{
  "deals": [
    {
      "id": 101,
      "issue_date": "2019-12-17",
      "amount": 5250,
      "type": "expense",
      "status": "settled"
    }
  ]
}

5. スプレッドシートの列名を設定する

スプレッドシートコネクタを追加し、以下の通りに設定を行います。

設定項目名	設定値
アクション	1行追加
スプレッドシートID	任意のスプレッドシートID
シートID	任意のシートID

「ヘッダーの列名」は以下の通りに設定します。

id
issue_date
amount
type
status

「行データ」にも同じ様に設定します。

6. スプレッドシートに一括追記する

スプレッドシートコネクタを追加し、以下の通りに設定を行います。

設定項目名	設定値
アクション	行を一括追加
スプレッドシートID	任意のスプレッドシートID
シートID	任意のシートID

「ヘッダーの列名」は以下の通りに設定します。

id
issue_date
amount
type
status

「リストソース」は以下の通りに設定します。

「要素フィールド」は以下の通りに設定します。（「i番目のdeal」から項目を選択します。）

7. ウィザードを設定する

必要な認証をウィザードに追加します。

8. テストを行う

テストを行うと、スプレッドシートにデータが追加されていることがわかります。