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

freee会計から取引先データを取得する方法について

このレシピについて

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

freee会計では、取引先の情報をマスタとして登録することで、取引の際に入力する摘要の管理を効率化できます。 (参考:取引先を登録する - freeeヘルプセンター

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

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

{
  "partners": [
    {
      "id": 1,
      "code": "code001",
      "company_id": 1,
      "name": "ABC商店",
      "update_date": "2019-12-17",
      "available": true,
      "shortcut1": "ABC",
      "shortcut2": "501",
      "org_code": 1,
      "country_code": "JP",
      "long_name": "新しい取引先正式名称",
      "name_kana": "アタラシイトリヒキサキメイショウ",
      "default_title": "御中",
      "phone": "03-1234-xxxx",
      "contact_name": "営業担当",
      "email": "[email protected]",
      "payer_walletable_id": 1,
      "transfer_fee_handling_side": "payer",
      "qualified_invoice_issuer": false,
      "invoice_registration_number": "T1000000000001",
      "address_attributes": {
        "zipcode": "000-0000",
        "prefecture_code": 4,
        "street_name1": "XX区YY1−1−1",
        "street_name2": "ビル1F"
      },
      "partner_doc_setting_attributes": {
        "sending_method": "posting"
      },
      "partner_bank_account_attributes": {
        "bank_name": "freee銀行",
        "bank_name_kana": "フリーギンコウ",
        "bank_code": "0001",
        "branch_name": "銀座支店",
        "branch_kana": "ギンザシテン",
        "branch_code": "999",
        "account_type": "ordinary",
        "account_number": "1010101",
        "account_name": "フリータロウ",
        "long_account_name": "freee太郎"
      }
    }
  ]
}

Anyflow Embedで取得する

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

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

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

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

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

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

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

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

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

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

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

設定項目名
設定値

カスタムアクション名

取引先データを取得

HTTPメソッド

GET

リクエストパス

api/1/partners

リクエストヘッダー

※ 設定不要

リクエストタイプ

※ 設定不要

レスポンスヘッダー定義

※ 設定不要

レスポンスタイプ

json

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

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

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

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

設定項目名
設定値

アクション

1行追加

スプレッドシートID

任意のスプレッドシートID

シートID

任意のシートID

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

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

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

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

設定項目名
設定値

アクション

行を一括追加

スプレッドシートID

任意のスプレッドシートID

シートID

任意のシートID

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

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

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

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

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

8. テストを行う

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

最終更新